java WebSocket 实现

灰太狼 2021-11-11 07:20 435阅读 0赞

包含 Java 实现的 websocket 的完整例子

# 一、 maven 主要依赖 #

<dependencies>
            
            <dependency>
                <groupId>javax.websocket</groupId>
                <artifactId>javax.websocket-api</artifactId>
                <version>1.1</version>
                <scope>provided</scope>
            </dependency>
            
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-log4j12</artifactId>
                <version>1.7.25</version>
            </dependency>
            
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
    
        </dependencies>

# 二、注解介绍 #

**@ServerEndpoint**  
声明websocket地址，类似于Spring MVC中的@controller注解，websocket使用@ServerEndpoint来进行声明接口：@ServerEndpoint(value="/websocket/\{paraName\}") ; 其中 “ \{ \} ”用来表示带参数的连接，如果需要获取\{\}中的参数在参数列表中增加：@PathParam(“paraName”) String userId 。

**@OnOpen**  
有连接时的触发函数。 我们可以在用户连接时记录用户的连接带的参数，只需在参数列表中增加参数：@PathParam(“paraName”) String paraName。

**@OnClose**  
连接关闭时的调用方法。

**@OnMessage**  
收到消息时调用的函数，其中Session是每个websocket特有的数据成员

**@OnError**  
发生意外错误时调用的函数

示例代码：[https://github.com/ChaseDreamBoy/websocket-demo/blob/master/src/main/java/com/xh/socket/MyServerEndpoint.java][https_github.com_ChaseDreamBoy_websocket-demo_blob_master_src_main_java_com_xh_socket_MyServerEndpoint.java]

# 三、成员数据介绍 #

**Session**  
每个Session代表了两个web socket断点的会话；当websocket握手成功后，websocket就会提供一个打开的Session，可以通过这个Session来对另一个端点发送数据；如果Session关闭后发送数据将会报错。

**Session.getBasicRemote().sendText(“message”)**  
向该Session连接的用户发送字符串数据。

# 四、websocket-demo #

[https://github.com/ChaseDreamBoy/websocket-demo][https_github.com_ChaseDreamBoy_websocket-demo]

# 五、jetty #

项目使用 jetty 容器，启动方式：  
![start project][]

# 六、效果 #

![message][]

[https_github.com_ChaseDreamBoy_websocket-demo_blob_master_src_main_java_com_xh_socket_MyServerEndpoint.java]: https://github.com/ChaseDreamBoy/websocket-demo/blob/master/src/main/java/com/xh/socket/MyServerEndpoint.java
[https_github.com_ChaseDreamBoy_websocket-demo]: https://github.com/ChaseDreamBoy/websocket-demo
[start project]: /images/20211109/2df3897b1e1441de912536b658219b13.png
[message]: /images/20211109/3a9989dabf5b440181b2984f6a906340.png