快捷導(dǎo)航

java中Websocket的使用方法例子

更新時(shí)間：2023年11月28日 10:28:08 作者：煙雨**魚兒

這篇文章主要給大家介紹了關(guān)于java中Websocket的使用方法,WebSocket是HTML5開始提供的一種在瀏覽器和服務(wù)器間進(jìn)行全雙工通信的協(xié)議,文中通過(guò)代碼介紹的非常詳細(xì),需要的朋友可以參考下

什么試WebSocket

WebSocket是一個(gè)連接，這個(gè)連接是客戶端（頁(yè)面）與服務(wù)端之間的連接，處理兩者間通訊；

好處：HTML5定義了WebSocket協(xié)議，能更好的節(jié)省服務(wù)器資源和帶寬，并且能夠更實(shí)時(shí)地進(jìn)行通訊,不需要每次發(fā)送請(qǐng)求接口獲取數(shù)據(jù)，
使用場(chǎng)景：比如客戶端登錄后，出現(xiàn)的消息推送，每天定時(shí)廣播推送給客戶端消息等場(chǎng)景；

SpringBoot maven項(xiàng)目中實(shí)現(xiàn)

導(dǎo)入依賴：

		<dependency>
		   <groupId>org.springframework.boot</groupId>
		   <artifactId>spring-boot-starter-websocket</artifactId>
		</dependency>

客戶端和服務(wù)端怎么鏈接呢？前端實(shí)現(xiàn)也是固定的寫法，只需要請(qǐng)求/websocket/{userId} 這個(gè)地址即可實(shí)現(xiàn)鏈接

前端js代碼：

//判斷當(dāng)前瀏覽器是否支持WebSocket  
if ('WebSocket' in window) {  
    websocket = new WebSocket("ws://" + document.location.host + "/WebChat/websocket/" + username + "/"+ _img);  
} else {  
    alert('當(dāng)前瀏覽器 Not support websocket')  
}

java 實(shí)現(xiàn)websocket連接的代碼:

package org.jeecg.modules.message.websocket;

import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.jeecg.common.constant.WebsocketConst;
import org.springframework.stereotype.Component;

import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.CopyOnWriteArraySet;

/**
 * @Author wsf
 * @Date 2023/04/29 9:41
 * @Description: 此注解相當(dāng)于設(shè)置訪問(wèn)URL
 */
@Component
@Slf4j
@ServerEndpoint("/websocket/{userId}") //此注解相當(dāng)于設(shè)置訪問(wèn)URL
public class WebSocket {

    private Session session;

    private static final CopyOnWriteArraySet<WebSocket> webSockets = new CopyOnWriteArraySet<>();
    /*
    websocket是客戶端和服務(wù)端之間建立了一個(gè)連接，建立完連接以后，會(huì)生成一個(gè)websocket對(duì)象，我們可以用這個(gè)對(duì)象來(lái)執(zhí)行發(fā)送，接收等操作。但是這只是一個(gè)存在于客戶端與服務(wù)器之間的鏈接，換句話說(shuō)，系統(tǒng)只能識(shí)別到這個(gè)websocket連接是對(duì)應(yīng)于哪個(gè)頁(yè)面（瀏覽器），而這個(gè)頁(yè)面在系統(tǒng)中是對(duì)應(yīng)哪個(gè)用戶（數(shù)據(jù)庫(kù)中的用戶，或者根本就沒有對(duì)應(yīng)任何用戶，即未登錄，只是一個(gè)游客），我們是無(wú)法從這個(gè)websocket對(duì)象中獲取的。所以我們需要?jiǎng)?chuàng)建一個(gè)Map對(duì)象，用于將websocket對(duì)象和實(shí)際的user對(duì)象進(jìn)行關(guān)聯(lián)，這樣為我們后續(xù)向特定的用戶推送消息做鋪墊
    */
    private static final Map<String, Session> sessionPool = new HashMap<>();

    @OnOpen
    public void onOpen(Session session, @PathParam(value = "userId") String userId) {
        try {
            this.session = session;
            webSockets.add(this);
            sessionPool.put(userId, session);
            log.info("【websocket消息】有新的連接，總數(shù)為: {}", webSockets.size());
        } catch (Exception e) {
        }
    }

    @OnClose
    public void onClose(@PathParam(value = "userId") String userId) {
        try {
            webSockets.remove(this);
            sessionPool.remove(userId);
            log.info("【websocket消息】連接斷開，總數(shù)為: {}", webSockets.size());
        } catch (Exception e) {
        }
    }

    @OnMessage
    public void onMessage(String message) {
        log.debug("【websocket消息】收到客戶端消息: {}", message);
        JSONObject obj = new JSONObject();
        obj.put(WebsocketConst.MSG_CMD, WebsocketConst.CMD_CHECK);//業(yè)務(wù)類型
        obj.put(WebsocketConst.MSG_TXT, "心跳響應(yīng)");//消息內(nèi)容
        session.getAsyncRemote().sendText(obj.toJSONString());
    }


