netty-socketio整合springboot消息推送
1.netty-socketio消息推送
1)在项目中常常涉及到消息推送的情况,消息推送要求的实时性,使用传统的方式已经不能满足需求了;
2)使用netty-socketio做消息推送,实现步骤,加入jar包----->写启动,添加,通知,关闭工具类 -----> 设置依靠监听器启动 ----->页面引入js----->编写请求获取消息;
2.实现
1)pom依赖与js文件:socket.io.js (见文章末尾附件包中)
<dependencies>
<dependency>
<groupId>com.corundumstudio.socketio</groupId>
<artifactId>netty-socketio</artifactId>
<version>1.7.7</version>
</dependency>
</dependencies>
2)实现工具类
/**
* @author liudongyang
* @ClassName: Socketio
* @Description: netty-socketio工具类 创建、添加和启动客户端 消息推送 关闭服务
* @date 2018年11月27日 下午4:57:59
*/
public class Socketio {
private static SocketIOServer socketIOServer;
/**
* @Title: startSocketio
* @Description: 创建服务添加客户端
*/
public void startSocketio() {
// 配置
Configuration conf = new Configuration();
// 指定要主机ip地址,这个和页面请求ip地址一致
conf.setHostname( "localhost" );
// 指定端口号
conf.setPort( 9092 );
// 设置最大的WebSocket帧内容长度限制
conf.setMaxFramePayloadLength( 1024 * 1024 );
// 设置最大HTTP内容长度限制
conf.setMaxHttpContentLength( 1024 * 1024 );
socketIOServer = new SocketIOServer( conf );
ConnectListener connect = new ConnectListener() {
@Override
public void onConnect( SocketIOClient client ) {}
};
// 添加客户端
socketIOServer.addConnectListener( connect );
socketIOServer.start();
}
/**
* @Title: pushArr
* @Description: 全体消息推送
* @param type
* 前台根据类型接收消息,所以接收的消息类型不同,收到的通知就不同 推送的事件类型
* @param content
* 推送的内容
*/
public void pushArr( String type, Object content ) {
// 获取全部客户端
Collection<SocketIOClient> allClients = socketIOServer.getAllClients();
for( SocketIOClient socket : allClients ) {
socket.sendEvent( type, content );
}
}
/**
* @Title: startServer
* @Description: 启动服务
*/
public void startServer() {
if( socketIOServer == null ) {
new Thread( new Runnable() {
@Override
public void run() {
startSocketio();
}
} ).start();
}
}
/**
* @Title: stopSocketio
* @Description: 停止服务
*/
public void stopSocketio() {
if( socketIOServer != null ) {
socketIOServer.stop();
socketIOServer = null;
}
}
}
3)监听器启动(运行于整个项目运行时周期:init-destoryed)
@Configuration
@WebListener
public class SocketioLisener implements ServletContextListener {
@Override
public void contextInitialized(ServletContextEvent sce) {
//启动Socketio服务
Socketio socketio = new Socketio();
socketio.startServer();
}
@Override
public void contextDestroyed(ServletContextEvent sce) {
//关闭Socketio服务
Socketio socketio = new Socketio();
socketio.stopSocketio();
}
}
3.页面监听
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>消息推送</title>
</head>
<body>
</body>
<script src="https://code.jquery.com/jquery-3.2.1.min.js"></script>
<script type="text/javascript" src="./js/socket.io/socket.io.js"></script>
<script type="text/javascript">
<!-- 实时从指定查看是否有消息 -->
var socket = io.connect('localhost:9092');
socket.on('connect_msg',function(data){
alert(data);
// var personInfo = JSON.parse(data);
// console.log(personInfo);
});
</script>
</html>
4.消息发布调用方式
…
/**
* 测试报警推送服务:主要应用一个方法pushArr
*/
@GetMapping("/pushMessage")
@ApiOperation( "测试消息推送" )
public void pushMessage(){
Socketio socketio = new Socketio();
//这里发送的消息内容可以结合具体场景自定义对象
socketio.pushArr("connect_msg", "今天下午2点开会");
}
…
5.效果
通过访问测试服务请求 可看到如下效果:
6.附件
客户端相关js代码:client.rar