SpringBoot集成WebSocket实现后台向前端推送信息的⽰例
⽬录
前⾔
⼀、什么是websocket？
⼆、使⽤步骤
1.添加依赖
2.启⽤Springboot对WebSocket的⽀持
3.核⼼配置：WebSocketServer
4.测试Controller
5.测试页⾯index.html
6.结果展⽰
总结
前⾔
在⼀次项⽬开发中，使⽤到了Netty⽹络应⽤框架，以及MQTT进⾏消息数据的收发，这其中需要后台来将获取到的消息主动推送给前端，于是就使⽤到了MQTT，特此记录⼀下。
⼀、什么是websocket？
WebSocket协议是基于TCP的⼀种新的⽹络协议。它实现了客户端与服务器全双⼯通信，学过计算机⽹络都知道，既然是全双⼯，就说明了服务器可以主动发送信息给客户端。这与我们的推送技术或者是多⼈的功能不谋⽽合。
为什么不使⽤HTTP 协议呢？这是因为HTTP是单⼯通信，通信只能由客户端发起，客户端请求⼀下，服务器处理⼀下，这就太⿇烦了。于是websocket应运⽽⽣。
下⾯我们就直接开始使⽤Springboot开始整合。以下案例都在我⾃⼰的电脑上测试成功，你可以根据⾃⼰的功能进⾏修改即可。
我的项⽬结构如下：
⼆、使⽤步骤
1.添加依赖
Maven依赖：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
2.启⽤Springboot对WebSocket的⽀持
启⽤WebSocket的⽀持也是很简单，⼏句代码搞定：
import t.annotation.Bean;
import t.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
* @ 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来连接到WebSocke
t服务器端
新建⼀个ConcurrentHashMap webSocketMap ⽤于接收当前userId的WebSocket，⽅便传递之间对userId进⾏推送消息。
下⾯是具体业务代码：
al.webScoket;
import ditions.query.QueryWrapper;
import ditions.update.UpdateWrapper;
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 urrent.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<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();
//与某个客户端的连接会话，需要通过它来给客户端发送数据
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) {
<("websocket IO Exception");
}
}
/**
* 连接关闭调⽤的⽅法
*/
@OnClose
public void onClose() {
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) {
<("发⽣错误");
error.printStackTrace();
}
/**
* 实现服务器主动推送
*/
public void sendMessage(String message) throws IOException {
BasicRemote().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() {
}
public static synchronized void subOnlineCount() {
}
public static CopyOnWriteArraySet<WebSocketServer> 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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Java后端WebSocket的Tomcat实现</title>
<script type="text/javascript" src="js/jquery.min.js"></script>
</head>
<body>
<div id="main" ></div>
Welcome<br/><input id="text" type="text" />
<button onclick="send()">发送消息</button>
<hr/>
<button onclick="closeWebSocket()">关闭WebSocket连接</button>
<hr/>
<div id="message"></div>
</body>
<script type="text/javascript">
var websocket = null;
//判断当前浏览器是否⽀持WebSocket
if('WebSocket' in window) {
//改成你的地址
websocket = new WebSocket("ws://192.168.100.196:8082/api/websocket/100");
} else {
alert('当前浏览器 Not support websocket')
}
//连接发⽣错误的回调⽅法
setMessageInnerHTML("WebSocket连接发⽣错误");
};
//连接成功建⽴的回调⽅法
setMessageInnerHTML("WebSocket连接成功");
}
var U01data, Uidata, Usdata
//接收到消息的回调⽅法
console.log(event);
setMessageInnerHTML(event);
setechart()
}
//连接关闭的回调⽅法
setMessageInnerHTML("WebSocket连接关闭");
}
//监听窗⼝关闭事件，当窗⼝关闭时，主动去关闭websocket连接，防⽌连接还没断开就关闭窗⼝，server端会抛异常。
closeWebSocket();
}
//将消息显⽰在⽹页上
function setMessageInnerHTML(innerHTML) {
}
//关闭WebSocket连接
function closeWebSocket() {
websocket.close();
}
//发送消息
function send() {
var message = ElementById('text').value;
websocket.send('{"msg":"' + message + '"}');
setMessageInnerHTML(message + " ");
}
</script>
</html>
6.结果展⽰
后台：
前端websocket怎么用如果有连接请求
前台显⽰：
总结
这中间我遇到⼀个问题，就是说WebSocket启动的时候优先于spring容器，从⽽导致在WebSocketServer中调⽤业务Service会报空指针异常
所以需要在WebSocketServer中将所需要⽤到的service给静态初始化⼀下：
如图所⽰：
还需要做如下配置：
到此这篇关于SpringBoot集成WebSocket实现后台向前端推送信息的⽰例的⽂章就介绍到这了，更多相关SpringBoot集成WebSocket 内容请搜索以前的⽂章或继续浏览下⾯的相关⽂章希望⼤家以后多多⽀持！

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。