    @OnError
    public void OnError(Session session, @PathParam(value = "userId") String userId, Throwable t) {
        try {
            if (session.isOpen()) {
                session.close();
            }
            webSockets.remove(this);
            sessionPool.remove(userId);
            log.info("【websocket消息】連接[錯(cuò)誤]斷開，總數(shù)為: {}, 錯(cuò)誤：{}", webSockets.size(), t.getMessage());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    // 此為廣播消息
    public void sendAllMessage(String message) {
        log.info("【websocket消息】廣播消息:" + message);
        for (WebSocket webSocket : webSockets) {
            try {
                if (webSocket.session.isOpen()) {
                    webSocket.session.getAsyncRemote().sendText(message);
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

    // 此為單點(diǎn)消息
    public void sendOneMessage(String userId, String message) {
        Session session = sessionPool.get(userId);
        if (session != null && session.isOpen()) {
            try {
                log.info("【websocket消息】 單點(diǎn)消息:" + message);
                session.getAsyncRemote().sendText(message);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

    // 此為單點(diǎn)消息(多人)
    public void sendMoreMessage(String[] userIds, String message) {
        for (String userId : userIds) {
            Session session = sessionPool.get(userId);
            if (session != null && session.isOpen()) {
                try {
                    log.info("【websocket消息】 單點(diǎn)消息:" + message);
                    session.getAsyncRemote().sendText(message);
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }

    }
}

在RunApplication中加入：

package org.jeecg.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration
public class WebSocketConfig {
      /**
     * 會(huì)自動(dòng)注冊(cè)使用了@ServerEndpoint注解聲明的Websocket endpoint
     * 要注意，如果使用獨(dú)立的servlet容器，
     * 而不是直接使用springboot的內(nèi)置容器，
     * 就不要注入ServerEndpointExporter，因?yàn)樗鼘⒂扇萜髯约禾峁┖凸芾怼?
     *  注入ServerEndpointExporter，
     * 	這個(gè)bean會(huì)自動(dòng)注冊(cè)使用了@ServerEndpoint注解聲明的Websocket endpoint
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
      return new ServerEndpointExporter();
    }
}

可以編寫一個(gè)test 測(cè)試連接

public class WebSocketTest {

    public static void main(String[] args) {
        try {

            // 創(chuàng)建WebSocket客戶端
            MyWebSocketClient myClient = new MyWebSocketClient(new URI("ws://127.0.0.1:9091/web/websocket/123333"));
            // 與服務(wù)端建立連接
            myClient.connect();
            while (!myClient.getReadyState().equals(ReadyState.OPEN)) {
                System.out.println("連接中。。。");
                Thread.sleep(1000);
            }
            // 往websocket服務(wù)端發(fā)送數(shù)據(jù)
            myClient.send("發(fā)送來(lái)自websocketClient 123333的消息");
            Thread.sleep(1000);
            // 關(guān)閉與服務(wù)端的連接
            // myClient.close();
        }catch (Exception e){
            e.printStackTrace();
        }
        // write your code here

    }
}

實(shí)際開發(fā)使用：

package org.jeecg.modules.food.job;

import com.alibaba.fastjson.JSONObject;
import org.apache.commons.collections.CollectionUtils;
import org.jeecg.common.constant.WebsocketConst;
import org.jeecg.modules.food.entity.DailyMenu;
import org.jeecg.modules.food.mapper.DailyMenuMapper;
import org.jeecg.modules.message.websocket.WebSocket;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.util.Calendar;
import java.util.Date;
import java.util.List;

/**
 * @Auther: wsf
 * @Date: 2023/5/30 15:52
 * @Description:定時(shí)每天10、14點(diǎn)定時(shí)推送訂餐消息
 */
@Component
public class DailyMenuTask {

    @Resource
    private WebSocket webSocket;

    @Autowired
    private DailyMenuMapper dailyMenuMapper;

    @Scheduled(cron = "0 0 10,14 * * ?")
    public void pushDailyMenu() {
        DailyMenu dailyMenu = new DailyMenu();
        Calendar cal = Calendar.getInstance();
        cal.setTime(new Date());
        cal.add(Calendar.DATE, 1);
        Date time = cal.getTime();
        dailyMenu.setFoodDate(time);
        List<DailyMenu> dailyMenus = dailyMenuMapper.selectByDate(dailyMenu);
        if (CollectionUtils.isNotEmpty(dailyMenus)) {
            //創(chuàng)建業(yè)務(wù)消息信息
            JSONObject obj = new JSONObject();
            // 業(yè)務(wù)類型
            obj.put(WebsocketConst.MSG_CMD, WebsocketConst.CMD_TOPIC);
            obj.put(WebsocketConst.MSG_ID, dailyMenus.get(0).getId());
            obj.put(WebsocketConst.MSG_TXT, "訂餐發(fā)布");
            //全體發(fā)送
            webSocket.sendAllMessage(obj.toJSONString());
        }
    }
}

java 實(shí)現(xiàn)websocket的方式有很多種

java 實(shí)現(xiàn)websocket一般兩種方式，一種使用tomcat的websocket實(shí)現(xiàn)，比如上述使用這種方式無(wú)需別的任何配置，只需服務(wù)端一個(gè)處理類；
使用spring的websocket，spring與websocket整合需要spring 4.x，并且使用了socketjs，對(duì)不支持websocket的瀏覽器可以模擬websocket使用。實(shí)現(xiàn)WebSocketConfigurer接口的registerWebSocketHandlers方法加入自己WebSocketHandler接口的實(shí)現(xiàn)類。
使用spring stomp封裝的方法，實(shí)現(xiàn)更簡(jiǎn)單，配置注入后通過(guò)@sendto就可向客戶端發(fā)消息。
等等