- 配置pom文件
org.springframework.boot
spring-boot-starter-websocket
开启WebSocket服务端的自动注册
注意:ServerEndpointExporter 是由Spring官方提供的标准实现,用于扫描ServerEndpointConfig配置类和@ServerEndpoint注解实例。使用规则也很简单:1.如果使用默认的嵌入式容器 比如Tomcat 则必须手工在上下文提供ServerEndpointExporter。2. 如果使用外部容器部署war包,则不要提供提供ServerEndpointExporter,因为此时SpringBoot默认将扫描服务端的行为交给外部容器处理
/**
- 开启WebSocket支持
*/
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
- 创建WebSocket服务端
①通过注解@ServerEndpoint来声明实例化WebSocket服务端。(注意配置@Component才能被spring扫描)
② 通过注解@OnOpen、@OnMessage、@OnClose、@OnError 来声明回调函数。
③发送消息:new Session().getBasicRemote().sendText(message);
- WebSocket服务类编写
这里对照下面的代码看:
-
-
- 第20行,@ServerEndpoint(“/websocket/{userID}”),括号中的内容就是客户端请求Socket连接时的访问路径,userID是我要求客户端传来的参数,我这里算是为了标识该客户端吧。
-
-
第28行,在该类中添加属性 userID,并添加对应的getUserID()方法。
-
第46行,在onOpen()方法即建立连接的时候就接收参数userID,需要标识@PathParam(“userID”) 。接收参数后直接赋值给属性userID。
-
第140-157行,是针对特定客户端发送消息。服务器和客户端在建立连接成功后就生成了一个WebSocket对象,并存在集合中,对象里特有的属性是我们设置的userID。所以通过唯一的userID就能标识服务器与该客户端建立的那个连接啦!这样要求发送消息时,传入userID与消息,服务器在自己的WebSocket连接集合中遍历找到对