SpringBoot使用WebSocket实现前后端交互的操作方法

SpringBoot使用WebSocket实现前后端交互的操作方法

目录背景实现一、导入依赖二、新建WebSocket配置类，注入Bean三、新建WebSocket服务端，在其中处理websocket逻辑四、客户端实现，可以借助FreeMarker模板工具直接写在ftl文件里。五、测试

背景

我们都知道http协议只能在浏览器单方面向服务器发起请求时获得响应，然而服务器不能主动向浏览器推送消息，想要实现浏览器的主动推送目前有两种主流的实现方式：

轮询：缺点很多，但是实现简单websocket: 在浏览器和服务器之间建立TCP连接，实现全双工通信springboot使用websocket有两种方式，一种是实现简单的websocket，另外一种是实现STOMP协议。本篇讲述如何使用springboot实现简单的websocket。

实现

一、导入依赖

直接在pom.xml中导入依赖。

org.springframework.boot

spring-boot-starter-websocket

二、新建WebSocket配置类，注入Bean

首先注入一个ServerEndpointExporterBean，该Bean会自动注册使用@ServerEndpoint注解申请的websocket endpoint,代码如下：

http://

@Component

public class WebSocketConfig {

@Bean

public ServerEndpointExporter serverEndpointExporter(){

return new ServerEndpointExporter();

}

}

三、新建WebSocket服务端，在其中处理websocket逻辑

@Component //注册到容器中

@ServerEndpoint("/webSocket") //接收websocket请求路径

@Slf4j

public class WebSocket {

//当前连接（每个websocket连入都会创建一个WebSocket实例）

private Session session;

//定义一个websocket容器存储session,即存放所有在线的socket连接

private static CopyOnWriteArraySet webSocketSet = new CopyOnWriteArraySet<>();

//处理连接建立

@OnOpen

public void opOpen(Session session){

IFOYnhJ this.session = session;

log.info("【有新的客户端连接了】：{}",session.getId());

webSocketSet.add(this); //将新用户加入在线组

log.info("【websocket消息】有新的连接，总数：{}",webSocketSet.size());

}

//处理连接关闭

@OnClose

public void Onclose(){

webSocketSet.remove(this);

log.info("【websocket消息】连接断开，总数：{}",webSocketSet.size());

//接受消息

@OnMessage

public void onMessage(String message){

log.info("【websocket消息】收到客户端发来的消息：{}",message);

// 群发消息

public void sendMessage(String message) {

for (WebSocket webSocket : webSocketSet) {

log.info("【websocket消息】广播群发消息,message={}",message);

try {

webSocket.session.getBasicRemote().sendText(message);

}catch (Exception e){

e.printStackTrace();

}

}

}

四、客户端实现，可以借助FreeMarker模板工具直接写在ftl文件里。

由于部分浏览器可能不支持，可以先测试，代码如下：

五、测试

（项目实现客户创建新订单之后，前台发出提醒）

@Autowired

private WebSocket webSocket;

@Override

@Transactional

public OrderDTO create(OrderDTO orderDTO) {//创建订单

。。。。（具体代码省略）

//创建新订单 发送websocket消息

webSocket.sendMessage(orderDTO.getOrderId());

return orderDTO;

}

添加新订单：

接收到websocket消息

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。