websocket框架netty和springboot的集成使用
maven依赖
<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>
配置类
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; } }
服务类
@Component public class NettyServer { private static final Logger log = LoggerFactory.getLogger(NettyServer.class); /** * webSocket协议名 */ private static final String WEBSOCKET_PROTOCOL = "WebSocket"; /** * 端口号 */ @Value("${webSocket.netty.port:8090}") private int port; /** * webSocket路径 */ @Value("${webSocket.netty.path:/webSocket}") 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(new InetSocketAddress(port)); // 连接到达时会创建一个通道 bootstrap.childHandler(new ChannelInitializer<SocketChannel>() { @Override protected void initChannel(SocketChannel ch) throws Exception { // 流水线管理通道中的处理程序（Handler），用来处理业务 // webSocket协议本身是基于http协议的，所以这边也要使用http编解码器 ch.pipeline().addLast(new HttpServerCodec()); ch.pipeline().addLast(new ObjectEncoder()); // 以块的方式来写的处理器 ch.pipeline().addLast(new ChunkedWriteHandler()); /* 说明： 1、http数据在传输过程中是分段的，HttpObjectAggregator可以将多个段聚合 2、这就是为什么，当浏览器发送大量数据时，就会发送多次http请求 */ ch.pipeline().addLast(new HttpObjectAggregator(8192)); //针对客户端，若10s内无读事件则触发心跳处理方法HeartBeatHandler#userEventTriggered ch.pipeline().addLast(new IdleStateHandler(10 , 0 , 0)); //自定义空闲状态检测(自定义心跳检测handler) ch.pipeline().addLast(new HeartBeatHandler()); /* 说明： 1、对应webSocket，它的数据是以帧（frame）的形式传递 2、浏览器请求时 ws://localhost:58080/xxx 表示请求的uri 3、核心功能是将http协议升级为ws协议，保持长连接 */ ch.pipeline().addLast(new WebSocketServerProtocolHandler(webSocketPath, WEBSOCKET_PROTOCOL, true, 65536 * 10)); // 自定义的handler，处理业务逻辑 ch.pipeline().addLast(webSocketHandler); } }); // 配置完成，开始绑定server，通过调用sync同步方法阻塞直到绑定成功 ChannelFuture channelFuture = bootstrap.bind().sync(); log.info("Server started and listen on:{}",channelFuture.channel().localAddress()); // 对关闭通道进行监听 channelFuture.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 服务器 new Thread(() -> { try { start(); } catch (InterruptedException e) { e.printStackTrace(); } }).start(); } }
处理类
@Component @ChannelHandler.Sharable public class WebSocketHandler extends SimpleChannelInboundHandler<TextWebSocketFrame> { private static final Logger log = LoggerFactory.getLogger(WebSocketHandler.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()); // 获取用户名 JSONObject jsonObject = JSONUtil.parseObj(msg.text()); String uid = jsonObject.getStr("uid"); // 将用户名作为自定义属性加入到channel中，方便随时channel中获取用户名 AttributeKey<String> key = AttributeKey.valueOf("uid"); ctx.channel().attr(key).setIfAbsent(uid); // 关联channel NettyConfig.getUserChannelMap().put(uid,ctx.channel()); // 回复消息 ctx.channel().writeAndFlush(new TextWebSocketFrame("{\"code\":202,\"msg\":\"successConnect\"}")); } @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("uid"); String userName = ctx.channel().attr(key).get(); NettyConfig.getUserChannelMap().remove(userName); } }
心跳包测试处理类
public class HeartBeatHandler extends ChannelInboundHandlerAdapter { private int lossConnectCount = 0; @Override public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception { if (evt instanceof IdleStateEvent){ IdleStateEvent event = (IdleStateEvent)evt; if (event.state()== IdleState.READER_IDLE){ lossConnectCount ++; if (lossConnectCount > 2){ ctx.channel().close(); } } }else { super.userEventTriggered(ctx,evt); } } }
消息对象的封装
public class NettyPushMessageBody implements Serializable { private static final long serialVersionUID = 1L; private String uid; private String message; public String getUid() { return uid; } public void setUid(String uid) { this.uid = uid; } public String getMessage() { return message; } public void setMessage(String message) { this.message = message; } @Override public String toString() { return "NettyPushMessageBody{" + "uid='" + uid + '\'' + ", message='" + message + '\'' + '}'; } }
消息发送
@Component public class MessageReceive { /** * 订阅消息,发送给指定用户 * @param object */ public void getMessageToOne(String object) { Jackson2JsonRedisSerializer serializer = getSerializer(NettyPushMessageBody.class); NettyPushMessageBody pushMessageBody = (NettyPushMessageBody) serializer.deserialize(object.getBytes()); System.err.println("订阅消息,发送给指定用户：" + pushMessageBody.toString()); // 推送消息 String message = pushMessageBody.getMessage(); String userId = pushMessageBody.getUid(); ConcurrentHashMap<String, Channel> userChannelMap = NettyConfig.getUserChannelMap(); Channel channel = userChannelMap.get(userId); if(!Objects.isNull(channel)){ // 如果该用户的客户端是与本服务器建立的channel,直接推送消息 channel.writeAndFlush(new TextWebSocketFrame(message)); } } /** * 订阅消息，发送给所有用户 * @param object */ public void getMessageToAll(String object) { Jackson2JsonRedisSerializer serializer = getSerializer(String.class); String message = (String) serializer.deserialize(object.getBytes()); System.err.println("订阅消息，发送给所有用户：" + message); NettyConfig.getChannelGroup().writeAndFlush(new TextWebSocketFrame(message)); } private Jackson2JsonRedisSerializer getSerializer(Class clazz){ //序列化对象（特别注意：发布的时候需要设置序列化；订阅方也需要设置序列化） Jackson2JsonRedisSerializer seria = new Jackson2JsonRedisSerializer(clazz); ObjectMapper objectMapper = new ObjectMapper(); objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL); seria.setObjectMapper(objectMapper); return seria; } }
service服务层
public interface PushService { /** * 推送给指定用户 * @param userName * @param msg */ void pushMsgToOne(String userName,String msg); /** * 推送给所有用户 * @param msg */ void pushMsgToAll(String msg); }
服务实现层
@Service public class PushServiceImpl implements PushService { @Autowired private RedisTemplate redisTemplate; @Override public void pushMsgToOne(String uid, String msg){ ConcurrentHashMap<String, Channel> userChannelMap = NettyConfig.getUserChannelMap(); Channel channel = userChannelMap.get(uid); if(!Objects.isNull(channel)){ // 如果该用户的客户端是与本服务器建立的channel,直接推送消息 channel.writeAndFlush(new TextWebSocketFrame(msg)); }else { // 发布，给其他服务器消费 NettyPushMessageBody pushMessageBody = new NettyPushMessageBody(); pushMessageBody.setUid(uid); pushMessageBody.setMessage(msg); redisTemplate.convertAndSend(Constants.PUSH_MESSAGE_TO_ONE,pushMessageBody); } } @Override public void pushMsgToAll(String msg){ // 发布，给其他服务器消费 redisTemplate.convertAndSend(Constants.PUSH_MESSAGE_TO_ALL,msg); // NettyConfig.getChannelGroup().writeAndFlush(new TextWebSocketFrame(msg)); } }
