SpringBoot集成WebSocket,实现后台向前端推送信息

/**

  • @ Auther: 马超伟

  • @ Date: 2020/06/16/14:35

  • @ Description: 开启WebSocket支持

*/

@Configuration

public class WebSocketConfig {

@Bean

public ServerEndpointExporter serverEndpointExporter() {

return new ServerEndpointExporter();

}

}


3.核心配置:WebSocketServer


因为WebSocket是类似客户端服务端的形式(采用ws协议),那么这里的WebSocketServer其实就相当于一个ws协议的Controller

  • @ ServerEndpoint 注解是一个类层次的注解,它的功能主要是将目前的类定义成一个websocket服务器端, 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端

  • 新建一个ConcurrentHashMap webSocketMap 用于接收当前userId的WebSocket,方便传递之间对userId进行推送消息。

下面是具体业务代码:

package cc.mrbird.febs.external.webScoket;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;

import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;

import lombok.extern.slf4j.Slf4j;

import org.springframework.stereotype.Component;

import org.springframework.stereotype.Service;

import javax.websocket.*;

import javax.websocket.server.PathParam;

import javax.websocket.server.ServerEndpoint;

import java.io.IOException;

import java.time.LocalDateTime;

import java.util.List;

import java.util.concurrent.CopyOnWriteArraySet;

/**

  • Created with IntelliJ IDEA.

  • @ Auther: 马超伟

  • @ Date: 2020/06/16/14:35

  • @ Description:

  • @ ServerEndpoint 注解是一个类层次的注解,它的功能主要是将目前的类定义成一个websocket服务器端,

  • 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端

*/

@Component

@Slf4j

@Service

@ServerEndpoint(“/api/websocket/{sid}”)

public class WebSocketServer {

//静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。

private static int onlineCount = 0;

//concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。

private static CopyOnWriteArraySet webSocketSet = new CopyOnWriteArraySet();

//与某个客户端的连接会话,需要通过它来给客户端发送数据

private Session session;

//接收sid

private String sid = “”;

/**

  • 连接建立成功调用的方法

*/

@OnOpen

public void onOpen(Session session, @PathParam(“sid”) String sid) {

this.session = session;

webSocketSet.add(this); //加入set中

this.sid = sid;

addOnlineCount(); //在线数加1

try {

sendMessage(“conn_success”);

log.info(“有新窗口开始监听:” + sid + “,当前在线人数为:” + getOnlineCount());

} catch (IOException e) {

log.error(“websocket IO Exception”);

}

}

/**

  • 连接关闭调用的方法

*/

@OnClose

public void onClose() {

webSocketSet.remove(this); //从set中删除

subOnlineCount(); //在线数减1

//断开连接情况下,更新主板占用情况为释放

log.info(“释放的sid为:”+sid);

//这里写你 释放的时候,要处理的业务

log.info(“有一连接关闭!当前在线人数为” + getOnlineCount());

}

/**

  • 收到客户端消息后调用的方法

  • @ Param message 客户端发送过来的消息

*/

@OnMessage

public void onMessage(String message, Session session) {

log.info(“收到来自窗口” + sid + “的信息:” + message);

//群发消息

for (WebSocketServer item : webSocketSet) {

try {

item.sendMessage(message);

} catch (IOException e) {

e.printStackTrace();

}

}

}

/**

  • @ Param session

  • @ Param error

*/

@OnError

public void onError(Session session, Throwable error) {

log.error(“发生错误”);

error.printStackTrace();

}

/**

  • 实现服务器主动推送

*/

public void sendMessage(String message) throws IOException {

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

}

/**

  • 群发自定义消息

*/

public static void sendInfo(String message, @PathParam(“sid”) String sid) throws IOException {

log.info(“推送消息到窗口” + sid + “,推送内容:” + message);

for (WebSocketServer item : webSocketSet) {

try {

//这里可以设定只推送给这个sid的,为null则全部推送

if (sid == null) {

// item.sendMessage(message);

} else if (item.sid.equals(sid)) {

item.sendMessage(message);

}

} catch (IOException e) {

continue;

}

}

}

public static synchronized int getOnlineCount() {

return onlineCount;

}

public static synchronized void addOnlineCount() {

WebSocketServer.onlineCount++;

}

public static synchronized void subOnlineCount() {

WebSocketServer.onlineCount–;

}

public static CopyOnWriteArraySet getWebSocketSet() {

return webSocketSet;

}

}

