使用spring boot +WebSocket实现（后台主动）消息推送

最新推荐文章于 2021-05-20 13:35:33 发布

liuningwjt

最新推荐文章于 2021-05-20 13:35:33 发布

阅读量427

点赞数

分类专栏： socket

socket 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

前言：使用此webscoket务必确保生产环境能兼容/支持！使用此webscoket务必确保生产环境能兼容/支持！使用此webscoket务必确保生产环境能兼容/支持！主要是tomcat的兼容与支持。

有个需求：APP用户产生某个操作，需要让后台管理系统部分人员感知（表现为一个页面消息）。

最早版本是后台管理系统轮训，每隔一段时间轮训一次，由于消息重要，每隔几秒就查一次。这样做明显很不雅！会消耗大量资源，并且大部分请求是没有用的（查不到数据进来），很蓝瘦。

后来，想着用消息推送的方式来处理这个逻辑。用户在app产生了目标操作，即产生一个消息，推送给后台管理系统的对应用户。

然后我就找各种资料，一开始同事推荐dwz，后来发现不太适用于目前的项目（也许能实现只是我不知道如何实现）。

后来了解到WebSocket，网上看了很多文档都是类似聊天室的场景，有些不同。在此，我主要侧重介绍下 服务器主动推送，由服务端来触发。

WebSocket 主要能实现的场景：

1、网页聊天室

2、服务器消息实时通知

WebSocket 使用方法应该有很多，在次介绍下使用 tomcat8+h5 环境下的实现。

ps：我自己的测试环境是tomcat7这样写是不行的。wang115032337《https://blog.csdn.net/wang115032337》这位朋友在他的环境下，tomcat7/8都可以用本文章的写法，只不过需要去除WebSocketConfig类（有文章表示tomcat7和8对websocket的支持是不同的，本人未深入了解）

话不多说，直接上代码，想深入了解WebSocket 的请查阅相关介绍。

1.pom

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

2.使用@ServerEndpoint创立websocket endpoint（ wang115032337这位朋友在他的环境下加入@ServerEndpoint类会报错，直接删除了仍可用）

@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}

3.具体实现类可自己选择url要不要带参数

package com.star.manager.service;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
@Slf4j
//@ServerEndpoint("/websocket/{user}")
@ServerEndpoint(value = "/websocket")
@Component
public class WebSocketServer {
//静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
private static int onlineCount = 0;
//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();
//与某个客户端的连接会话，需要通过它来给客户端发送数据
private Session session;
/**
* 连接建立成功调用的方法*/
@OnOpen
public void onOpen(Session session) {
this.session = session;
webSocketSet.add(this); //加入set中
addOnlineCount(); //在线数加1
log.info("有新连接加入！当前在线人数为" + getOnlineCount());
try {
sendMessage("连接成功");
} catch (IOException e) {
log.error("websocket IO异常");
}
}
// //连接打开时执行
// @OnOpen
// public void onOpen(@PathParam("user") String user, Session session) {
// currentUser = user;
// System.out.println("Connected ... " + session.getId());
// }
/**
* 连接关闭调用的方法
*/
@OnClose
public void onClose() {
webSocketSet.remove(this); //从set中删除
subOnlineCount(); //在线数减1
log.info("有一连接关闭！当前在线人数为" + getOnlineCount());
}
/**
* 收到客户端消息后调用的方法
*
* @param message 客户端发送过来的消息*/
@OnMessage
public void onMessage(String message, Session session) {
log.info("来自客户端的消息:" + 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) throws IOException {
log.info(message);
for (WebSocketServer item : webSocketSet) {
try {
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--;
}
}

产生一个消息：产生消息场景有多种，http（s），定时任务，mq等，这贴一个httpq请求的controller代码

@RequestMapping(value="/pushVideoListToWeb",method=RequestMethod.POST,consumes = "application/json")
public @ResponseBody Map<String,Object> pushVideoListToWeb(@RequestBody Map<String,Object> param) {
Map<String,Object> result =new HashMap<String,Object>();
try {
WebSocketServer.sendInfo("有新客户呼入,sltAccountId:"+CommonUtils.getValue(param, "sltAccountId"));
result.put("operationResult", true);
}catch (IOException e) {
result.put("operationResult", true);
}
return result;
}

重要的地方我都加粗了，主要是这段，使用这个方法，可以实现服务器主动推送。

public void sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
}

4.js（html就不写了，随便找个能触发这个js的就可以）

//socket = new WebSocket("ws://localhost:9094/starManager/websocket/张三");
var socket;
if(typeof(WebSocket) == "undefined") {
console.log("您的浏览器不支持WebSocket");
}else{
console.log("您的浏览器支持WebSocket");
//实现化WebSocket对象，指定要连接的服务器地址与端口建立连接
//socket = new WebSocket("ws://localhost:9094/starManager/websocket/张三")

socket = new WebSocket("ws://localhost:9094/starManager/websocket");
//打开事件
socket.onopen = function() {
console.log("Socket 已打开");
//socket.send("这是来自客户端的消息" + location.href + new Date());
};
//获得消息事件
socket.onmessage = function(msg) {
console.log(msg.data);
//发现消息进入调后台获取
getCallingList();
};
//关闭事件
socket.onclose = function() {
console.log("Socket已关闭");
};
//发生了错误事件
socket.onerror = function() {
alert("Socket发生了错误");
}
$(window).unload(function(){
socket.close();
});
// $("#btnSend").click(function() {
// socket.send("这是来自客户端的消息" + location.href + new Date());
// });
//
// $("#btnClose").click(function() {
// socket.close();
// });
}

简单说说：

通过前端代码

socket = new WebSocket("ws://localhost:9094/starManager/websocket");

其中，starManager是工程名，/webscoket是访问路径名

建立连接，前端调用scoket.open() 会使后台在静态成员变量webSocketSet里面增加一个元素，相当于一个缓存。后台服务调用sendMessage

（指定某个用户，定向）或sendInfo（遍历webSocketSet逐个发送，类似群发）方法，即可向已登录的客户端推送消息。

代码就这么多。我的用这些代码就跑的起来。做的时候出现过页面报404等错误，如果也是spring boot+h5，仔细核对下和我代码有无区别，加配置路径是有ok，问题应该不大。

如果你恰好也有可以用WebSocket实现的类似场景，希望对你有帮助。如有写的不对或不够好的地方，欢迎指正。

liuningwjt

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
使用spring boot +WebSocket实现（后台主动）消息推送

前言：使用此webscoket务必确保生产环境能兼容/支持！使用此webscoket务必确保生产环境能兼容/支持！使用此webscoket务必确保生产环境能兼容/支持！主要是tomcat的兼容与支持。有个需求：APP用户产生某个操作，需要让后台管理系统部分人员感知（表现为一个页面消息）。最早版本是后台管理系统轮训，每隔一段时间轮训一次，由于消息重要，每隔几秒就查一次。这样做明显很不雅！会消...
复制链接

扫一扫