WebSocket 提供的是全雙工、長連通的通道,非常適合做即時推播。以下示範如何在 Spring 系列後端建立 WebSocket 服務,並讓微信小程序成功連上。
後端需要四件事:加入 Maven 相依、建立握手攔截器、建立訊息處理器、完成 Spring 配置(XML 或 JavaBean 擇一)。小程序端則只要寫好連線程式碼。
<!-- websocket --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-websocket</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-messaging</artifactId> <version>${spring.version}</version> </dependency> <!-- 其中spring版本 --> <!-- 注意spring版本一定要為4以上版本 --> <spring.version>4.3.7.RELEASE</spring.version>
特別提醒:Spring 版本必須在 4 以上,否則相關套件根本不存在。
這個類別的職責是在連線建立前取得登入使用者資訊,並交給 WebSocket 管理。實務上通常會在這裡把使用者識別碼塞進 attributes,後續推播才能定位到特定的人。
package com.ahutshop.websocket; import java.util.Map; import javax.servlet.http.HttpServletRequest; 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; /** * 此類用來獲取登錄用戶信息並交由websocket管理 */ public class MyWebSocketInterceptor implements HandshakeInterceptor { @Override public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse arg1, WebSocketHandler arg2, Map<String, Object> arg3) throws Exception { // 將ServerHttpRequest轉換成request請求相關的類,用來獲取request域中的用戶信息 if (request instanceof ServletServerHttpRequest) { ServletServerHttpRequest servletRequest = (ServletServerHttpRequest) request; HttpServletRequest httpRequest = servletRequest.getServletRequest(); } System.out.println("連接到我了"); return true; } @Override public void afterHandshake(ServerHttpRequest arg0, ServerHttpResponse arg1, WebSocketHandler arg2, Exception arg3) { // TODO Auto-generated method stub } }
這是 WebSocket 的核心。四個回呼分別對應連線建立、收到訊息、傳輸錯誤與連線關閉。這裡用一個靜態 List 保存所有 session,實務上建議改用 ConcurrentHashMap 以支援併發,並以使用者 id 作為 key。
package com.ahutshop.websocket; import java.io.IOException; import java.util.ArrayList; import java.util.List; 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; public class WebSocketPushHandler implements WebSocketHandler { private static final List<WebSocketSession> users = new ArrayList<>(); // 用戶進入系統監聽 @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { System.out.println("成功進入了系統。。。"); users.add(session); sendMessagesToUsers(new TextMessage("今天晚上服務器維護,請注意")); } // @Override public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception { // 將消息進行轉化,因為是消息是json數據,可能裡面包含了發送給某個人的信息,所以需要用json相關的工具類處理之後再封裝成TextMessage, // 我這兒並沒有做處理,消息的封裝格式一般有{from:xxxx,to:xxxxx,msg:xxxxx},來自哪裡,發送給誰,什麼消息等等 // TextMessage msg = (TextMessage)message.getPayload(); // 給所有用戶群發消息 //sendMessagesToUsers(msg); // 給指定用戶群發消息 //sendMessageToUser(userId, msg); } // 後台錯誤信息處理方法 @Override public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception { } // 用戶退出後的處理,不如退出之後,要將用戶信息從websocket的session中remove掉,這樣用戶就處於離線狀態了,也不會占用系統資源 @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception { if (session.isOpen()) { session.close(); } users.remove(session); System.out.println("安全退出了系統"); } @Override public boolean supportsPartialMessages() { return false; } /** * 給所有的用戶發送消息 */ public void sendMessagesToUsers(TextMessage message) { for (WebSocketSession user : users) { try { // isOpen()在線就發送 if (user.isOpen()) { user.sendMessage(message); } } catch (IOException e) { e.printStackTrace(); } } } /** * 發送消息給指定的用戶 */ public void sendMessageToUser(String userId, TextMessage message) { for (WebSocketSession user : users) { if (user.getAttributes().get("").equals(userId)) { try { // isOpen()在線就發送 if (user.isOpen()) { user.sendMessage(message); } } catch (IOException e) { e.printStackTrace(); } } } } }
推薦使用 JavaBean 方式,寫法直觀且不必維護 XML:
javabean方式配置(推薦) package com.ahutshop.websocket; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter; import org.springframework.web.socket.WebSocketHandler; import org.springframework.web.socket.config.annotation.EnableWebSocket; import org.springframework.web.socket.config.annotation.WebSocketConfigurer; import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry; @Configuration @EnableWebSocket public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer { @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(WebSocketPushHandler(), "/webSocketServer.action").addInterceptors(new MyWebSocketInterceptor()).setAllowedOrigins("*"); registry.addHandler(WebSocketPushHandler(), "/sockjs/webSocketServer.action") .addInterceptors(new MyWebSocketInterceptor()).withSockJS(); } @Bean public WebSocketHandler WebSocketPushHandler() { return new WebSocketPushHandler(); } } spring.xml中配置掃描包 <!-- 掃描包 --> <context:component-scan base-package="com.ahutshop.websocket" />
1. 路徑為什麼要帶 .action 後綴?因為 web.xml 中把 DispatcherServlet 的攔截後綴設成了 *.action,路徑必須對得上才會被正確處理:
<!-- springmvc模塊 --> <servlet> <servlet-name>DispatcherServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:springmvc.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> <!-- 支持異步 --> <async-supported>true</async-supported> </servlet> <servlet-mapping> <servlet-name>DispatcherServlet</servlet-name> <url-pattern>*.action</url-pattern> </servlet-mapping>
另外別忘了 <async-supported>true</async-supported>,WebSocket 依賴非同步處理,少了這行會直接連不上。
2. setAllowedOrigins("*") 中的星號代表允許的請求來源,這個方法接受一個可變參數陣列。一定要設定,否則請求時會出現 403。正式環境請替換成實際的網域,避免使用萬用字元帶來安全風險。
websocket.wxml
<!--pages/websocket/websocket.wxml--> <view class="page"> <view class="page__hd"> </view> <view class="page__bd"> <button bindtap="connectWebsocket" type="primary">連接websocket</button> </view> </view>
websocket.js
// pages/websocket/websocket.js Page({ /** * 頁面的初始數據 */ data: { }, connectWebsocket: function () { wx.connectSocket({ url: 'ws://localhost:8080/AhutShop/webSocketServer.action', data: { }, header: { 'content-type': 'application/json' }, method: "GET" }) wx.onSocketOpen(function (res) { console.log('WebSocket連接已打開!') }) wx.onSocketError(function (res) { console.log('WebSocket連接打開失敗,請檢查!') }) wx.onSocketMessage(function (res) { console.log('收到服務器內容:' + res.data) }) } })
小程序端要注意:正式上線時 ws:// 必須改為 wss://,且網域需事先在小程序後台加入合法域名清單,開發階段則可在工具中勾選「不驗證合法域名」暫時繞過。

以上就是後端建立 WebSocket 並讓小程序連上的完整流程,有問題歡迎留言或到社群討論。