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

selfimpr 發布于2019-05-23 14:14 / 1978人閱讀

摘要：我們只需引入如下依賴即可注入首先注入一個該會自動注冊使用注解申明的。

一、背景

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

輪詢：缺點很多，但是實現簡單

websocket：在瀏覽器和服務器之間建立 tcp 連接，實現全雙工通信

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

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

二、實現

1、依賴引入

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

<dependency>
  <groupId>javaxgroupId>
  <artifactId>javaee-apiartifactId>
  <version>7.0version>
  <scope>providedscope>
dependency>

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

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-websocketartifactId>
    <version>1.5.3.RELEASEversion>
    <type>pomtype>
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 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 哦

本文原創發布于：www.tapme.top/blog/detail…

云服務器 GPU云服務器 webrtc如何在web中使用在php中如何使用n 你知道你應該知道

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/6993.html

分布式WebSocket集群解決方案

摘要：廣播這是最簡單的集群通訊解決方案。實現方法在治理中心監聽集群服務事件，并及時更新哈希環。問題起因最近做項目時遇到了需要多用戶之間通信的問題，涉及到了WebSocket握手請求，以及集群中WebSocket Session共享的問題。期間我經過了幾天的研究，總結出了幾個實現分布式WebSocket集群的辦法，從zuul到spring cloud gateway的不同嘗試，總結出了...

nanchen2251 2019-08-16 13:57 評論0 收藏0
假如我是面試官，我會這樣虐你

摘要：又是金三銀四的時候，我希望這份面試題能夠祝你一臂之力自我和項目相關自我介紹你覺得自己的優點是你覺得自己有啥缺點你有哪些你為什么要離開上家公司你上家公司在，我們公司在，離這么遠為什么要選擇我們這里上家公司的同事和領導是怎么評價你的介紹下你的上又是金三銀四的時候，我希望這份面試題能夠祝你一臂之力！自我和項目相關 1、自我介紹 2、你覺得自己的優點是？你覺得自己有啥缺點？ 3、你有哪些 ...

Benedict Evans 2019-08-16 15:35 評論0 收藏0
全棧開發——動手打造屬于自己的直播間（Vue+SpringBoot+Nginx）

摘要：經過琢磨，其實是要考慮安全性的。具體在以下幾個方面跨域連接協議升級前握手攔截器消息信道攔截器對于跨域問題，我們可以通過方法來設置可連接的域名，防止跨站連接。前言大學的學習時光臨近尾聲，感嘆時光匆匆，三年一晃而過。同學們都忙著找工作，我也在這里拋一份簡歷吧，歡迎各位老板和獵手誠邀。我們進入正題。直播行業是當前火熱的行業，誰都想從中分得一杯羹，直播養活了一大批人，一個平臺主播粗略估計就...

e10101 2019-07-25 13:57 評論0 收藏0
你不知道WebSocket嗎？

摘要：什么是是一種在單個連接上進行全雙工通信的協議。短輪詢配段代碼，靜態服務中間件用來返回靜態文件當前價格是元獲取最新價格接口客戶端不停的發送請求，去服務端獲取最新價格。它通過連接到一個服務器，以格式接收事件不關閉連接。什么是WebSocket？ WebSocket是一種在單個TCP連接上進行全雙工通信的協議。這里我們發現了一個有趣的詞:全雙工,那我們就來簡單了解下通信方式有哪些！單工 ...

techstay 2019-08-30 15:44 評論0 收藏0