SpringBoot集成websocket
- 添加依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
- 添加configration 注解
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
@Configuration
public class WebSocketConfig {
@Bean
//注入ServerEndpointExporter bean 对象,自动注册使用了@ServerEndpoint 注解的bean
public ServerEndpointExporter serverEndpointExporter(){
return new ServerEndpointExporter();
}
}
- 写websocket 类
@ServerEndpoint(value = "/socket", encoders = WebSocketServerEncoder.class)
@Component
public class TestWebSocket {
private static Service service;
@Autowired
public void setService(Service service){
TestWebSocket.service = service;
}
//web socket 建立连接的时候调用
@OnOpen
public void onOpen(Session session){
System.out.println("connected");
}
// web socket 关闭的时候调用
@OnClose
public void onClose(Session session){
System.out.println("closed");
}
// 接受消息的时候调用
@OnMessage
public void onMessage(String input, Session session) {
System.out.println(input);
Object object = TestWebSocket.service.test();
try {
//发送数据 发送对象Object
session.getBasicRemote().sendObject(object);
} catch (IOException | EncodeException e) {
e.printStackTrace();
}
}
}
@ServerEndpoint 是websockt server端注解。参数:
value代表对应的url类似于RestAPI 中的@RestController
encoders 用于sendObject()方法。不加会出现No encoder specified for object of class error(下面会写WebSocketServerEncoder 类)这里如果调用sendText()方法可以不用encoders 参数
另外注意的一点websocket 因为不是单例模式。所以用@Autowired 注解无法注入bean。
所有以需要用一个静态的变量来注入。(这里应该会有线程安全问题。有高手可以提出更好的解决方法)
其他注解
@OnOpen web socket 建立连接的时候调用
@OnClose web socket 关闭的时候调用
@OnMessage web socket 接受消息的时候调用
- WebSocketServerEncoder用于sendObject();
public class WebSocketServerEncoder implements Encoder.Text<Object>{
public WebSocketServerEncoder() {
}
@Override
public String encode(Object object) throws EncodeException {
ObjectMapper mapper = new ObjectMapper();
String text = null;
try {
text = mapper.writeValueAsString(object);
return text;
} catch (JsonProcessingException e) {
e.printStackTrace();
return null;
}
}
@Override
public void init(EndpointConfig endpointConfig) {
}
@Override
public void destroy() {
}
}