Spring Boot 中的 WebSocketSession 是什么，原理，如何使用
介紹
在現(xiàn)代 Web 應(yīng)用程序中，實(shí)時(shí)通信是一個(gè)非常常見(jiàn)的需求。傳統(tǒng)的 HTTP 協(xié)議是無(wú)法支持實(shí)時(shí)通信的，因?yàn)樗且环N無(wú)狀態(tài)協(xié)議，每次請(qǐng)求都是獨(dú)立的，無(wú)法保持連接。為了解決這個(gè)問(wèn)題，WebSocket 協(xié)議被引入。WebSocket 協(xié)議是一種雙向通信協(xié)議，它允許服務(wù)器和客戶端之間建立持久連接，實(shí)現(xiàn)實(shí)時(shí)通信。
Spring Boot 是一個(gè)非常流行的 Java Web 框架，它提供了對(duì) WebSocket 的支持。Spring Boot 的 WebSocket 模塊提供了一組用于構(gòu)建 WebSocket 應(yīng)用程序的 API 和工具，其中 WebSocketSession 是其中一個(gè)核心概念。
本文將介紹 WebSocketSession 的概念、原理和使用方法。
WebSocketSession 概念
WebSocketSession 是一個(gè) WebSocket 連接的會(huì)話對(duì)象。每當(dāng)客戶端與服務(wù)器建立一個(gè) WebSocket 連接時(shí)，服務(wù)器都會(huì)創(chuàng)建一個(gè)新的 WebSocketSession 對(duì)象。WebSocketSession 對(duì)象代表了服務(wù)器和客戶端之間的一個(gè)持久連接，可以用來(lái)發(fā)送和接收消息。
WebSocketSession 接口定義了一組用于與客戶端進(jìn)行通信的方法。這些方法包括：
-
void sendMessage(TextMessage message)：發(fā)送文本消息。 -
void sendMessage(BinaryMessage message)：發(fā)送二進(jìn)制消息。 -
void sendMessage(PongMessage message)：發(fā)送 Pong 消息。 -
void close()：關(guān)閉 WebSocket 連接。 -
boolean isOpen()：檢查 WebSocket 連接是否打開(kāi)。
WebSocketSession 還提供了一些其他的方法，例如獲取會(huì)話 ID、獲取遠(yuǎn)程地址等。
WebSocketSession 原理
在使用 WebSocketSession 之前，我們需要了解一些 WebSocket 的原理。
WebSocket 協(xié)議是一個(gè)基于 HTTP 的協(xié)議。在客戶端和服務(wù)器建立 WebSocket 連接之前，客戶端和服務(wù)器之間首先要建立一個(gè)普通的 HTTP 連接。當(dāng)客戶端發(fā)送一個(gè)包含 WebSocket 握手信息的 HTTP 請(qǐng)求時(shí)，服務(wù)器會(huì)將其升級(jí)為 WebSocket 連接。在升級(jí)完成后，客戶端和服務(wù)器之間的通信就變成了基于 WebSocket 協(xié)議的雙向通信。
在 Spring Boot 中，使用 WebSocketSession 進(jìn)行通信的過(guò)程與上述原理類似。當(dāng)客戶端和服務(wù)器建立 WebSocket 連接時(shí)，服務(wù)器會(huì)創(chuàng)建一個(gè)新的 WebSocketSession 對(duì)象?？蛻舳撕头?wù)器之間的通信就是通過(guò)這個(gè) WebSocketSession 對(duì)象進(jìn)行的。
WebSocketSession 使用
在 Spring Boot 中使用 WebSocketSession 需要進(jìn)行以下步驟：
添加依賴
首先，我們需要在項(xiàng)目中添加 Spring Boot 的 WebSocket 依賴。在 Maven 中，可以通過(guò)以下方式添加依賴：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
配置 WebSocket
接下來(lái)，我們需要配置 WebSocket。在 Spring Boot 中，可以通過(guò)實(shí)現(xiàn) WebSocketConfigurer 接口來(lái)配置 WebSocket。WebSocketConfigurer 接口定義了一個(gè) configureWebSocket 方法，我們可以在這個(gè)方法中注冊(cè) WebSocket 處理器和攔截器。
下面是一個(gè)示例 WebSocketConfigurer 的實(shí)現(xiàn)：
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
registry.addHandler(webSocketHandler(), "/websocket")
.setAllowedOrigins("*");
}
@Bean
public WebSocketHandler webSocketHandler() {
return new CustomWebSocketHandler();
}
}
在上面的示例中，我們實(shí)現(xiàn)了 WebSocketConfigurer 接口，并注冊(cè)了一個(gè) WebSocket 處理器。在 registerWebSocketHandlers 方法中，我們調(diào)用了 addHandler 方法來(lái)注冊(cè) WebSocket 處理器，并指定了 WebSocket 的路徑。在這個(gè)示例中，WebSocket 的路徑是 “/websocket”。setAllowedOrigins 方法用于設(shè)置允許的來(lái)源，這里設(shè)置為 “*” 表示允許所有來(lái)源。
實(shí)現(xiàn) WebSocket 處理器
接下來(lái)，我們需要實(shí)現(xiàn) WebSocket 處理器。WebSocket 處理器負(fù)責(zé)處理客戶端發(fā)送的消息，并向客戶端發(fā)送響應(yīng)消息。在 Spring Boot 中，可以通過(guò)實(shí)現(xiàn) WebSocketHandler 接口來(lái)實(shí)現(xiàn) WebSocket 處理器。
下面是一個(gè)示例 WebSocketHandler 的實(shí)現(xiàn)：
public class CustomWebSocketHandler implements WebSocketHandler {
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
System.out.println("WebSocket connection established: " + session.getId());
}
@Override
public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
System.out.println("Received message: " + message.getPayload());
session.sendMessage(new TextMessage("Hello, " + message.getPayload() + "!"));
}
@Override
public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
System.out.println("WebSocket transport error: " + exception.getMessage());
}
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
System.out.println("WebSocket connection closed: " + closeStatus.getCode() + " - " + closeStatus.getReason());
}
@Override
public boolean supportsPartialMessages() {
return false;
}
}
在上面的示例中，我們實(shí)現(xiàn)了 WebSocketHandler 接口，并重寫了其中的幾個(gè)方法。afterConnectionEstablished 方法在建立 WebSocket 連接后被調(diào)用，可以在這個(gè)方法中進(jìn)行一些初始化操作。handleMessage 方法用于處理客戶端發(fā)送的消息，并向客戶端發(fā)送響應(yīng)消息。handleTransportError 方法在 WebSocket 傳輸發(fā)生錯(cuò)誤時(shí)被調(diào)用。afterConnectionClosed 方法在 WebSocket 連接關(guān)閉后被調(diào)用，可以在這個(gè)方法中進(jìn)行一些清理操作。supportsPartialMessages 方法用于設(shè)置是否支持部分消息傳輸。
使用 WebSocketSession
使用 WebSocketSession 進(jìn)行通信非常簡(jiǎn)單。在 WebSocket 處理器中，可以將 WebSocketSession 對(duì)象保存下來(lái)，并在需要發(fā)送消息時(shí)使用它。下面是一個(gè)示例：
public class CustomWebSocketHandler implements WebSocketHandler {
private List<WebSocketSession> sessions = new CopyOnWriteArrayList<>();
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
System.out.println("WebSocket connection established: " + session.getId());
sessions.add(session);
}
@Override
public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
System.out.println("Received message: " + message.getPayload());
for (WebSocketSession s : sessions) {
if (s.isOpen()) {
s.sendMessage(new TextMessage("Hello, " + message.getPayload() + "!"));
}
}
}
@Override
public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
System.out.println("WebSocket transport error: " + exception.getMessage());
}
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
System.out.println("WebSocket connection closed: " + closeStatus.getCode() + " - " + closeStatus.getReason());
sessions.remove(session);
}
@Override
public boolean supportsPartialMessages() {
return false;
}
}
在上面的示例中，我們將所有連接到服務(wù)器的 WebSocketSession 對(duì)象保存到一個(gè)列表中。在 handleMessage 方法中，我們遍歷這個(gè)列表，并向所有客戶端發(fā)送響應(yīng)消息。
客戶端使用 WebSocketSession
在客戶端使用 WebSocketSession 也非常簡(jiǎn)單。下面是一個(gè)示例：
var socket = new WebSocket("ws://localhost:8080/websocket");
socket.onopen = function(event) {
console.log("WebSocket connection established");
socket.send("World");
};
socket.onmessage = function(event) {
console.log("Received message: " + event.data);
};
socket.onclose = function(event) {
console.log("WebSocket connection closed: " + event.code + " - " + event.reason);
};
在上面的示例中，我們創(chuàng)建了一個(gè) WebSocket 對(duì)象，并指定了 WebSocket 的路徑。在 onopen 方法中，我們發(fā)送了一個(gè)消息。在 onmessage 方法中，我們處理服務(wù)器發(fā)送的響應(yīng)消息。在 onclose 方法中，我們處理 WebSocket 連接關(guān)閉事件。
總結(jié)
WebSocketSession 是 Spring Boot 中用于與客戶端進(jìn)行 WebSocket 通信的核心概念。在使用 WebSocketSession 時(shí)，我們需要先添加 Spring Boot 的 WebSocket 依賴，然后配置 WebSocket，并實(shí)現(xiàn)一個(gè) WebSocket 處理器，最后在處理器中使用 WebSocketSession 進(jìn)行通信。客戶端也可以使用 WebSocketSession 進(jìn)行通信，非常簡(jiǎn)單。
總的來(lái)說(shuō)，WebSocketSession 是實(shí)現(xiàn) WebSocket 通信的關(guān)鍵。它提供了一組用于與客戶端進(jìn)行通信的方法，可以用來(lái)發(fā)送和接收消息。在 Spring Boot 中，使用 WebSocketSession 進(jìn)行通信非常方便，只需要實(shí)現(xiàn)一個(gè) WebSocket 處理器，并使用 WebSocketSession 進(jìn)行通信即可。文章來(lái)源：http://www.zghlxwxcb.cn/news/detail-654361.html
代碼示例：文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-654361.html
WebSocket 處理器
public class CustomWebSocketHandler implements WebSocketHandler {
private List<WebSocketSession> sessions = new CopyOnWriteArrayList<>();
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
System.out.println("WebSocket connection established: " + session.getId());
sessions.add(session);
}
@Override
public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
System.out.println("Received message: " + message.getPayload());
for (WebSocketSession s : sessions) {
if (s.isOpen()) {
s.sendMessage(new TextMessage("Hello, " + message.getPayload() + "!"));
}
}
}
@Override
public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
System.out.println("WebSocket transport error: " + exception.getMessage());
}
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
System.out.println("WebSocket connection closed: " + closeStatus.getCode() + " - " + closeStatus.getReason());
sessions.remove(session);
}
@Override
public boolean supportsPartialMessages() {
return false;
}
}
WebSocket 配置器
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
registry.addHandler(webSocketHandler(), "/websocket")
.setAllowedOrigins("*");
}
@Bean
public WebSocketHandler webSocketHandler() {
return new CustomWebSocketHandler();
}
}
客戶端代碼
var socket = new WebSocket("ws://localhost:8080/websocket");
socket.onopen = function(event) {
console.log("WebSocket connection established");
socket.send("World");
};
socket.onmessage = function(event) {
console.log("Received message: " + event.data);
};
socket.onclose = function(event) {
console.log("WebSocket connection closed: " + event.code + " - " + event.reason);
};
參考文獻(xiàn)
- Spring Boot Reference Guide: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-websockets
- WebSocket Protocol Specification: https://tools.ietf.org/html/rfc6455
到了這里，關(guān)于Spring Boot 中的 WebSocketSession 是什么，原理，如何使用的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
