Spring整合webSocket詳解
阿新 • • 發佈：2019-02-10
踩坑總結
因為之前從來沒有接觸過，所以網上找了很多教程最後發現都不怎麼完整，大多數都是直接全盤照抄《Spring Boot》一書中的相關示例，沒有做任何修改，沒有說明為什麼一定要用spring security，而下面的教程自己也是踩了不少坑，如前後分離中session一直獲取不到，導致無法連結上，uid不可為中文，websocket自帶協議和服務，導致前後端分離一直報跨域的錯誤等等。當然websocket一些解釋在這邊就不多說了，相信你已經看了很多教程了，我們就直接上配置教程
前端配置
前端配置相對比較簡單，主要就是websocket服務的註冊，訊息的傳送和接收。比較關鍵的點：uid的定義。
// 使用者的特殊標誌，一般用id或者生成的uuid，後臺為Long，不可帶有中文，並且這些值如果從session中獲取，需要注意前後端分離帶來的session，否則會報錯,這些引數主要對應著後臺的message類，用於資訊的傳送
let from = '';
let fromName = '';
let to = 5521;
let host = window.location.host;
let webSocket = "";
// 不同的瀏覽器對websocket的支援不同
if ('WebSocket' in window) {
// 最關鍵的點，ws必須加上，不可用http，因為兩者的協議是不同的，websocket有自帶的請求協議，uid是為了將使用者的id註冊到websocket的服務中 後端配置
先新增maven相關依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.2.2</version>
</dependency>1. 註冊websocket服務（前端連結的url地址）
import javax.annotation.Resource;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
/**
* 描述:
* WebScoket配置處理器
*
* @author Msater Zg
* @create 2018-01-24 10:49
*/
@Component
@EnableWebSocket
public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer {
/**
* 後臺寫好服務，專案啟動的時候，註冊好這兩個服務，以供前臺呼叫
*/
@Resource
MyWebSocketHandler handler;
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
// 連結的時候，websocket會自己增加同源檢測的功能，需要單獨配置是否允許跨域，我配置*代表允許所有的ip進行呼叫。
registry.addHandler(handler, "/ws").addInterceptors(new HandShake()).setAllowedOrigins("*");
registry.addHandler(handler, "/ws/sockjs").addInterceptors(new HandShake()).setAllowedOrigins("*").withSockJS();
}
}2. 握手之前的配置（需要將使用者相關uid註冊到WebSocketSession中，而這個uid你可以用token，session等等來代替，因為是前端分離，所以我直接用了使用者的id）
import java.util.Map;
import javax.servlet.http.HttpSession;
import org.springframework.http.HttpHeaders;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.server.HandshakeInterceptor;
/**
* 描述:
* Socket建立連線（握手）和斷開
*
* @author Msater Zg
* @create 2018-01-24 10:49
*/
public class HandShake implements HandshakeInterceptor {
@Override
public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
Map<String, Object> attributes) throws Exception {
/**
* websocket系統啟動連線程式，啟動的時候就會把他的session值傳過來，放入到websocketsession（websocket的一個內建伺服器）裡面
*/
ServletServerHttpRequest servletRequest = (ServletServerHttpRequest) request;
Long uid = Long.parseLong(servletRequest.getServletRequest().getParameter("uid"));
if (uid != 0) {
attributes.put("uid", uid);
} else {
return false;
}
return true;
}
@Override
public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
Exception exception) {
}
}3. 訊息推送的相關的後臺的方法
import java.io.IOException;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.WebSocketMessage;
import org.springframework.web.socket.WebSocketSession;
/**
* 描述:
* Socket處理器(包括髮送資訊，接收資訊，資訊錯誤等方法。)
*
* @author Msater Zg
* @create 2018-01-24 10:49
*/
@Component
public class MyWebSocketHandler implements WebSocketHandler {
/**
* 最重要的websocket處理程式（包括髮送資訊，接收資訊，資訊錯誤等方法。）
*/
/**
* 先註冊一個websocket伺服器，將連線上的所有使用者放進去
*/
public static final Map<Long, WebSocketSession> USER_SOCKET_SESSION_MAP;
static {
USER_SOCKET_SESSION_MAP = new HashMap<Long, WebSocketSession>();
}
/**
* 前臺連線並且註冊了賬戶
*/
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
Long uid = (Long) session.getAttributes().get("uid");
if (USER_SOCKET_SESSION_MAP.get(uid) == null) {
USER_SOCKET_SESSION_MAP.put(uid, session);
}
}
@Override
public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
if (message.getPayloadLength() == 0) {
return;
}
NotificationMessage msg = new Gson().fromJson(message.getPayload().toString(), NotificationMessage.class);
msg.setDate(new Date());
sendMessageToUser(msg.getTo(), new TextMessage(new GsonBuilder().setDateFormat("yyyy-MM-dd HH:mm:ss").create().toJson(msg)));
}
/**
* 訊息傳輸錯誤處理，如果出現錯誤直接斷開連線
*/
@Override
public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
if (session.isOpen()) {
session.close();
}
removeWebSocketUser(session);
}
/**
* 關閉連線後
*/
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
System.out.println("Websocket:" + session.getId() + "已經關閉");
removeWebSocketUser(session);
}
@Override
public boolean supportsPartialMessages() {
return false;
}
/**
* 給所有線上使用者傳送訊息
*
* @param message
* @throws IOException
*/
public void broadcast(final TextMessage message) throws IOException {
Iterator<Entry<Long, WebSocketSession>> it = USER_SOCKET_SESSION_MAP.entrySet().iterator();
// 多執行緒群發（給所有線上的使用者傳送訊息） 先判斷是否裡面有使用者（）然後迴圈發訊息
/*後臺呼叫sendMessage方法的時候，前臺會觸發onmessage*/
while (it.hasNext()) {
final Entry<Long, WebSocketSession> entry = it.next();
if (entry.getValue().isOpen()) {
new Thread(new Runnable() {
@Override
public void run() {
try {
if (entry.getValue().isOpen()) {
entry.getValue().sendMessage(message);
}
} catch (IOException e) {
e.printStackTrace();
}
}
}).start();
}
}
}
/**
* 單個使用者發訊息
*
* @param message
* @throws IOException
*/
public void sendMessageToUser(Long uid, TextMessage message) throws IOException {
//根據傳過來的賬號，在websocketseesion的伺服器裡面找，接收者註冊的賬號
WebSocketSession session = USER_SOCKET_SESSION_MAP.get(uid);
if (session != null && session.isOpen()) {
session.sendMessage(message);
}
}
public void removeWebSocketUser(WebSocketSession session) {
Iterator<Entry<Long, WebSocketSession>> it = USER_SOCKET_SESSION_MAP.entrySet().iterator();
// 移除Socket會話
while (it.hasNext()) {
Entry<Long, WebSocketSession> entry = it.next();
if (entry.getValue().getId().equals(session.getId())) {
USER_SOCKET_SESSION_MAP.remove(entry.getKey());
break;
}
}
}
}4. 訊息類（可根據不同的需求進行修改）
import java.util.Date;
/**
* 描述:
* 訊息類
*
* @author Msater Zg
* @create 2018-02-24 10:49
*/
public class NotificationMessage {
/**
* 傳送者賬號
*/
public Long from;
/**
* 傳送者名稱
*/
public String fromName;
/**
* 接收者賬號
*/
public Long to;
/**
* 傳送的內容
*/
public String text;
/**
* 傳送的日期
*/
public Date date;
public Long getFrom() {
return from;
}
public void setFrom(Long from) {
this.from = from;
}
public Long getTo() {
return to;
}
public void setTo(Long to) {
this.to = to;
}
public String getText() {
return text;
}
public void setText(String text) {
this.text = text;
}
public String getFromName() {
return fromName;
}
public void setFromName(String fromName) {
this.fromName = fromName;
}
public Date getDate() {
return date;
}
public void setDate(Date date) {
this.date = date;
}
}後續
大致原理就是後臺啟動websocket服務，前端使用者註冊並在websocket自帶session服務中放這兒值，而後續的訊息傳送，就是給websocketsession中的使用者傳送訊息，然後前端進行響應，以上都是自己一些看法，有什麼問題還希望指出