使用spring boot +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
[html] view plain copy
org.springframework.boot
spring-boot-starter-websocket
2.使用@ServerEndpoint創立websocket endpoint（ wang115032337這位朋友在他的環境下加入@ServerEndpoint類會報錯，直接刪除了仍可用）
[java] view plain copy
@Configuration
publicclass WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
returnnew ServerEndpointExporter();
}
}
3.具體實現類可自己選擇url要不要帶參數
[java] view plain copy
package com.star.manager.service;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
@Slf4j
//@ServerEndpoint("/websocket/{user}")
@ServerEndpoint(value = "/websocket")
@Component
publicclass WebSocketServer {
//靜態變量，用來記錄當前在線連接數。應該把它設計成線程安全的。
privatestaticint onlineCount = 0;
//concurrent包的線程安全Set，用來存放每個客戶端對應的MyWebSocket對象。
privatestatic CopyOnWriteArraySet webSocketSet = new CopyOnWriteArraySet();
//與某個客戶端的連接會話，需要通過它來給客戶端發送數據
private Session session;
/**
* 連接建立成功調用的方法*/
@OnOpen
publicvoid onOpen(Session session) {
this.session = session;
webSocketSet.add(this); //加入set中
addOnlineCount(); //在線數加1
log.info("有新連接加入！當前在線人數為" + getOnlineCount());
try {
sendMessage("連接成功");
} catch (IOException e) {
log.error("websocket IO異常");
}
}
// //連接打開時執行
// @OnOpen
// public void onOpen(@PathParam("user") String user, Session session) {
// currentUser = user;
// System.out.println("Connected ... " + session.getId());
// }
/**
* 連接關閉調用的方法
*/
@OnClose
publicvoid onClose() {
webSocketSet.remove(this); //從set中刪除
subOnlineCount(); //在線數減1
log.info("有一連接關閉！當前在線人數為" + getOnlineCount());
}
/**
* 收到客戶端消息后調用的方法
*
* @param message 客戶端發送過來的消息*/
@OnMessage
publicvoid onMessage(String message, Session session) {
log.info("來自客戶端的消息:" + message);
//群發消息
for (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
*
* @param session
* @param error
*/
@OnError
publicvoid onError(Session session, Throwable error) {
log.error("發生錯誤");
error.printStackTrace();
}
publicvoid sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
}
/**
* 群發自定義消息
* */
publicstaticvoid sendInfo(String message) throws IOException {
log.info(message);
for (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
continue;
}
}
}
publicstaticsynchronizedint getOnlineCount() {
return onlineCount;
}
publicstaticsynchronizedvoid addOnlineCount() {
WebSocketServer.onlineCount++;
}
publicstaticsynchronizedvoid subOnlineCount() {
WebSocketServer.onlineCount--;
}
}
產生一個消息：產生消息場景有多種，http（s），定時任務，mq等，這貼一個httpq請求的controller代碼
[java] view plain copy
@RequestMapping(value="/pushVideoListToWeb",method=RequestMethod.POST,consumes = "application/json")
public @ResponseBody Map pushVideoListToWeb(@RequestBody Map param) {
Map result =new HashMap();
try {
WebSocketServer.sendInfo("有新客戶呼入,sltAccountId:"+CommonUtils.getValue(param, "sltAccountId"));
result.put("operationResult", true);
}catch (IOException e) {
result.put("operationResult", true);
}
return result;
}
重要的地方我都加粗了，主要是這段，使用這個方法，可以實現服務器主動推送。
[java] view plain copy
publicvoid sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
}
4.js（html就不寫了，隨便找個能觸發這個js的就可以）
[javascript] view plain copy
//socket = new WebSocket("ws://localhost:9094/starManager/websocket/張三");
var socket;
if(typeof(WebSocket) == "undefined") {
console.log("您的瀏覽器不支持WebSocket");
}else{
console.log("您的瀏覽器支持WebSocket");
//實現化WebSocket對象，指定要連接的服務器地址與端口 建立連接
//socket = new WebSocket("ws://localhost:9094/starManager/websocket/張三")
[javascript] view plain copy
socket = new WebSocket("ws://localhost:9094/starManager/websocket");
//打開事件
socket.onopen = function() {
console.log("Socket 已打開");
//socket.send("這是來自客戶端的消息" + location.href + new Date());
};
//獲得消息事件
socket.onmessage = function(msg) {
console.log(msg.data);
//發現消息進入 調后臺獲取
getCallingList();
};
//關閉事件
socket.onclose = function() {
console.log("Socket已關閉");
};
//發生了錯誤事件
socket.onerror = function() {
alert("Socket發生了錯誤");
}
$(window).unload(function(){
socket.close();
});
// $("#btnSend").click(function() {
// socket.send("這是來自客戶端的消息" + location.href + new Date());
// });
//
// $("#btnClose").click(function() {
// socket.close();
// });
}
簡單說說：
通過前端代碼
[javascript] view plain copy
socket = new WebSocket("ws://localhost:9094/starManager/websocket");
其中，starManager是工程名，/webscoket是訪問路徑名
建立連接，前端調用scoket.open() 會使后臺在靜態成員變量webSocketSet里面增加一個元素，相當于一個緩存。后臺服務調用sendMessage
（指定某個用戶，定向）或sendInfo（遍歷webSocketSet逐個發送，類似群發）方法，即可向已登錄的客戶端推送消息。
代碼就這么多。我的用這些代碼就跑的起來。做的時候出現過頁面報404等錯誤，如果也是spring boot+h5，仔細核對下和我代碼有無區別，加配置 路徑是有ok，問題應該不大。
總結
以上是生活随笔為你收集整理的使用spring boot +WebSocket实现（后台主动）消息推送的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 当我们在谈论HTTP缓存时我们在谈论什么
- 下一篇： 高性能线程间队列 DISRUPTOR 简