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