使⽤springboot+WebSocket实现(后台主动)消息推送
前⾔:使⽤此webscoket务必确保⽣产环境能兼容/⽀持!使⽤此webscoket务必确保⽣产环境能兼容/⽀持!使⽤此webscoket务必确保⽣产环境能兼容/⽀持!主要是tomcat的兼容与⽀持。
有个需求:APP⽤户产⽣某个操作,需要让后台管理系统部分⼈员感知(表现为⼀个页⾯消息)。
最早版本是后台管理系统轮训,每隔⼀段时间轮训⼀次,由于消息重要,每隔⼏秒就查⼀次。这样做明显很不雅!会消耗⼤量资源,并且⼤部分请求是没有⽤的(查不到数据进来),很蓝瘦。
后来,想着⽤消息推送的⽅式来处理这个逻辑。⽤户在app产⽣了⽬标操作,即产⽣⼀个消息,推送给后台管理系统的对应⽤户。
然后我就各种资料,⼀开始同事推荐dwz,后来发现不太适⽤于⽬前的项⽬(也许能实现只是我不知道如何实现)。
后来了解到WebSocket,⽹上看了很多⽂档都是类似聊天室的场景,有些不同。在此,我主要侧重介绍下 服务器主动推送,由服务端来触发。
WebSocket 主要能实现的场景:
1、⽹页聊天室
2、服务器消息实时通知
WebSocket 使⽤⽅法应该有很多,在次介绍下使⽤ tomcat8+h5 环境下的实现。
ps:我⾃⼰的测试环境是tomcat7这样写是不⾏的。wang115032337《blog.csdn/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 urrent.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;
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) {
<("websocket IO异常");
}
}
// //连接打开时执⾏
// @OnOpen
// public void onOpen(@PathParam("user") String user, Session session) {
// currentUser = user;
// System.out.println("Connected ... " + Id());
// }
/**
* 连接关闭调⽤的⽅法
*/
@OnClose
public void onClose() {
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) {
<("发⽣错误");
error.printStackTrace();
}
public void sendMessage(String message) throws IOException {
BasicRemote().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() {
}
public static synchronized void subOnlineCount() {
}
}
产⽣⼀个消息:产⽣消息场景有多种,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:"+Value(param, "sltAccountId"));
result.put("operationResult", true);
}catch (IOException e) {
result.put("operationResult", true);
}
return result;
}
重要的地⽅我都加粗了,主要是这段,使⽤这个⽅法,可以实现服务器主动推送。
public void sendMessage(String message) throws IOException {
BasicRemote().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");
//打开事件
console.log("Socket 已打开");
//socket.send("这是来⾃客户端的消息" + location.href + new Date());
};
//获得消息事件
console.log(msg.data);
//发现消息进⼊调后台获取
getCallingList();
};
//关闭事件
console.log("Socket已关闭");
};
/
/发⽣了错误事件
alert("Socket发⽣了错误");
}
$(window).unload(function(){
socket.close();
});
// $("#btnSend").click(function() {
// socket.send("这是来⾃客户端的消息" + location.href + new Date()); // });
//
websocket和socket// $("#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实现的类似场景,希望对你有帮助。如有写的不对或不够好的地⽅,欢迎指正。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论