4.测试Controller


import org.springframework.stereotype.Controller;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.ResponseBody;

import org.springframework.web.servlet.ModelAndView;

import java.io.IOException;

import java.util.HashMap;

import java.util.Map;

/**

  • Created with IntelliJ IDEA.

  • @ Auther: 马超伟

  • @ Date: 2020/06/16/14:38

  • @ Description:

*/

@Controller(“web_Scoket_system”)

@RequestMapping(“/api/socket”)

public class SystemController {

//页面请求

@GetMapping(“/index/{userId}”)

public ModelAndView socket(@PathVariable String userId) {

ModelAndView mav = new ModelAndView(“/socket1”);

mav.addObject(“userId”, userId);

return mav;

}

//推送数据接口

@ResponseBody

@RequestMapping(“/socket/push/{cid}”)

public Map pushToWeb(@PathVariable String cid, String message) {

Map<String,Object> result = new HashMap<>();

try {

WebSocketServer.sendInfo(message, cid);

result.put(“code”, cid);

result.put(“msg”, message);

} catch (IOException e) {

e.printStackTrace();

}

return result;

}

}

5.测试页面index.html


Java后端WebSocket的Tomcat实现

Welcome

发送消息


关闭WebSocket连接


  • 6
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
实现Spring Boot集成WebSocket实现消息推送,需要进行以下步骤: 1. 添加Spring Boot WebSocket依赖 2. 创建WebSocket配置类 3. 创建WebSocket处理器类 4. 创建WebSocket拦截器类 5. 创建WebSocket消息模型类 6. 在Spring Boot中使用WebSocket 下面是一个简单的示例代码: 1. 添加Spring Boot WebSocket依赖 在pom.xml文件中添加以下依赖: ``` <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 2. 创建WebSocket配置类 创建一个WebSocket配置类,用于配置WebSocket相关的参数,如下所示: ``` @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(new WebSocketHandler(), "/websocket").addInterceptors(new WebSocketInterceptor()); } } ``` 3. 创建WebSocket处理器类 创建一个WebSocket处理器类,用于处理WebSocket连接、断开连接和接收消息等操作,如下所示: ``` public class WebSocketHandler extends TextWebSocketHandler { private static final List<WebSocketSession> sessions = new CopyOnWriteArrayList<>(); @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { sessions.add(session); } @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception { sessions.remove(session); } @Override protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception { for (WebSocketSession s : sessions) { s.sendMessage(message); } } } ``` 4. 创建WebSocket拦截器类 创建一个WebSocket拦截器类,用于拦截WebSocket连接请求,如下所示: ``` public class WebSocketInterceptor implements HandshakeInterceptor { @Override public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception { return true; } @Override public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception) { } } ``` 5. 创建WebSocket消息模型类 创建一个WebSocket消息模型类,用于封装WebSocket消息,如下所示: ``` public class WebSocketMessage { private String content; public String getContent() { return content; } public void setContent(String content) { this.content = content; } } ``` 6. 在Spring Boot中使用WebSocketSpring Boot中使用WebSocket非常简单,只需要在Controller中注入WebSocketSession即可,如下所示: ``` @Controller public class WebSocketController { @Autowired private WebSocketSession session; @MessageMapping("/send") public void send(WebSocketMessage message) throws Exception { session.sendMessage(new TextMessage(message.getContent())); } } ```

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值