Spring Boot 的 WebSocketSession 是什么意思，原理，使用

Spring Boot 中的 WebSocketSession 是什么，原理，如何使用

介绍

在现代 Web 应用程序中，实时通信是一个非常常见的需求。传统的 HTTP 协议是无法支持实时通信的，因为它是一种无状态协议，每次请求都是独立的，无法保持连接。为了解决这个问题，WebSocket 协议被引入。WebSocket 协议是一种双向通信协议，它允许服务器和客户端之间建立持久连接，实现实时通信。

Spring Boot 是一个非常流行的 Java Web 框架，它提供了对 WebSocket 的支持。Spring Boot 的 WebSocket 模块提供了一组用于构建 WebSocket 应用程序的 API 和工具，其中 WebSocketSession 是其中一个核心概念。

本文将介绍 WebSocketSession 的概念、原理和使用方法。

WebSocketSession 概念

WebSocketSession 是一个 WebSocket 连接的会话对象。每当客户端与服务器建立一个 WebSocket 连接时，服务器都会创建一个新的 WebSocketSession 对象。WebSocketSession 对象代表了服务器和客户端之间的一个持久连接，可以用来发送和接收消息。

WebSocketSession 接口定义了一组用于与客户端进行通信的方法。这些方法包括：

• void sendMessage(TextMessage message)：发送文本消息。
• void sendMessage(BinaryMessage message)：发送二进制消息。
• void sendMessage(PongMessage message)：发送 Pong 消息。
• void close()：关闭 WebSocket 连接。
• boolean isOpen()：检查 WebSocket 连接是否打开。

WebSocketSession 还提供了一些其他的方法，例如获取会话 ID、获取远程地址等。

WebSocketSession 原理

在使用 WebSocketSession 之前，我们需要了解一些 WebSocket 的原理。

WebSocket 协议是一个基于 HTTP 的协议。在客户端和服务器建立 WebSocket 连接之前，客户端和服务器之间首先要建立一个普通的 HTTP 连接。当客户端发送一个包含 WebSocket 握手信息的 HTTP 请求时，服务器会将其升级为 WebSocket 连接。在升级完成后，客户端和服务器之间的通信就变成了基于 WebSocket 协议的双向通信。

在 Spring Boot 中，使用 WebSocketSession 进行通信的过程与上述原理类似。当客户端和服务器建立 WebSocket 连接时，服务器会创建一个新的 WebSocketSession 对象。客户端和服务器之间的通信就是通过这个 WebSocketSession 对象进行的。

WebSocketSession 使用

在 Spring Boot 中使用 WebSocketSession 需要进行以下步骤：

添加依赖

首先，我们需要在项目中添加 Spring Boot 的 WebSocket 依赖。在 Maven 中，可以通过以下方式添加依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

配置 WebSocket

接下来，我们需要配置 WebSocket。在 Spring Boot 中，可以通过实现 WebSocketConfigurer 接口来配置 WebSocket。WebSocketConfigurer 接口定义了一个 configureWebSocket 方法，我们可以在这个方法中注册 WebSocket 处理器和拦截器。

下面是一个示例 WebSocketConfigurer 的实现：

@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();
    }
}

在上面的示例中，我们实现了 WebSocketConfigurer 接口，并注册了一个 WebSocket 处理器。在 registerWebSocketHandlers 方法中，我们调用了 addHandler 方法来注册 WebSocket 处理器，并指定了 WebSocket 的路径。在这个示例中，WebSocket 的路径是 “/websocket”。setAllowedOrigins 方法用于设置允许的来源，这里设置为 “*” 表示允许所有来源。

实现 WebSocket 处理器

接下来，我们需要实现 WebSocket 处理器。WebSocket 处理器负责处理客户端发送的消息，并向客户端发送响应消息。在 Spring Boot 中，可以通过实现 WebSocketHandler 接口来实现 WebSocket 处理器。

下面是一个示例 WebSocketHandler 的实现：

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;
    }
}

在上面的示例中，我们实现了 WebSocketHandler 接口，并重写了其中的几个方法。afterConnectionEstablished 方法在建立 WebSocket 连接后被调用，可以在这个方法中进行一些初始化操作。handleMessage 方法用于处理客户端发送的消息，并向客户端发送响应消息。handleTransportError 方法在 WebSocket 传输发生错误时被调用。afterConnectionClosed 方法在 WebSocket 连接关闭后被调用，可以在这个方法中进行一些清理操作。supportsPartialMessages 方法用于设置是否支持部分消息传输。

使用 WebSocketSession

使用 WebSocketSession 进行通信非常简单。在 WebSocket 处理器中，可以将 WebSocketSession 对象保存下来，并在需要发送消息时使用它。下面是一个示例：

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;
    }
}

在上面的示例中，我们将所有连接到服务器的 WebSocketSession 对象保存到一个列表中。在 handleMessage 方法中，我们遍历这个列表，并向所有客户端发送响应消息。

客户端使用 WebSocketSession

在客户端使用 WebSocketSession 也非常简单。下面是一个示例：

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);
};

在上面的示例中，我们创建了一个 WebSocket 对象，并指定了 WebSocket 的路径。在 onopen 方法中，我们发送了一个消息。在 onmessage 方法中，我们处理服务器发送的响应消息。在 onclose 方法中，我们处理 WebSocket 连接关闭事件。

总结

WebSocketSession 是 Spring Boot 中用于与客户端进行 WebSocket 通信的核心概念。在使用 WebSocketSession 时，我们需要先添加 Spring Boot 的 WebSocket 依赖，然后配置 WebSocket，并实现一个 WebSocket 处理器，最后在处理器中使用 WebSocketSession 进行通信。客户端也可以使用 WebSocketSession 进行通信，非常简单。

总的来说，WebSocketSession 是实现 WebSocket 通信的关键。它提供了一组用于与客户端进行通信的方法，可以用来发送和接收消息。在 Spring Boot 中，使用 WebSocketSession 进行通信非常方便，只需要实现一个 WebSocket 处理器，并使用 WebSocketSession 进行通信即可。

代码示例：

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);
};

参考文献

• 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

这篇好文章是转载于：学新通技术网