SpringBoot+WebSocket+Netty实现消息推送
实现基本步骤
1 前端使用webSocket与服务端创建连接的时候，将用户ID传给服务端
2 服务端将用户ID与channel关联起来存储，同时将channel放入到channel组中
3 如果需要给所有用户发送消息，直接执行channel组的writeAndFlush()方法
4 如果需要给指定用户发送消息，根据用户ID查询到对应的channel,然后执行writeAndFlush()方法
5 前端获取到服务端推送的消息之后，将消息内容展示到文本域中
1.引入Netty的依赖，和一个工具包（只用到了json工具，可用其他json工具代替）
<dependency>
<groupId>io.netty</groupId>
<artifactId>netty-all</artifactId>
<version>4.1.33.Final</version>
</dependency>
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.2.3</version>
</dependency>
2.在NettyConfig中定义一个channel组，管理所有的channel，再定义一个map，管理用户与channel的对应关系。
package com.sixj.nettypush.config;
import io.netty.channel.Channel;
import io.netty.channel.group.ChannelGroup;
import io.netty.channel.group.DefaultChannelGroup;
import io.netty.util.concurrent.GlobalEventExecutor;
import java.util.concurrent.ConcurrentHashMap;
/** * @author sixiaojie * @date 2020-03-28-15:07 */
public class NettyConfig {
/** * 定义一个channel组，管理所有的channel * GlobalEventExecutor.INSTANCE 是全局的事件执行器，是一个单例 */
private static ChannelGroup channelGroup = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE);
/** * 存放用户与Chanel的对应信息，用于给指定用户发送消息 */
private static ConcurrentHashMap<String,Channel> userChannelMap = new ConcurrentHashMap<>();
private NettyConfig() {}
/** * 获取channel组 * @return */
public static ChannelGroup getChannelGroup() {
return channelGroup;
}
/** * 获取用户channel map * @return */
public static ConcurrentHashMap<String,Channel> getUserChannelMap(){
return userChannelMap;
}
}
3.创建NettyServer，定义两个EventLoopGroup，bossGroup辅助客户端的tcp连接请求, workGroup负责与客户端之前的读写操作，需要说明的是，需要开启一个新的线程来执行netty server，要不然会阻塞主线程，到时候就无法调用项目的其他controller接口了。
package com.sixj.nettypush.websocket;
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.codec.http.HttpObjectAggregator;
import io.netty.handler.codec.http.HttpServerCodec;
import io.netty.handler.codec.http.websocketx.WebSocketServerProtocolHandler;
import io.netty.handler.codec.serialization.ObjectEncoder;
import io.netty.handler.stream.ChunkedWriteHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.net.InetSocketAddress;
/** * @author sixiaojie * @date 2020-03-28-13:44 */
@Component
public class nettyservice {
/** * webSocket协议名 */
private static final String WEBSOCKET_PROTOCOL = "WebSocket";
@Value("${webSocket.netty.port}")
private int port;
@Value("${webSocket.netty.path}")
private String webSocketPath;
@Autowired
private WebSocketHandler webSocketHandler;
private EventLoopGroup bossGroup;
private EventLoopGroup workGroup;
/** * 启动 * @throws InterruptedException */
private void start() throws InterruptedException {
bossGroup = new NioEventLoopGroup();
workGroup = new NioEventLoopGroup();
ServerBootstrap bootstrap = new ServerBootstrap();
// bossGroup辅助客户端的tcp连接请求, workGroup负责与客户端之前的读写操作
bootstrap.group(bossGroup,workGroup);
// 设置NIO类型的channel
bootstrap.channel(NioServerSocketChannel.class);
//设置监听端口
bootstrap.localAddress(this.port);
// 连接到达时会创建一个通道
bootstrap.childHandler(new ChannelInitializer<SocketChannel>() {
@Override
protected void initChannel(SocketChannel socketChannel) throws Exception {
System.out.println("-------------------收到新的连接");
// 流水线管理通道中的处理程序（Handler），用来处理业务
// webSocket协议本身是基于http协议的，所以这边也要使用http编解码器
socketChannel.pipeline().addLast(new HttpServerCodec());
//socketChannel.pipeline().addLast(new ObjectEncoder());
// 以块的方式来写的处理器
socketChannel.pipeline().addLast(new ChunkedWriteHandler());
socketChannel.pipeline().addLast(new HttpObjectAggregator(8192));
/* 说明： 1、http数据在传输过程中是分段的，
HttpObjectAggregator可以将多个段聚合 2、这就是为什么，
当浏览器发送大量数据时，就会发送多次http请求 */
socketChannel.pipeline().addLast(new WebSocketServerProtocolHandler("/ws",WEBSOCKET_PROTOCOL,true,65536 * 10));
// 自定义的handler，处理业务逻辑
socketChannel.pipeline().addLast(new WebSocketHandler());
}
});
// 配置完成，开始绑定server，通过调用sync同步方法阻塞直到绑定成功
ChannelFuture future = bootstrap.bind().sync();
System.out.println(nettyservice.class + " 启动正在监听： " + future.channel().localAddress());
// 对关闭通道进行监听
future.channel().closeFuture().sync();
}
/** * 释放资源 * @throws InterruptedException */
@PreDestroy
public void destroy() throws InterruptedException {
if(bossGroup != null){
bossGroup.shutdownGracefully().sync();
}
if(workGroup != null){
workGroup.shutdownGracefully().sync();
}
}
@PostConstruct()
public void init() {
//需要开启一个新的线程来执行netty server 服务器
ThreadPoolExecutor executor = new ThreadPoolExecutor(8, 30, 200, TimeUnit.MILLISECONDS, new ArrayBlockingQueue<Runnable>(10));
executor.execute(() -> {
try {
start();
} catch (InterruptedException e) {
e.printStackTrace();
}
});
}
}
4.具体实现业务的WebSocketHandler，具体实现逻辑看注释
package com.sixj.nettypush.websocket;
import cn.hutool.json.JSONObject;
import cn.hutool.json.JSONUtil;
import com.sixj.nettypush.config.NettyConfig;
import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;
import io.netty.util.AttributeKey;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
/** * TextWebSocketFrame类型， 表示一个文本帧 * @author sixiaojie * @date 2020-03-28-13:47 */
@Component
@ChannelHandler.Sharable
public class WebSocketHandler extends SimpleChannelInboundHandler<TextWebSocketFrame> {
private static final Logger log = LoggerFactory.getLogger(NettyServer.class);
/** * 一旦连接，第一个被执行 * @param ctx * @throws Exception */
@Override
public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
log.info("handlerAdded 被调用"+ctx.channel().id().asLongText());
// 添加到channelGroup 通道组
NettyConfig.getChannelGroup().add(ctx.channel());
}
/** * 读取数据 */
@Override
protected void channelRead0(ChannelHandlerContext ctx, TextWebSocketFrame msg) throws Exception {
log.info("服务器收到消息：{}",msg.text());
// 获取用户ID,关联channel
JSONObject jsonObject = JSONUtil.parseObj(msg.text());
String uid = jsonObject.getStr("uid");
NettyConfig.getUserChannelMap().put(uid,ctx.channel());
// 将用户ID作为自定义属性加入到channel中，方便随时channel中获取用户ID
AttributeKey<String> key = AttributeKey.valueOf("userId");
ctx.channel().attr(key).setIfAbsent(uid);
// 回复消息
ctx.channel().writeAndFlush(new TextWebSocketFrame("服务器连接成功！"));
}
@Override
public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {
log.info("handlerRemoved 被调用"+ctx.channel().id().asLongText());
// 删除通道
NettyConfig.getChannelGroup().remove(ctx.channel());
removeUserId(ctx);
}
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
log.info("异常：{}",cause.getMessage());
// 删除通道
NettyConfig.getChannelGroup().remove(ctx.channel());
removeUserId(ctx);
ctx.close();
}
/** * 删除用户与channel的对应关系 * @param ctx */
private void removeUserId(ChannelHandlerContext ctx){
AttributeKey<String> key = AttributeKey.valueOf("userId");
String userId = ctx.channel().attr(key).get();
NettyConfig.getUserChannelMap().remove(userId);
}
}
5.具体消息推送的接口
public interface PushService {
/** * 推送给指定用户 * @param userId * @param msg */
void pushMsgToOne(String userId,String msg);
/** * 推送给所有用户 * @param msg */
void pushMsgToAll(String msg);
}
接口实现类：
import java.util.concurrent.ConcurrentHashMap;
/** * @author sixiaojie * @date 2020-03-30-20:10 */
@Service
public class PushServiceImpl implements PushService {
@Override
public void pushMsgToOne(String userId, String msg){
ConcurrentHashMap<String, Channel> userChannelMap = NettyConfig.getUserChannelMap();
Channel channel = userChannelMap.get(userId);
channel.writeAndFlush(new TextWebSocketFrame(msg));
}
@Override
public void pushMsgToAll(String msg){
NettyConfig.getChannelGroup().writeAndFlush(new TextWebSocketFrame(msg));
}
}
controller：
package com.sixj.nettypush.controller;
import com.sixj.nettypush.service.PushService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/** * @author sixiaojie * @date 2020-03-30-20:08 */
@RestController
@RequestMapping("/push")
public class PushController {
@Autowired
private PushService pushService;
/** * 推送给所有用户 * @param msg */
@PostMapping("/pushAll")
public void pushToAll(@RequestParam("msg") String msg){
pushService.pushMsgToAll(msg);
}
/** * 推送给指定用户 * @param userId * @param msg */
@PostMapping("/pushOne")
public void pushMsgToOne(@RequestParam("userId") String userId,@RequestParam("msg") String msg){
pushService.pushMsgToOne(userId,msg);
}
}
6.前端测试html页面
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<!--<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />-->
<meta charset="UTF-8">
<title>Netty-Websocket</title>
<script type="text/javascript">
// by zhengkai.blog.csdn.net
var socket;
if(!window.WebSocket){
window.WebSocket = window.MozWebSocket;
}
if(window.WebSocket){
socket = new WebSocket("ws://localhost:8011/ws");
socket.onmessage = function(event){
var ta = document.getElementById('responseText');
ta.value += event.data+"\r\n";
};
socket.onopen = function(event){
var ta = document.getElementById('responseText');
ta.value = "Netty-WebSocket服务器。。。。。。连接 \r\n";
};
socket.onclose = function(event){
var ta = document.getElementById('responseText');
ta.value = "Netty-WebSocket服务器。。。。。。关闭 \r\n";
};
}else{
alert("您的浏览器不支持WebSocket协议！");
}
function send(uid,message){
if(!window.WebSocket){return;}
if(socket.readyState == WebSocket.OPEN){
//var json = [];
var j = {};
j.uid = uid;
j.msg = message;
//json.push(j);
var jsonStr = JSON.stringify(j);
socket.send(jsonStr);
}else{
alert("WebSocket 连接没有建立成功！");
}
}
</script>
</head>
<body>
<form onSubmit="return false;">
<label>ID</label><input type="text" name="uid" th:value = "${uid}" /> <br />
<label>TEXT</label><input type="text" name="message" value="这里输111入消息" /> <br />
<br /> <input type="button" value="发送ws消息"
onClick="send(this.form.uid.value,this.form.message.value)" />
<hr color="black" />
<h3>服务端返回的应答消息</h3>
<textarea id="responseText" style="width: 1024px;height: 300px;"></textarea>
</form>
</body>
</html>
5298
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
