SpringBoot集成WebSokcet代码步骤

更新时间：2026年01月16日 10:39:01 作者：盹猫

Spring Boot是一个流行的Java框架,用于快速构建Spring应用程序,WebSocket是一种实现实时通信的协议,与HTTP协议结合使用,可以提供全双工通信,这篇文章主要介绍了SpringBoot集成WebSokcet代码步骤

前言

在Web开发时，有时我们需要一些实时性比较高的数据反馈，如设备监测、系统监测、聊天等，这时使用HTTP显然是不适合的，这时就需要用到WebSocket通过单次连接来获取长时间的数据获取。

什么是websocket?

WebSocket 是一种在单个 TCP 连接上实现全双工（双向）通信的网络协议，由 HTML5 规范定义，旨在它允许客户端（如浏览器）和服务器之间建立持久连接，双方可以随时向对方发送数据，而无需像 HTTP 那样每次通信都重新建立连接。

本篇文章就是记录SpringBoot如何集成WebSocket功能，废话不多说，让我们开始吧～

环境准备

因为要使用websocket,所以在除了集成基础的spring-boot-starter-web 依赖以外，还要集成

spring-boot-starter-websocket 以获得Websocket支持。

Pom.xml

<properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
        <!--Web依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--WebSocket依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
            <version>2.3.12.RELEASE</version>
        </dependency>
</dependencies>

代码步骤

配置websocket节点

在配置类里，我们需要新建一个ServerEndpointExporter 并交给SpringBoot管理，即可开启WebSocket节点功能，内容如下：

@Configuration
public class WebSocketConfig {
    /**
     * 注入ServerEndpointExporter，
     * 这个bean会自动注册使用了@ServerEndpoint注解声明的Websocket endpoint
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

创建Websocket节点

首先需要在需使用到的WebSocket类上添加@ServerEndpoint(path,config) 以标记该类会作为一个websokcet的节点类，其中

path：该节点的访问路径
config: 可以做一些额外配置，如该节点的访问权限校验。

如下：

@Component
@Slf4j
@ServerEndpoint(value = "/detail", configurator = WebSocketAuthConfig.class)
public class DetailServer {}

下面就可以在该类中以事件标注的方式定义我们的方法，可以使用以下注解：

@OnOpen ：在有新的连接接入时，触发方法。
@OnMessage: 当有新的消息时，触发方法。
@OnError：当发生错误时，触发方法。
@OnClose：当连接断开时，触发方法。

例如下面的方法定义：

    @OnOpen
    public void onOpen(Session session) {
        //这里一般会存储会话。
        log.info("【websocket消息】有新的连接");
    }

    /**
     * 链接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        //这里会移除会话。
        log.info("【websocket消息】连接断开");
    }

    @OnMessage
    public void onMessage(String message) {
        log.info("【websocket消息】收到客户端消息:" + message);
    }

    @OnError
    public void onError(Session session, Throwable error) {
        log.error("用户错误,原因:" + error.getMessage());
    }

一般会创建一个用于存储当前当前Session的Map，用于会话的管理，并可以通过

session.getAsyncRemote().sendText(message);

将message数据发送到已连接的前端页面。

授权验证

当然不能允许所有人连接我们定义的WebSokcet节点，我们可以通过继承ServerEndpointConfig.Configurator 来对节点进行配置，一般可以用于添加请求配置或进行授权认证，如下实现了一个Jwt的token验证：

@Slf4j
public class WebSocketAuthConfig extends ServerEndpointConfig.Configurator {

    /**
     * DES:[拦截websocket的请求头,并验证]
     *
     * @param originHeaderValue 请求头
     * @return boolean
     * @link [java.lang.String]
     */
    @Override
    public boolean checkOrigin(final String originHeaderValue) {
        final ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        try {
            assert servletRequestAttributes != null;
            /*
              此处使用反射的方式获取对象,无法@AutoWiredW自动注入
             */
            final JwtUtil jwtUtil = SpringUtil.getBean(JwtUtil.class);
            HttpServletResponse response = servletRequestAttributes.getResponse();
            HttpServletRequest request = servletRequestAttributes.getRequest();
            //获取并验证请求参数中的token参数            
final String token = servletRequestAttributes.getRequest().getParameter("token");
            final Claims claims = jwtUtil.getClaimsByToken(token);
            if (ObjectUtil.isNull(claims)) {
                /*
                  Token验证失败,拒绝链接
                 */
                log.info("Token错误,拒绝连接......");
                request.getSession().setAttribute("loginFill",true);
                return  false;
            }else {
                request.getSession().setAttribute("loginFill",false);
            }
        } catch (final Exception e) {
            log.error("WebSocket-auth-error", e);
        }

        return true;
    }
}

