碼上歡樂
相關內容    簡體    繁體

使用spring boot +WebSocket實現（后台主動）消息推送

本文轉載自   查看原文   2018-07-10 17:36   2890    [SOA] :WebService/WCF/Remoting/WebSocket

言：使用此webscoket務必確保生產環境能兼容/支持！使用此webscoket務必確保生產環境能兼容/支持！使用此webscoket務必確保生產環境能兼容/支持！主要是tomcat的兼容與支持。

有個需求：APP用戶產生某個操作，需要讓后台管理系統部分人員感知（表現為一個頁面消息）。

最早版本是后台管理系統輪訓，每隔一段時間輪訓一次，由於消息重要，每隔幾秒就查一次。這樣做明顯很不雅！會消耗大量資源，並且大部分請求是沒有用的（查不到數據進來），很藍瘦。

后來，想着用消息推送的方式來處理這個邏輯。用戶在app產生了目標操作，即產生一個消息，推送給后台管理系統的對應用戶。

然后我就找各種資料，一開始同事推薦dwz，后來發現不太適用於目前的項目（也許能實現只是我不知道如何實現）。

后來了解到WebSocket，網上看了很多文檔都是類似聊天室的場景，有些不同。在此，我主要側重介紹下 服務器主動推送，由服務端來觸發。

WebSocket 主要能實現的場景：

1、網頁聊天室

2、服務器消息實時通知

WebSocket 使用方法應該有很多，在次介紹下使用  tomcat8+h5 環境下的實現。

ps：我自己的測試環境是tomcat7這樣寫是不行的。wang115032337《https://blog.csdn.net/wang115032337》這位朋友在他的環境下，tomcat7/8都可以用本文章的寫法，只不過需要去除WebSocketConfig類（有文章表示tomcat7和8對websocket的支持是不同的，本人未深入了解）

話不多說，直接上代碼，想深入了解WebSocket 的請查閱相關介紹。

1.pom

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-websocket</artifactId>
  4. </dependency>

2.使用@ServerEndpoint創立websocket endpoint（ wang115032337這位朋友在他的環境下加入@ServerEndpoint類會報錯，直接刪除了仍可用）

 

  1. @Configuration
  2. public class WebSocketConfig {
  3. @Bean
  4. public ServerEndpointExporter serverEndpointExporter() {
  5. return new ServerEndpointExporter();
  6. }
  7.  
  8. }

3.具體實現類可自己選擇url要不要帶參數

  1. package com.star.manager.service;
  2.  
  3. import java.io.IOException;
  4. import java.util.concurrent.CopyOnWriteArraySet;
  5.  
  6. import javax.websocket.OnClose;
  7. import javax.websocket.OnError;
  8. import javax.websocket.OnMessage;
  9. import javax.websocket.OnOpen;
  10. import javax.websocket.Session;
  11. import javax.websocket.server.ServerEndpoint;
  12.  
  13. import lombok.extern.slf4j.Slf4j;
  14.  
  15. import org.springframework.stereotype.Component;
  16. @Slf4j
  17. //@ServerEndpoint("/websocket/{user}")
  18. @ServerEndpoint(value = "/websocket")
  19. @Component
  20. public class WebSocketServer {
  21. //靜態變量，用來記錄當前在線連接數。應該把它設計成線程安全的。
  22. private static int onlineCount = 0;
  23. //concurrent包的線程安全Set，用來存放每個客戶端對應的MyWebSocket對象。
  24. private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();
  25.  
  26. //與某個客戶端的連接會話，需要通過它來給客戶端發送數據
  27. private Session session;
  28.  
  29. /**
  30. * 連接建立成功調用的方法*/
  31. @OnOpen
  32. public void onOpen(Session session) {
  33. this.session = session;
  34. webSocketSet.add( this); //加入set中
  35. addOnlineCount(); //在線數加1
  36. log.info( "有新連接加入！當前在線人數為" + getOnlineCount());
  37. try {
  38. sendMessage( "連接成功");
  39. } catch (IOException e) {
  40. log.error( "websocket IO異常");
  41. }
  42. }
  43. // //連接打開時執行
  44. // @OnOpen
  45. // public void onOpen(@PathParam("user") String user, Session session) {
  46. // currentUser = user;
  47. // System.out.println("Connected ... " + session.getId());
  48. // }
  49.  
  50. /**
  51. * 連接關閉調用的方法
  52. */
  53. @OnClose
  54. public void onClose() {
  55. webSocketSet.remove( this); //從set中刪除
  56. subOnlineCount(); //在線數減1
  57. log.info( "有一連接關閉！當前在線人數為" + getOnlineCount());
  58. }
  59.  
  60. /**
  61. * 收到客戶端消息后調用的方法
  62. *
  63. * @param message 客戶端發送過來的消息*/
  64. @OnMessage
  65. public void onMessage(String message, Session session) {
  66. log.info( "來自客戶端的消息:" + message);
  67.  
  68. //群發消息
  69. for (WebSocketServer item : webSocketSet) {
  70. try {
  71. item.sendMessage(message);
  72. } catch (IOException e) {
  73. e.printStackTrace();
  74. }
  75. }
  76. }
  77.  
  78. /**
  79. *
  80. * @param session
  81. * @param error
  82. */
  83. @OnError
  84. public void onError(Session session, Throwable error) {
  85. log.error( "發生錯誤");
  86. error.printStackTrace();
  87. }
  88.  
  89.  
  90. public void sendMessage(String message) throws IOException {
  91. this.session.getBasicRemote().sendText(message);
  92. }
  93.  
  94.  
  95. /**
  96. * 群發自定義消息
  97. * */
  98. public static void sendInfo(String message) throws IOException {
  99. log.info(message);
  100. for (WebSocketServer item : webSocketSet) {
  101. try {
  102. item.sendMessage(message);
  103. } catch (IOException e) {
  104. continue;
  105. }
  106. }
  107. }
  108.  
  109. public static synchronized int getOnlineCount() {
  110. return onlineCount;
  111. }
  112.  
  113. public static synchronized void addOnlineCount() {
  114. WebSocketServer.onlineCount++;
  115. }
  116.  
  117. public static synchronized void subOnlineCount() {
  118. WebSocketServer.onlineCount--;
  119. }
  120. }

