您好,登錄后才能下訂單哦!
今天就跟大家聊聊有關springboot中怎么整合WebSocket,可能很多人都不太了解,為了讓大家更加了解,小編給大家總結了以下內容,希望大家根據這篇文章可以有所收獲。
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、客戶的實現
客戶端使用 h6 原生 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.h6websocket.MyWebSocket : 新的連接加入:0
點擊測試按鈕,可在服務端看到如下輸出:
2018-08-01 15:00:34.644 INFO 12708 --- [nio-8080-exec-6] com.fxb.h6websocket.MyWebSocket : 收到客戶端2消息:這是一個測試數據
再次打開 html 頁面,這樣就有兩個 websocket 客戶端,然后在瀏覽器訪問localhost:8080/broadcast測試群發功能,每個客戶端都會輸出如下信息:
MessageEvent {isTrusted: true, data: "這是一條測試廣播", origin: "ws://localhost:8080", lastEventId: "", source: null, …}
看完上述內容,你們對springboot中怎么整合WebSocket有進一步的了解嗎?如果還想了解更多知識或者相關內容,請關注億速云行業資訊頻道,感謝大家的支持。
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。