Spring Boot之WebSocket

一、項目說明

1、項目地址：https://github.com/hqzmss/test01-springboot-websocket.git

2、IDE：IntelliJ IDEA 2018.1.1 x64

二、步驟說明

Spring Boot實現WebSocket比較簡單，主要分以下四步：

1、添加依賴

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

其他的依賴只涉及到Spring Boot本身的依賴

2、創建攔截器

攔截器要實現【HandshakeInterceptor】這個接口，並實現它的兩個方法。

攔截器的主要作用是在WebSocket創建握手之前和之后進行一些相應的處理

package com.hqzmss.websocket_demo1;

import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.server.HandshakeInterceptor;

import java.util.Map;

/**
 * 攔截器
 */
public class MyWebSocketInterceptor implements HandshakeInterceptor {

    /**
     * 握手之前調用
     * @param serverHttpRequest 當前請求
     * @param serverHttpResponse 當前響應
     * @param webSocketHandler 目標處理器
     * @param map 請求屬性
     * @return 是否通過
     * @throws Exception 異常信息
     */
    @Override
    public boolean beforeHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Map<String, Object> map) throws Exception {
        System.out.println("連接前進行處理");
        return true;
    }

    /**
     * 握手之后調用
     * @param serverHttpRequest 當前請求
     * @param serverHttpResponse 當前響應
     * @param webSocketHandler 目標處理器
     * @param e 握手期間引發的異常，如果沒有，則為null
     */
    @Override
    public void afterHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Exception e) {
        System.out.println("連接后進行處理");
    }
}
 

3、創建處理器

處理器是所有消息的處理中心。

【afterConnectionEstablished】：這個方法會為每個WebSocket連接創建一個WebSocketSession，標識一個連接。

　　　　　　　　　　　　　　可以將這個WebSocketSession保存起來，以后要是服務器有消息要發送到這個客戶端，則通過WebSocketSession直接發送

【handleMessage】：從客戶端發來的消息由此方法接收並做相應處理。消息由WebSocketMessage來接收。

package com.hqzmss.websocket_demo1;

import org.springframework.web.socket.*;

/**
 * 創建處理器
 */
public class MyHandler implements WebSocketHandler  {
    /**
     * 在WebSocket協商成功后調用，並且打開WebSocket連接准備使用
     * @param webSocketSession webSocketSession
     * @throws Exception 異常
     */
    @Override
    public void afterConnectionEstablished(WebSocketSession webSocketSession) throws Exception {
        System.out.println("sessionId=" + webSocketSession.getId());
    }

    /**
     * 當一個新的WebSocket消息到達時調用
     * @param webSocketSession webSocketSession
     * @param webSocketMessage webSocketMessage
     * @throws Exception 異常
     */
    @Override
    public void handleMessage(WebSocketSession webSocketSession, WebSocketMessage<?> webSocketMessage) throws Exception {
        System.out.println(webSocketMessage.getPayload());
        System.out.println("有消息到達服務器！");
    }

    /**
     * 處理來自底層WebSocket消息傳輸的錯誤
     * @param webSocketSession webSocketSession
     * @param throwable 錯誤
     * @throws Exception 異常
     */
    @Override
    public void handleTransportError(WebSocketSession webSocketSession, Throwable throwable) throws Exception {

    }

    /**
     * 在網絡套接字連接關閉后或在傳輸錯誤發生后調用。
     * 盡管從技術上講，會話可能仍然是開放的，但取決於底層實現，在這一點上發送消息是不鼓勵的，而且很可能不會成功。
     * @param webSocketSession webSocketSession
     * @param closeStatus closeStatus
     * @throws Exception 異常
     */
    @Override
    public void afterConnectionClosed(WebSocketSession webSocketSession, CloseStatus closeStatus) throws Exception {
        if(webSocketSession.isOpen()) {
            webSocketSession.close();
        }
        System.out.println("安全退出了系統");
    }

    /**
     * WebSocketHandler是否處理部分消息
     * @return 標志
     */
    @Override
    public boolean supportsPartialMessages() {
        return false;
    }
}

4、添加配置項目

 1）、要記得添加@EnableWebSocket注解，標識這個配置是WebSocket配置

 2）、"/webSocketServer.action"是自定義的連接點，客戶端要通過WebSocket連接此服務器則是通過此連接點

 3）、.setAllowedOrigins("*")，這個方法要加上，不加的話有可能連接會被攔截掉

package com.hqzmss.websocket_demo1;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.config.annotation.*;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements  WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) {
        webSocketHandlerRegistry.addHandler(webSocketHandler(), "/webSocketServer.action").addInterceptors(new MyWebSocketInterceptor()).setAllowedOrigins("*");
        webSocketHandlerRegistry.addHandler(webSocketHandler(), "/sockjs/webSocketServer.action")
                .addInterceptors(new MyWebSocketInterceptor()).withSockJS();
    }

    @Bean
    public WebSocketHandler webSocketHandler() {
        return new MyHandler();
    }
}