Spring Boot集成WebSocket实现实时通信 详细配置步骤【推荐】

夏芳酱_8385

夏芳酱_8385

2026-05-27

1028人浏览

原创

推荐用@serverendpoint方式——它直连servlet容器、响应快、线程隔离,适合设备直连等场景;但需配serverendpointexporter且路径须绝对,禁与websockethandler混用。

spring boot集成websocket实现实时通信 详细配置步骤【推荐】

Spring Boot集成WebSocket,**推荐用@ServerEndpoint方式**——它上手快、路径直、不依赖Spring MVC请求生命周期,特别适合设备直连、轻量通知、后台服务间通信等场景。但前提是别把它和WebSocketHandler混着配,否则会注册失败、连接404、甚至启动报错。

为什么@ServerEndpoint方式更推荐?

它直接走Servlet容器(如Tomcat)原生WebSocket运行时,绕过Spring的DispatcherServlet,响应更快、资源开销更低。尤其在物联网设备直连、高频心跳、低延迟推送等场景下,没有Spring拦截链路的干扰,稳定性更高。

关键点在于:@ServerEndpoint类是每个连接新建一个实例,天然线程隔离;而WebSocketHandler是单例,所有连接共用一个对象,共享状态必须手动加锁或用ConcurrentHashMap,容易出并发问题。

常见错误现象:

  • 客户端连ws://localhost:8080/ws返回404 → 没配ServerEndpointExporter或路径写错
  • 连接成功但收不到消息 → @OnMessage方法没加public修饰符,或参数类型不匹配(只支持Stringbyte[]Session等有限类型)
  • 多客户端连接后互相干扰 → 误把会话集合(如static Map)放在@ServerEndpoint类里,但每个连接都是新实例,静态变量其实能共享,但生命周期难控,建议改用外部Bean管理

ServerEndpointExporter必须配,且仅限内嵌容器

Spring Boot内嵌Tomcat/Jetty时,@ServerEndpoint注解不会被自动扫描——这是Java EE规范限制,不是Spring漏了。必须显式注册ServerEndpointExporter Bean来“桥接”Spring容器和Servlet容器。

配置示例:

@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

注意:

WebSocket 8.18.2
WebSocket 8.18.2

WebSocket 8.18.2 是该协议规范的一个重要迭代版本,主要优化了连接稳定性与数据传输效率。它通过全双工通信机制,允许客户端与服务器在单一长连接上实时交换数据,大幅降低传统 HTTP 轮询的开销。该版本增强了心跳保活、自动重连及二进制帧传输能力,适用于即时通讯、在线游戏及金融行情推送等低延迟场景,为开发者提供更可靠的实时网络交互基础。

下载
  • 如果部署到独立Tomcat(war包),这个Bean**不能存在**,否则启动报java.lang.IllegalStateException: javax.websocket.server.ServerContainer not available
  • 路径必须用绝对路径,比如@ServerEndpoint("/ws"),不能写成@ServerEndpoint("/api/ws")再靠Spring MVC路由转发——那根本不是WebSocket握手
  • 不要在@ServerEndpoint类上加@Component@Scope("prototype"),它不由Spring管理实例,加了也没用

@ServerEndpoint类的写法要点

核心是四个生命周期注解:@OnOpen@OnMessage@OnClose@OnError,它们方法必须是public,参数类型要严格匹配。

典型结构:

@ServerEndpoint("/ws")
public class DeviceWebSocketEndpoint {
    // 存储所有活跃会话,用static + ConcurrentHashMap(因为每个连接是新实例)
    private static final ConcurrentHashMap<string session> sessions = new ConcurrentHashMap();

    @OnOpen
    public void onOpen(Session session) {
        sessions.put(session.getId(), session);
    }

    @OnMessage
    public void onMessage(String message, Session session) throws IOException {
        // 处理文本消息,例如JSON格式的设备指令
        sessions.values().forEach(s -> {
            try { s.getBasicRemote().sendText("ACK:" + message); }
            catch (IOException ignored) {}
        });
    }

    @OnClose
    public void onClose(Session session) {
        sessions.remove(session.getId());
    }

    @OnError
    public void onError(Session session, Throwable error) {
        error.printStackTrace();
    }
}</string>

容易踩的坑:

  • session.getBasicRemote().sendText()是阻塞调用,高并发下可能卡住线程 → 如需异步发,改用session.getAsyncRemote()
  • 不要在@OnMessage里做耗时操作(如DB查询、HTTP调用)→ 会阻塞该连接的后续消息接收,应丢进线程池或发事件
  • 路径中带参数(如/ws/{deviceId})不被@ServerEndpoint原生支持 → 需在@OnOpen里解析session.getRequestParameterMap()或改用WebSocketHandler方式

跨域和生产环境注意事项

开发阶段设setAllowedOrigins("*")方便调试,但上线必须明确指定来源域名,否则有安全风险。不过@ServerEndpoint本身不提供跨域配置入口——它是Servlet容器层面的端点,跨域由前端发起的HTTP握手请求控制,实际生效的是浏览器对Origin头的校验。

真正要处理的只有两点:

  • 确保Nginx或网关层不拦截UpgradeConnection头(常见错误:Nginx默认不透传这些头,需加proxy_set_header Upgrade $http_upgrade;等配置)
  • 如果用SSL,WebSocket必须用wss://,且证书要有效;自签名证书在Chrome里会直接拒绝握手
  • 连接空闲超时:Tomcat默认60秒关闭空闲连接,可在application.propertiesserver.tomcat.connection-timeout=180000,或通过ServletServerContainerFactoryBean设置maxSessionIdleTimeout(仅对WebSocketHandler方式有效)

最常被忽略的一点:WebSocket连接建立后,**HTTP Session和WebSocket Session完全无关**。别指望在@OnOpen里拿到HttpSession,认证和用户绑定得靠Token传参、URL携带或握手时的HttpServletRequest(后者仅WebSocketHandler方式能拿到)。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

websocket

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2589

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2108

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1080

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1018

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1256

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

1898

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

2900

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

12515

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

509

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebSocket手册
WebSocket手册

共0课时 | 0人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习