Spring Boot中的WebSocket实现：构建实时、双向通信的高效应用！

🏆本文收录于「滚雪球学SpringBoot」专栏(全网一个名)，手把手带你零基础入门Spring Boot，从入门到就业，助你早日登顶实现财富自由🚀；同时，欢迎大家关注&&收藏&&订阅！持续更新中，up！up！up！！

环境说明：Windows 10 + IntelliJ IDEA 2021.3.2 + Jdk 1.8

前言：WebSocket在现代应用中的应用与挑战

随着实时应用需求的增长，传统的HTTP协议逐渐暴露出其在实时通信方面的局限性。尤其是在需要频繁交互的数据驱动型应用中，HTTP的请求/响应模型显得笨重，无法高效地进行实时数据交换。WebSocket协议应运而生，它使得浏览器和服务器之间能够建立持久的连接，进行双向实时通信，突破了HTTP协议的局限性。

WebSocket在聊天应用、在线游戏、股票实时行情、在线协作工具等场景中有着广泛的应用。在Spring Boot中，WebSocket的实现也是非常简单且高效的。本篇文章将带你一起深入了解如何在Spring Boot中实现WebSocket，涵盖从基本的配置到消息推送、广播、与Spring Security集成等内容。通过本篇文章，你将能够掌握如何利用WebSocket协议为你的应用提供实时、双向通信功能！🚀

一、WebSocket概述与应用场景

1.1 什么是WebSocket？

WebSocket是一个在单个TCP连接上进行全双工通信的协议。与传统的HTTP协议相比，WebSocket协议允许客户端和服务器之间建立持久的连接，在该连接上，双方可以相互发送消息，直到连接被关闭。WebSocket协议的特点包括：

• 双向通信：客户端和服务器都可以随时向对方发送数据。
• 低延迟：建立连接后，数据传输几乎没有延迟。
• 节省带宽：WebSocket协议通过保持长连接，避免了频繁的连接和断开，从而减少了带宽消耗。
• 实时性：WebSocket协议非常适合需要实时交互的应用场景。

1.2 WebSocket的应用场景

WebSocket的实时性和双向通信特性使其广泛应用于以下场景：

1. 聊天应用：实时的消息传递是聊天应用的核心，WebSocket为聊天系统提供了快速、低延迟的通信能力。
2. 在线游戏：WebSocket在多人在线游戏中有着广泛的应用，支持实时更新游戏状态，玩家之间能够同步信息。
3. 股票行情与金融应用：金融应用需要实时获取市场的变化信息，WebSocket提供了高效的数据流推送。
4. 协作工具：多人在线协作工具（如文档编辑、白板等）可以通过WebSocket实现即时同步，提升协作体验。
5. 实时监控系统：在监控系统中，WebSocket可用于实时推送状态信息或告警。

二、Spring Boot WebSocket配置

2.1 引入WebSocket依赖

在Spring Boot中，集成WebSocket非常简单。你只需要添加spring-boot-starter-websocket依赖，这个starter会自动为你配置WebSocket所需的基础设施。

2.1.1 添加依赖

在pom.xml中添加WebSocket依赖：

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

通过这个依赖，Spring Boot会自动为我们提供WebSocket的基础配置，包括服务器端和客户端的支持。

2.2 WebSocket配置类

要在Spring Boot中使用WebSocket，你需要创建一个配置类，启用WebSocket支持。Spring提供了@EnableWebSocket注解来开启WebSocket支持。

2.2.1 配置WebSocket端点

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new MyWebSocketHandler(), "/ws").setAllowedOrigins("*");
    }
}

在上面的代码中，我们通过@EnableWebSocket启用WebSocket支持，并通过WebSocketConfigurer接口的registerWebSocketHandlers方法注册了一个WebSocket处理器MyWebSocketHandler，并设置了WebSocket的端点为/ws。同时，我们允许所有的来源进行连接。

2.2.2 WebSocket处理器

WebSocket处理器负责处理客户端的连接、消息传递和关闭操作。我们需要创建一个自定义的WebSocketHandler来处理这些操作。

import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

public class MyWebSocketHandler extends TextWebSocketHandler {

    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 收到消息时的处理逻辑
        System.out.println("Received message: " + message.getPayload());
        session.sendMessage(new TextMessage("Hello, Client!"));
    }

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        // 连接建立后的操作
        System.out.println("New connection established: " + session.getId());
    }
}

MyWebSocketHandler继承了TextWebSocketHandler，实现了handleTextMessage方法来处理接收到的文本消息，并回复客户端一条消息。

三、使用@ServerEndpoint与@OnMessage处理消息

3.1 使用@ServerEndpoint注解

Spring Boot也支持使用@ServerEndpoint注解来定义WebSocket端点，这种方式更符合Java EE的规范，适合用于一些对WebSocket标准有高要求的场景。

3.1.1 创建WebSocket端点

import javax.websocket.OnMessage;
import javax.websocket.server.ServerEndpoint;

@ServerEndpoint("/ws")
public class WebSocketServer {

    @OnMessage
    public String onMessage(String message) {
        System.out.println("Received message: " + message);
        return "Hello, Client!";
    }
}

在这个例子中，@ServerEndpoint("/ws")指定了WebSocket的端点路径，而@OnMessage注解的方法则用于处理接收到的消息。

3.1.2 使用@OnOpen与@OnClose

