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

時間 2019-11-24

標籤知道 springboot 如何使用 websocket 欄目 Spring 简体版

原文原文鏈接

1、背景

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

輪詢：缺點不少，可是實現簡單
websocket：在瀏覽器和服務器之間創建 tcp 鏈接，實現全雙工通訊

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

注意：以下都是針對使用 springboot 內置容器git

2、實現

一、依賴引入

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

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

如使用 springboot 內置容器,無需引入，springboot 已經作了包含。咱們只需引入以下依賴便可：web

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

二、注入 Bean

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

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

三、申明 endpoint

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

@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--;
    }
}

四、客戶的實現

客戶端使用 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>

3、測試

創建一個 controller 測試羣發，代碼以下：tomcat

@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

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。