文章目录
- 前言
- 表象
- 理解
- 后记
- 更多文章
前言
最近工作需要用到 Websocket 协议。好奇来自 Jdk 包的 @ServerEndpoint 是如何与 Spring Boot 集成的，特此记录一下结论。
表象
如果要暴露形如 ws://${ip}:${port}/ws 的服务地址，用于websocket 通信，需要完成以下步骤：
@Component必须与@ServerEndpoint搭配使用@OnXX类的注解同样来自javax.websocket.*
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.util.concurrent.atomic.AtomicInteger;@Component
@ServerEndpoint(value = "/ws")
public class MyWsEndpoint {@OnOpenpublic void onOpen(Session session) {}@OnClosepublic void onClose(Session session, CloseReason closeReason) {}@OnMessagepublic void onMessage(String text, Session session) {}@OnErrorpublic void onError(Session session, Throwable throwable) {}}
- 将
ServerEndpointExporter以@Bean的形式告知 Spring
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;@Configuration
public class MyWsConfig {@Beanpublic ServerEndpointExporter serverEndpointExporter() {return new ServerEndpointExporter();}
}
理解
以上步骤留有疑问
- 为啥要用
@Component注解 ServerEndpointExporter有什么用
解答：
context.getBeanNamesForAnnotation(ServerEndpoint.class);
以上代码很直观了
- 要求被暴露的websocket服务类必须是个bean，所以要有
@Component注解 - ServerEndpointExporter 的作用是将所有
@ServerEndpoint的bean 注册进容器里
后记
@ServerEndpoint能够方便的与 Spring 集成。简单的业务开发上已经够用了- 在对协议交互中（如握手阶段）加入更多业务逻辑，可以再考虑使用 Spring 自身的 websocket 支持。
更多文章
【Spring】验证 @ServerEndpoint 的类成员变量线程安全
)
超详细)
)