我们还可以使用@OnOpen和@OnClose注解来处理连接的建立和关闭。

import javax.websocket.OnOpen;
import javax.websocket.OnClose;
import javax.websocket.Session;

@ServerEndpoint("/ws")
public class WebSocketServer {

    @OnOpen
    public void onOpen(Session session) {
        System.out.println("New connection established: " + session.getId());
    }

    @OnClose
    public void onClose(Session session) {
        System.out.println("Connection closed: " + session.getId());
    }
}

通过@OnOpen和@OnClose，我们可以方便地处理WebSocket连接的生命周期。

四、WebSocket消息推送与广播

4.1 消息推送

WebSocket的一个重要特性就是可以实现服务器主动向客户端推送消息。这是WebSocket与传统的HTTP请求/响应模型的一个重要区别。在Spring Boot中，推送消息相对简单，只需要在WebSocketHandler中调用session.sendMessage()方法即可。

4.1.1 单一客户端推送

session.sendMessage(new TextMessage("Hello, Client!"));

通过session.sendMessage()，我们可以向指定的客户端推送消息。

4.2 广播消息

在许多应用场景中，广播消息给所有连接的客户端是非常常见的需求。例如，在聊天室中，所有用户都需要接收到新消息。在Spring Boot中，我们可以通过管理所有连接的WebSocketSession来实现广播。

4.2.1 广播示例

import org.springframework.web.socket.WebSocketSession;
import java.util.Set;

public class WebSocketService {

    private Set<WebSocketSession> sessions;

    public void broadcast(String message) throws Exception {
        for (WebSocketSession session : sessions) {
            if (session.isOpen()) {
                session.sendMessage(new TextMessage(message));
            }
        }
    }
}

在这个例子中，sessions是一个存储所有连接客户端WebSocketSession的集合。通过遍历集合，我们可以向所有客户端推送消息。

五、WebSocket与Spring Security集成

5.1 WebSocket的安全性

WebSocket是基于HTTP协议的，但在建立连接后，客户端与服务器之间的通信不再依赖HTTP，因此，如何保证WebSocket连接的安全性成为一个重要问题。在Spring Boot中，WebSocket与Spring Security的集成可以确保WebSocket连接的安全性。

5.1.1 配置WebSocket安全性

在WebSocket应用中，我们通常需要验证用户的身份，确保只有经过身份验证的用户才能访问WebSocket端点。你可以通过Spring Security配置来实现这一点。

import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
            .antMatchers("/ws/**").authenticated() // 保护WebSocket端点
            .anyRequest().permitAll()
            .and()
            .formLogin();  // 启用表单登录
    }
}

在这个配置中，/ws/**路径下的WebSocket端点被保护，只有经过身份验证的用户才能访问。

5.1.2 使用@PreAuthorize控制访问

如果需要更细粒度的权限控制，可以在WebSocket处理方法上使用@PreAuthorize注解，基于用户角色来控制对WebSocket端点的访问。

import org.springframework.security.access.prepost.PreAuthorize;

@PreAuthorize("hasRole('USER')")
@OnMessage
public String onMessage(String message) {
    return "Authorized message: " + message;
}

通过@PreAuthorize，我们可以确保只有具有特定角色的用户才能访问特定的WebSocket端点。

总结：实时通信的力量与Spring Boot WebSocket的应用

通过本文的学习，我们详细探讨了如何在Spring Boot中实现WebSocket，从基本的配置到消息推送、广播，再到与Spring Security的集成。WebSocket为应用提供了高效的双向通信机制，适用于实时聊天、在线游戏、数据监控等场景。

在Spring Boot中，利用简单的配置和注解，我们可以轻松实现WebSocket通信，为应用增添强大的实时交互能力。通过结合Spring Security，我们还可以确保WebSocket连接的安全性，防止恶意访问。希望本文能够帮助你掌握Spring Boot WebSocket的使用，并将其应用到实际项目中，为用户提供更加流畅的实时体验！

🧧福利赠与你🧧

  无论你是计算机专业的学生，还是对编程有兴趣的小伙伴，都建议直接毫无顾忌的学习此专栏「滚雪球学SpringBoot」专栏(全网一个名)，bug菌郑重承诺，凡是学习此专栏的同学，均能获取到所需的知识和技能，全网最快速入门SpringBoot，就像滚雪球一样，越滚越大， 无边无际，指数级提升。

  最后，如果这篇文章对你有所帮助，帮忙给作者来个一键三连，关注、点赞、收藏，您的支持就是我坚持写作最大的动力。

  同时欢迎大家关注公众号:「猿圈奇妙屋」 ，以便学习更多同类型的技术文章，免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板、技术文章Markdown文档等海量资料。

✨️ Who am I?

我是bug菌(全网一个名)，CSDN | 掘金 | InfoQ | 51CTO | 华为云 | 阿里云 | 腾讯云 等社区博客专家，C站博客之星Top30，华为云多年度十佳博主/价值贡献奖，掘金多年度人气作者Top40，掘金等各大社区平台签约作者，51CTO年度博主Top12，掘金/InfoQ/51CTO等社区优质创作者；全网粉丝合计 30w+；更多精彩福利点击这里；硬核微信公众号「猿圈奇妙屋」，欢迎你的加入！免费白嫖最新BAT互联网公司面试真题、4000G PDF电子书籍、简历模板等海量资料，你想要的我都有，关键是你不来拿。

-End-