对于Tomcat中的websocket的了解

最新推荐文章于 2025-07-07 09:23:37 发布

原创

最新推荐文章于 2025-07-07 09:23:37 发布 · 760 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#websocket

本文介绍了Tomcat从7.0.5版本开始支持的WebSocket实现，遵循JSR356规范。WebSocket Endpoint代表链接一端，其生命周期包括onOpen、onClose和onError方法。会话在WebSocket握手后创建，可通过Session添加MessageHandler处理消息，RemoteEndpoint负责发送。WebSocketContainer维护所有Endpoint，而ServerApplicationConfig接口允许配置和过滤Endpoint。Tomcat提供了注解式实现WebSocket服务的例子。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Tomcat自7.0.5版本开始支持WebSocket，并且实现了Java WebSocket规范（JSR356 ），而在7.0.5版本之前（7.0.2版本之后）则采用自定义API，即WebSocketServlet。本节我们仅介绍Tomcat针对规范的实现。

根据JSR356的规定，Java WebSocket应用由一系列的WebSocket Endpoint组成。Endpoint是一个Java对象，代表WebSocket链接的一端，对于服务端，我们可以视为处理具体WebSocket消息的接口，就像Servlet之于HTTP请求一样（不同之处在于Endpoint每个链接一个实例）。

我们可以通过两种方式定义Endpoint，第一种是编程式，即继承类javax.websocket.Endpoint并实现其方法。第二种是注解式，即定义一个POJO对象，为其添加Endpoint相关的注解。

Endpoint实例在WebSocket握手时创建，并在客户端与服务端链接过程中有效，最后在链接关闭时结束。Endpoint接口明确定义了与其生命周期相关的方法，规范实现者确保在生命周期的各个阶段调用实例的相关方法。

Endpoint的生命周期方法如下：

onOpen：当开启一个新的会话时调用。这是客户端与服务器握手成功后调用的方法。等同于注解@OnOpen。
onClose：当会话关闭时调用。等同于注解@OnClose。
onError：当链接过程中异常时调用。等同于注解@OnError。
当客户端链接到一个Endpoint时，服务器端会为其创建一个唯一的会话（javax.websocket.Session）。会话在WebSocket握手之后创建，并在链接关闭时结束。当生命周期中触发各个事件时，都会将当前会话传给Endpoint。

我们通过为Session添加MessageHandler消息处理器来接收消息。当采用注解方式定义Endpoint时，我们还可以通过@OnMessage指定接收消息的方法。发送消息则由RemoteEndpoint完成，其实例由Session维护，根据使用情况，我们可以通过Session.getB