spring+websocket的整合例項(超詳細，可使用)
阿新 • • 發佈：2019-01-29
來源：https://blog.csdn.net/qq_35515521/article/details/78610847
定義：
WebSocket協議是基於TCP的一種新的網路協議。它實現了瀏覽器與伺服器全雙工(full-duplex)通訊——允許伺服器主動傳送資訊給客戶端
上面是百度官網的介紹，我主要使用websocket的目的是為了，能讓伺服器能夠主動推送訊息給瀏覽器，而不是之前通過ajax或者長輪循不斷觸發伺服器。
我通過學習整合了一個簡單可用通訊的例項。好了，廢話不多說，直接上內容。
整合步驟：
由於我用的maven專案，所以先通過pom.xml進行引包。
**第一步：**pom.xml引包
在這裡需要注意2點：1、spring相關的jar包必須是版本4以上的 2、websoket引入的jar包版本號和spring的版本號要一直，如果不一致的話回出現：NoClassDefFoundError: org/springframework/web/cors/CorsProcessor，這樣框架異常。
新增的spring的支援包：
<!-- 新增Spring支援 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>4.2.4.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId - 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
新增websocket的jar包
<!-- 新增對websocket的支援 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-orm</artifactId>
<version>4.2.4.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>4.2.4.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-websocket</artifactId>
<version>4.2.4.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-messaging</artifactId>
<version>4.2.4.RELEASE</version>
</dependency>- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
第二步：配置spring-websocket.xml檔案
這裡注意的是：xsi:schemaLocation屬性後面倆行一定要有。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:websocket="http://www.springframework.org/schema/websocket"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/websocket
http://www.springframework.org/schema/websocket/spring-websocket-4.0.xsd">
<bean id="websocket" class="com.web.common.util.websocket.WebSocketHander" />
<websocket:handlers>
<websocket:mapping path="/echo" handler="websocket" />
<websocket:handshake-interceptors>
<bean class="com.web.common.util.websocket.HandshakeInterceptor" />
</websocket:handshake-interceptors>
</websocket:handlers>
</beans> - 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
在applicationContext.xml中引入spring-websocket.xml檔案
<!-- 引入websocket -->
<import resource="spring-websocket.xml"/>- 1
- 2
在web.xml中引入applicationContext.xml
<!-- Spring配置檔案 -->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:applicationContext.xml</param-value>
</context-param>- 1
- 2
- 3
- 4
- 5
第三步：編寫程式碼
package com.web.common.util.websocket;
import org.apache.shiro.session.Session;
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 javax.servlet.http.HttpServletRequest;
import java.util.Map;
/**
* 攔截器
*
* @author wangguan,
* @date 2017年11月22日 上午9:33:46,
* @version argType
*/
public class HandshakeInterceptor implements org.springframework.web.socket.server.HandshakeInterceptor{
Session session;
// 初次握手訪問前
public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse serverHttpResponse,
WebSocketHandler webSocketHandler, Map<String, Object> map) throws Exception {
if (request instanceof ServletServerHttpRequest) {
HttpServletRequest servletRequest = ((ServletServerHttpRequest) request).getServletRequest();
String sessionId=servletRequest.getSession().getId();//獲取瀏覽器的sessionid
String username=(String)servletRequest.getSession().getAttribute("name");
System.out.println("獲取session裡面的name-------------------"+username);
// 使用userName區分WebSocketHandler，以便定向傳送訊息
/* String userName = (String)*/
//session.getAttribute("WEBSOCKET_USERNAME");
map.put("WEBSOCKET_USERNAME", username);
servletRequest.getSession().setAttribute("WEBSOCKET_USERNAME", username);
}
return true;
}
// 初次握手訪問後
public void afterHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse,
WebSocketHandler webSocketHandler, Exception e) {
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
WebSocketHander 實現WebSocketHandler
package com.web.common.util.websocket;
import org.apache.log4j.Logger;
import org.springframework.web.socket.*;
import java.io.IOException;
import java.util.ArrayList;
public class WebSocketHander implements WebSocketHandler {
private static final Logger logger = Logger.getLogger(WebSocketHander.class);
private static final ArrayList<WebSocketSession> users = new ArrayList<WebSocketSession>();
private String userName="";
// 初次連結成功執行
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
logger.debug("連結成功......");
users.add(session);
userName = (String) session.getAttributes().get("WEBSOCKET_USERNAME");
System.out.println("第一次連接獲取的id--"+userName);
if (userName != null) {
// 查詢未讀訊息
int count = 5;
session.sendMessage(new TextMessage(count + ""));
}
}
// 接受訊息處理訊息
public void handleMessage(WebSocketSession webSocketSession, WebSocketMessage<?> webSocketMessage)
throws Exception {
//sendMessageToUsers(new TextMessage(webSocketMessage.getPayload() + ""));
sendMessageToUser(userName, new TextMessage(webSocketMessage.getPayload() + ""));
}
public void handleTransportError(WebSocketSession webSocketSession, Throwable throwable) throws Exception {
if (webSocketSession.isOpen()) {
webSocketSession.close();
}
logger.debug("連結出錯，關閉連結......");
users.remove(webSocketSession);
}
public void afterConnectionClosed(WebSocketSession webSocketSession, CloseStatus closeStatus) throws Exception {
logger.debug("連結關閉......" + closeStatus.toString());
users.remove(webSocketSession);
}
public boolean supportsPartialMessages() {
return false;
}
/**
* 給所有線上使用者傳送訊息
*
* @param message
*/
public void sendMessageToUsers(TextMessage message) {
for (WebSocketSession user : users) {
System.out.println(user.getAttributes().get("WEBSOCKET_USERNAME"));
try {
if (user.isOpen()) {
user.sendMessage(message);
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
* 給某個使用者傳送訊息，模擬給admin發信息
*
* @param userName
* @param message
*/
public void sendMessageToUser(String userName, TextMessage message) {
for (WebSocketSession user : users) {
System.out.println("從session裡面獲取的id"+user.getAttributes().get("WEBSOCKET_USERNAME"));
if (user.getAttributes().get("WEBSOCKET_USERNAME").equals("admin")) {
try {
if (user.isOpen()) {
user.sendMessage(message);
}
} catch (IOException e) {
e.printStackTrace();
}
break;
}
}
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
啟動專案：
我做了一個模擬，用倆個使用者登入，讓其中一個使用者發訊息，另外一個使用者接受到訊息。所以在我HandshakeInterceptor 用session去使用者的登入名使用者定向傳送訊息。(可以自己寫一個login的controller,然後把loginName存入的session中，這樣HandshakeInterceptor 中才能取到name值。)
我分別用360瀏覽器和火狐瀏覽器，模擬倆個登入使用者，admin和tea
由tea向admin傳送訊息