產生一個消息：產生消息場景有多種，http（s），定時任務，mq等，這貼一個httpq請求的controller代碼

 

  1. @RequestMapping(value="/pushVideoListToWeb",method=RequestMethod.POST,consumes = "application/json")
  2. public @ResponseBody Map<String,Object> pushVideoListToWeb(@RequestBody Map<String,Object> param) {
  3. Map<String,Object> result = new HashMap<String,Object>();
  4.  
  5. try {
  6. WebSocketServer.sendInfo( "有新客戶呼入,sltAccountId:"+CommonUtils.getValue(param, "sltAccountId"));
  7. result.put( "operationResult", true);
  8. } catch (IOException e) {
  9. result.put( "operationResult", true);
  10. }
  11. return result;
  12. }



重要的地方我都加粗了，主要是這段，使用這個方法，可以實現服務器主動推送。

 

  1. public void sendMessage(String message) throws IOException {
  2. this.session.getBasicRemote().sendText(message);
  3. }

4.js（html就不寫了，隨便找個能觸發這個js的就可以）

  1. //socket = new WebSocket("ws://localhost:9094/starManager/websocket/張三");
  2. var socket;
  3. if(typeof(WebSocket) == "undefined") {
  4. console.log("您的瀏覽器不支持WebSocket");
  5. } else{
  6. console.log("您的瀏覽器支持WebSocket");
  7.  
  8. //實現化WebSocket對象，指定要連接的服務器地址與端口 建立連接
  9. //socket = new WebSocket("ws://localhost:9094/starManager/websocket/張三")
  1. socket = new WebSocket("ws://localhost:9094/starManager/websocket");
  2. //打開事件
  3. socket.onopen = function() {
  4. console.log("Socket 已打開");
  5. //socket.send("這是來自客戶端的消息" + location.href + new Date());
  6. };
  7. //獲得消息事件
  8. socket.onmessage = function(msg) {
  9. console.log(msg.data);
  10. //發現消息進入 調后台獲取
  11. getCallingList();
  12. };
  13. //關閉事件
  14. socket.onclose = function() {
  15. console.log("Socket已關閉");
  16. };
  17. //發生了錯誤事件
  18. socket.onerror = function() {
  19. alert( "Socket發生了錯誤");
  20. }
  21. $( window).unload(function(){
  22. socket.close();
  23. });
  24.  
  25. // $("#btnSend").click(function() {
  26. // socket.send("這是來自客戶端的消息" + location.href + new Date());
  27. // });
  28. //
  29. // $("#btnClose").click(function() {
  30. // socket.close();
  31. // });
  32. }

簡單說說：

通過前端代碼 

socket = new WebSocket("ws://localhost:9094/starManager/websocket");

其中，starManager是工程名，/webscoket是訪問路徑名

建立連接，前端調用scoket.open() 會使后台在靜態成員變量webSocketSet里面增加一個元素，相當於一個緩存。后台服務調用sendMessage

（指定某個用戶，定向）或sendInfo（遍歷webSocketSet逐個發送，類似群發）方法，即可向已登錄的客戶端推送消息。

代碼就這么多。我的用這些代碼就跑的起來。做的時候出現過頁面報404等錯誤，如果也是spring boot+h5，仔細核對下和我代碼有無區別，加配置 路徑是有ok，問題應該不大。

 

如果你恰好也有可以用WebSocket實現的類似場景，希望對你有幫助。如有寫的不對或不夠好的地方，歡迎指正。

 





 

 

 

版權聲明：本文為博主原創文章，未經博主允許不得轉載。 https://blog.csdn.net/zhangdehua678/article/details/78913839


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 spring boot 集成 websocket 實現消息主動推送 Websocket實現Java后台主動推送消息到前台 springboot-websocket實現消息的主動推送 Java 實現WebSocket主動推送消息 用websocket實現后台推送消息 Spring boot+VUE+websocket 實現消息推送 如何實現服務端主動給客戶端推送消息，websocket詳解，以及django如何使用websocket問題 Spring WebSocket實現消息推送 Spring WebSocket實現消息推送 golang 使用 websocket 實現后台消息分組推送
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM