SpringBoot如何使用WebSocket详解含示例代码（值得珍藏）

点击下载《SpringBoot如何使用WebSocket详解含示例代码（值得珍藏）》

1. 前言

随着Web技术的发展，实时通信已成为许多应用的重要需求。WebSocket为Web应用程序提供了一种在单个TCP连接上进行全双工通信的方式。Spring Boot框架为开发者提供了集成WebSocket的便利性。本文将详细介绍如何在Spring Boot项目中设置和使用WebSocket。

2. WebSocket介绍

WebSocket通信协议于2011年被IETF定为标准RFC 6455，并由RFC7936补充规范。WebSocket API也被W3C定为标准。

WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

具体来说，WebSocket的建立过程如下：

1. 客户端发起一个HTTP请求到服务器，请求中包含支持的WebSocket协议版本等信息，如Upgrade、Connection、WebSocket-Version等。
2. 服务器收到客户端的握手请求后，同样采用HTTP协议回馈数据给客户端，此时的内容主要也是关于WebSocket的协议版本等信息。
3. 客户端收到服务器回应的HTTP消息后，开始借助于TCP传输信道进行全双工通信。

在WebSocket建立之后，真正传输数据时是不需要HTTP协议的，而是通过WebSocket协议进行传输。

WebSocket为Web应用程序提供了一种实时、双向的通信通道。与HTTP的请求-响应模式不同，WebSocket允许服务器主动推送信息给客户端，从而极大地提高了应用程序的实时性和交互性。Spring Boot框架为开发者提供了简洁的方式来集成WebSocket。

3. Spring Boot与WebSocket集成

3.1 添加依赖

在Spring Boot项目中，首先需要在pom.xml中添加WebSocket的依赖：

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

3.2 创建WebSocket服务端

1、创建一个Java类，并使用@ServerEndpoint注解。

import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.concurrent.atomic.AtomicInteger;

@ServerEndpoint("/websocket")
public class SimpleWebSocketServer {

    // 使用CopyOnWriteArraySet是为了线程安全地存储所有连接的客户端。
    private static final Set<Session> clients = new CopyOnWriteArraySet<>();
    private static final AtomicInteger counter = new AtomicInteger();

    //处理客户端连接事件
    @OnOpen
    public void onOpen(Session session) {
        System.out.println("Client connected: " + session.getId());
        clients.add(session);
        sendMessageToAll("New client connected: " + session.getId());
    }

    //处理客户端发送的消息
    @OnMessage
    public void onMessage(String message, Session session) throws IOException {
        System.out.println("Received message: " + message + " from " + session.getId());
        sendMessageToAll("Message received: " + message);
    }

    //处理客户端断开事件
    @OnClose
    public void onClose(Session session) {
        System.out.println("Client disconnected: " + session.getId());
        clients.remove(session);
        sendMessageToAll("Client disconnected: " + session.getId());
    }

    @OnError
    public void onError(Throwable error) {
        System.err.println("Error occurred: " + error.getMessage());
    }

    //发送消息到客户端
    private void sendMessageToAll(String message) {
        try {
            for (Session client : clients) {
                if (client != null && client.isOpen()) {
                    client.getBasicRemote().sendText(message);
                }
            }
        } catch (Exception ex) {
            System.err.println("Exception occurred: " + error.getMessage());
        }
    }
}

2、启用WebSocket支持

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

/**
 * 开启WebSocket支持
 */
@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }

    @Bean
    public RestTemplate restTemplate(){
        return new RestTemplate();
    }
}

3.3 JavaScript连接WebSocket

使用JavaScript创建与SimpleWebSocketServer的WebSocket连接，首先需要引入WebSocket API。然后，可以创建一个新的WebSocket实例并连接到服务器。

以下是一个简单的示例：

// 引入WebSocket API  
const WebSocket = require('ws');  
  
// 创建WebSocket实例并连接到服务器  
const ws = new WebSocket('ws://your-server-address/websocket');  
  
// 监听连接打开事件  
ws.on('open', () => {  
    console.log('Connected to the WebSocket server.');  
});  
  
// 监听接收消息事件  
ws.on('message', (message) => {  
    console.log('Received message:', message);  
});  
  
// 发送消息给服务器  
function sendMessageToServer(message) {  
    ws.send(message);  
}

在这个示例中，我们首先引入了WebSocket API。然后，我们创建了一个新的WebSocket实例并连接到服务器。我们监听了open事件，当连接打开时，会在控制台输出一条消息。我们还监听了message事件，当从服务器接收到消息时，会在控制台输出这条消息。最后，我们定义了一个sendMessageToServer函数，该函数通过WebSocket连接发送消息给服务器。

4. 总结

通过以上步骤，我们成功地在Spring Boot项目中集成了WebSocket。开发者可以方便地实现实时、双向的通信，这对于构建实时应用、在线游戏、聊天室等场景非常有用。需要注意的是，尽管WebSocket提供了全双工通信，但也需要考虑数据量、网络延迟等因素对实时性的影响。同时，由于WebSocket是建立在TCP连接上的，所以也需要处理网络中断、重新连接等异常情况。

点击下载《SpringBoot如何使用WebSocket详解含示例代码（值得珍藏）》