你知道在springboot中如何使用WebSocket嗎

煩囂的人發表於2019-05-23
Spring BootWeb

一、背景

  我們都知道 http 協議只能瀏覽器單方面向伺服器發起請求獲得響應，伺服器不能主動向瀏覽器推送訊息。想要實現瀏覽器的主動推送有兩種主流實現方式：

  • 輪詢：缺點很多，但是實現簡單
  • websocket：在瀏覽器和伺服器之間建立 tcp 連線，實現全雙工通訊

  springboot 使用 websocket 有兩種方式，一種是實現簡單的 websocket，另外一種是實現STOMP協議。這一篇實現簡單的 websocket，STOMP 下一篇在講。

注意：如下都是針對使用 springboot 內建容器

二、實現

1、依賴引入

  要使用 websocket 關鍵是@ServerEndpoint這個註解，該註解是 javaee 標準中的註解,tomcat7 及以上已經實現了,如果使用傳統方法將 war 包部署到 tomcat 中，只需要引入如下 javaee 標準依賴即可：

<dependency>
  <groupId>javax</groupId>
  <artifactId>javaee-api</artifactId>
  <version>7.0</version>
  <scope>provided</scope>
</dependency>

如使用 springboot 內建容器,無需引入，springboot 已經做了包含。我們只需引入如下依賴即可：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
    <version>1.5.3.RELEASE</version>
    <type>pom</type>
</dependency>

2、注入 Bean

  首先注入一個ServerEndpointExporterBean,該 Bean 會自動註冊使用@ServerEndpoint 註解申明的 websocket endpoint。程式碼如下：

@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter(){
        return new ServerEndpointExporter();
    }
}

3、申明 endpoint

  建立MyWebSocket.java類，在該類中處理 websocket 邏輯

@ServerEndpoint(value = "/websocket") //接受websocket請求路徑
@Component  //註冊到spring容器中
public class MyWebSocket {


    //儲存所有線上socket連線
    private static Map<String,MyWebSocket> webSocketMap = new LinkedHashMap<>();

    //記錄當前線上數目
    private static int count=0;

    //當前連線（每個websocket連入都會建立一個MyWebSocket例項
    private Session session;

    private Logger log = LoggerFactory.getLogger(this.getClass());
    //處理連線建立
    @OnOpen
    public void onOpen(Session session){
        this.session=session;
        webSocketMap.put(session.getId(),this);
        addCount();
        log.info("新的連線加入：{}",session.getId());
    }

    //接受訊息
    @OnMessage
    public void onMessage(String message,Session session){
        log.info("收到客戶端{}訊息：{}",session.getId(),message);
        try{
            this.sendMessage("收到訊息："+message);
        }catch (Exception e){
            e.printStackTrace();
        }
    }

    //處理錯誤
    @OnError
    public void onError(Throwable error,Session session){
        log.info("發生錯誤{},{}",session.getId(),error.getMessage());
    }

    //處理連線關閉
    @OnClose
    public void onClose(){
        webSocketMap.remove(this.session.getId());
        reduceCount();
        log.info("連線關閉:{}",this.session.getId());
    }

    //群發訊息

    //傳送訊息
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }

    //廣播訊息
    public static void broadcast(){
        MyWebSocket.webSocketMap.forEach((k,v)->{
            try{
                v.sendMessage("這是一條測試廣播");
            }catch (Exception e){
            }
        });
    }

    //獲取線上連線數目
    public static int getCount(){
        return count;
    }

    //操作count，使用synchronized確保執行緒安全
    public static synchronized void addCount(){
        MyWebSocket.count++;
    }

    public static synchronized void reduceCount(){
        MyWebSocket.count--;
    }
}

4、客戶的實現

  客戶端使用 h5 原生 websocket，部分瀏覽器可能不支援。程式碼如下：

<html>
  <head>
    <title>websocket測試</title>
    <meta charset="utf-8" />
  </head>

  <body>
    <button onclick="sendMessage()">測試</button>
    <script>
      let socket = new WebSocket("ws://localhost:8080/websocket");
      socket.onerror = err => {
        console.log(err);
      };
      socket.onopen = event => {
        console.log(event);
      };
      socket.onmessage = mess => {
        console.log(mess);
      };
      socket.onclose = () => {
        console.log("連線關閉");
      };

      function sendMessage() {
        if (socket.readyState === 1) socket.send("這是一個測試資料");
        else alert("尚未建立websocket連線");
      }
    </script>
  </body>
</html>

三、測試

  建立一個 controller 測試群發，程式碼如下：

@RestController
public class HomeController {

    @GetMapping("/broadcast")
    public void broadcast(){
        MyWebSocket.broadcast();
    }
}

然後開啟上面的 html，可以看到瀏覽器和伺服器都輸出連線成功的資訊：

瀏覽器：
Event {isTrusted: true, type: "open", target: WebSocket, currentTarget: WebSocket, eventPhase: 2, …}

服務端：
2018-08-01 14:05:34.727  INFO 12708 --- [nio-8080-exec-1] com.fxb.h5websocket.MyWebSocket          : 新的連線加入：0

點選測試按鈕，可在服務端看到如下輸出：

2018-08-01 15:00:34.644  INFO 12708 --- [nio-8080-exec-6] com.fxb.h5websocket.MyWebSocket          : 收到客戶端2訊息：這是一個測試資料

再次開啟 html 頁面，這樣就有兩個 websocket 客戶端，然後在瀏覽器訪問localhost:8080/broadcast測試群發功能,每個客戶端都會輸出如下資訊：

MessageEvent {isTrusted: true, data: "這是一條測試廣播", origin: "ws://localhost:8080", lastEventId: "", source: null, …}

  原始碼可在 github 下載 上下載，記得點贊，star 哦

本文原創釋出於：https://www.tapme.top/blog/detail/2018-08-25-10-38

相關文章