WebSocket 集成 Spring Boot 的实战指南-CFANZ编程社区

🍁 作者：知识浅谈，CSDN签约讲师&博客专家，华为云云享专家，阿里云专家博主，InfoQ签约作者 📌 擅长领域：全栈工程师、爬虫、ACM算法，大数据，深度学习 💒 公众号：知识浅谈

(🤞WebSocket 集成 Spring Boot 的实战指南🤞) 在现代web应用中，实时数据交互变得日益重要。WebSocket 提供了一种在单个TCP连接上进行全双工通讯的协议，它使得客户端和服务器之间的数据交换变得更加简单和高效。Spring Boot 作为当前最流行的Java开发框架之一，提供了对WebSocket的良好支持。本文将详细介绍如何在Spring Boot项目中集成和使用WebSocket。

🎈引入依赖

首先，你需要在Spring Boot项目的pom.xml中添加WebSocket的依赖。Spring Boot提供了spring-boot-starter-websocket来简化WebSocket的集成。

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

🎈配置WebSocket

接下来，你需要配置WebSocket。在Spring Boot中，这通常是通过实现WebSocketConfigurer接口或者继承WebSocketConfigurerAdapter类（注意：在Spring 5及更高版本中，WebSocketConfigurerAdapter已被标记为过时，建议直接实现WebSocketConfigurer接口）来完成的。

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(myHandler(), /websocket).setAllowedOrigins(*);
    }

    @Bean
    public WebSocketHandler myHandler() {
        return new MyWebSocketHandler();
    }
}

在这个配置中，我们定义了一个WebSocket端点/websocket，并关联了一个WebSocketHandler实现类MyWebSocketHandler。setAllowedOrigins("*")用于设置允许的跨域请求来源，实际开发中请根据需要调整。

🎈实现WebSocketHandler

WebSocketHandler是处理WebSocket消息的关键接口。你需要实现这个接口来定义如何处理文本消息、二进制消息、连接打开、连接关闭等事件。

public class MyWebSocketHandler extends TextWebSocketHandler {

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        System.out.println(Received:  + message.getPayload());
        // 可以向客户端发送消息
        session.sendMessage(new TextMessage(Hello from server!));
    }

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        System.out.println(New connection:  + session.getId());
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        System.out.println(Connection closed:  + session.getId());
    }

    @Override
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        System.out.println(Transport error:  + session.getId());
        exception.printStackTrace();
    }
}

🎈客户端实现

WebSocket的客户端实现可以根据你的前端技术栈来选择，比如JavaScript、React、Vue等。以下是一个简单的JavaScript WebSocket客户端示例。

var ws = new WebSocket('ws://localhost:8080/websocket');

ws.onopen = function(event) {
    console.log('Connected to server');
    ws.send('Hello from client!');
};

ws.onmessage = function(event) {
    console.log('Received from server: ' + event.data);
};

ws.onclose = function(event) {
    console.log('Disconnected from server');
};

ws.onerror = function(error) {
    console.error('WebSocket Error: ' + error);
};

🎈测试

启动Spring Boot应用，并在浏览器中打开包含上述JavaScript代码的HTML文件。你应该能在控制台看到连接建立、消息发送和接收的日志。

🍚总结

通过以上步骤，你可以在Spring Boot项目中成功集成WebSocket，实现客户端和服务器之间的实时通信。WebSocket的强大功能可以帮助你构建更加动态和响应迅速的web应用。不过，请注意在生产环境中，你还需要考虑WebSocket的安全性、错误处理、连接管理等更多细节。

大功告成，撒花致谢🎆🎇🌟，关注我不迷路，带你起飞带你富。 Writted By 知识浅谈