当然这里也可以通过Shiro的根据路径配置拦截请求，这里也是支持的，这样ServerEndpointConfig.Configurator就可以不用单独配置。

总结

通过上述方式，就可以建立一个比较完善的WebSocket节点，在实际开发过程中可以解决一些实时性要求较高的数据传输。当然，实现WebSocket并不只是有这一种方式，也可以通过Netty框架去自己实现，这样在高并发系统下的效率会更高。

到此这篇关于SpringBoot集成WebSokcet的文章就介绍到这了,更多相关SpringBoot集成WebSokcet内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

基于SpringBoot与AES实现接口响应数据加密的代码示例
最近项目中为了保证数据安全,要求接口对关键响应数据,比如敏感信息（如用户信息、权限数据、业务关键内容等）必须加密传输,所以,本文将围绕一个实际的SpringBoot应用场景,基于Hutool工具包中的AES加密能力,封装一个接口响应数据自动加密的解决方案
2025-08-08
详解如何使用MyBatis简化JDBC开发
JavaEE 企业级 Java 项目中的经典三层架构为表现层，业务层和持久层.MyBatis 对 JDBC 代码进行了封装，作为一款优秀的持久层框架，专门用于简化JDBC开发.本文主要介绍一下如何使用MyBatis简化JDBC开发，需要的可以参考一下
2023-01-01
Java实时日志输出至前台的实现步骤
在Java应用程序中实现将实时日志输出至前台（如Web页面或桌面应用程序）,通常涉及到几个关键组件和技术的选择,下面将详细介绍如何使用Java实现实时日志输出至前台,并结合具体的实现技术和框架来说明,需要的朋友可以参考下
2025-10-10
java解析sina视频
本文介绍了一个java解析sina视频地址的例子，从这个例子中可以学习到java使用sax解析xml的方法，大家可以参考修改成其它功能
2014-01-01
idea搭建SSM框架遇踩的坑(附完整过程)
最近准备搭建一个SSM框架,由于很久没有搭建了,一来就遇到各种问题,折腾了一天终于搞定了,特此记录一下遇到的问题,下面这篇文章主要给大家介绍了关于idea搭建SSM框架遇踩的坑,文中还附完整过程,需要的朋友可以参考下
2023-04-04
Spring boot中mongodb的使用
MongoDB是最早热门非关系数据库的之一，使用也比较普遍，一般会用做离线数据分析来使用，放到内网的居多。这篇文章主要介绍了Spring boot中mongodb的使用,需要的朋友可以参考下
2017-05-05
MyBatis加载映射文件和动态代理的实现
本文主要介绍了MyBatis加载映射文件和动态代理的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-05-05
Java的常见批量操作方法及注意事项
Java作为一种强大的编程语言,提供了多种方法来有效地进行批量数据处理,这篇文章主要介绍了Java的常见批量操作方法及注意事项的相关资料,需要的朋友可以参考下
2025-06-06
springboot发送request请求的方式小结
在Java中,发送HTTP请求是常见需求,hutool工具包和RestTemplate类是实现此功能的两种主流方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2024-09-09
Java中枚举类的用法示例详解
枚举类型可以取代以往常量的定义方式，即将常量封装在类或接口中。此外，枚举类型还提供了安全检查功能。本文就来和大家讲讲Java中枚举类的用法，需要的可以参考一下
2022-07-07