SpringBoot 快速實現WebSocket

CatalpaFlat發表於2017-10-25
Spring BootWeb

1.新增Maven依賴

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
    <version>1.3.5.RELEASE</version>
</dependency>複製程式碼

2.webSocket配置


/**
 * webSocket配置
 * @author 陳梓平
 * @date 2017/10/25.
 */
@Configuration
public class WebSocketConfig {
    /**
     * 注入ServerEndpointExporter，
     * 這個bean會自動註冊使用了@ServerEndpoint註解宣告的Websocket endpoint
     * @return
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}
複製程式碼

3.自定義websocket

/**
 * 自定義websocket
 * @author 陳梓平
 * @date 2017/10/25.
 */
@ServerEndpoint(value = "/websocket")
@Component
public class CustomWebSocket {
    /**靜態變數，用來記錄當前線上連線數。應該把它設計成執行緒安全的。*/
    private static int onlineCount = 0;
    /**concurrent包的執行緒安全Set，用來存放每個客戶端對應的CumWebSocket物件。*/
    private static CopyOnWriteArraySet<CustomWebSocket> webSocketSet = new CopyOnWriteArraySet<CustomWebSocket>();
    /**與某個客戶端的連線會話，需要通過它來給客戶端傳送資料*/
    private Session session;

    private static final Logger log = LoggerFactory.getLogger(CustomWebSocket.class);
    /**
     * 連線建立成功呼叫的方法
     * @param session
     */
    @OnOpen
    public void onOpen(Session session) {
        this.session = session;
        //加入set中
        webSocketSet.add(this);
        //新增線上人數
        addOnlineCount();
        log.info("新連線接入。當前線上人數為："+getOnlineCount());
        try {
            sendMessage("假裝有內容");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 連線關閉呼叫的方法
     */
    @OnClose
    public void onClose() {
        //從set中刪除
        webSocketSet.remove(this);
        //線上數減1
        subOnlineCount();
        log.info("有連線關閉。當前線上人數為："+getOnlineCount());
    }

    /**
     * 收到客戶端訊息後呼叫
     * @param message
     * @param session
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("客戶端傳送的訊息："+message);
        sendAll(message);
    }

    /**
     * 暴露給外部的群發
     * @param message
     * @throws IOException
     */
    public static void sendInfo(String message) throws IOException {
        sendAll(message);
    }

    /**
     * 群發
     * @param message
     */
    private static void sendAll(String message) {
        Arrays.asList(webSocketSet.toArray()).forEach(item -> {
            CustomWebSocket customWebSocket = (CustomWebSocket) item;
            //群發
            try {
                customWebSocket.sendMessage(message);
            } catch (IOException e) {
                e.printStackTrace();
            }
        });
    }

    /**
     * 發生錯誤時呼叫
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.info("有異常啦");
        error.printStackTrace();
    }

    /**
     * 減少線上人數
     */
    private void subOnlineCount() {
        CustomWebSocket.onlineCount--;
    }

    /**
     * 新增線上人數
     */
    private void addOnlineCount() {
        CustomWebSocket.onlineCount++;
    }

    /**
     * 當前線上人數
     * @return
     */
    public static synchronized int getOnlineCount() {
        return onlineCount;
    }

    /**
     * 傳送資訊
     * @param message
     * @throws IOException
     */
    public void sendMessage(String message) throws IOException {
        //獲取session遠端基本連線傳送文字訊息
        this.session.getBasicRemote().sendText(message);
        //this.session.getAsyncRemote().sendText(message);
    }
}複製程式碼

4.前端頁面

<!DOCTYPE HTML>
<html>
<head>
    <title>WebSocket</title>
</head>

<body>
Welcome<br/>
<input id="text" type="text" /><button onclick="send()">Send</button>    <button onclick="closeWebSocket()">Close</button>
<div id="message">
</div>
</body>

<script type="text/javascript">
    var websocket = null;

    //判斷當前瀏覽器是否支援WebSocket
    if('WebSocket' in window){
        websocket = new WebSocket("ws://localhost:8080/websocket");
    }
    else{
        alert('Not support websocket')
    }

    //連線發生錯誤的回撥方法
    websocket.onerror = function(){
        setMessageInnerHTML("error");
    };

    //連線成功建立的回撥方法
    websocket.onopen = function(event){
        setMessageInnerHTML("open");
    }

    //接收到訊息的回撥方法
    websocket.onmessage = function(event){
        setMessageInnerHTML(event.data);
    }

    //連線關閉的回撥方法
    websocket.onclose = function(){
        setMessageInnerHTML("close");
    }

    //監聽視窗關閉事件，當視窗關閉時，主動去關閉websocket連線，防止連線還沒斷開就關閉視窗，server端會拋異常。
    window.onbeforeunload = function(){
        websocket.close();
    }

    //將訊息顯示在網頁上
    function setMessageInnerHTML(innerHTML){
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //關閉連線
    function closeWebSocket(){
        websocket.close();
    }

    //傳送訊息
    function send(){
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
</script>
</html>複製程式碼

5.測試

相關文章