Spring boot 集成netty实现websocket通信

一、netty介绍

Netty 是一个基于NIO的客户、服务器端的编程框架，使用Netty 可以确保你快速和简单的开发出一个网络应用，例如实现了某种协议的客户、服务端应用。Netty相当于简化和流线化了网络应用的编程开发过程，例如：基于TCP和UDP的socket服务开发。快速”和“简单”并不用产生维护性或性能上的问题。Netty 是一个吸收了多种协议（包括FTP、SMTP、HTTP等各种二进制文本协议）的实现经验，并经过相当精心设计的项目。最终，Netty 成功的找到了一种方式，在保证易于开发的同时还保证了其应用的性能，稳定性和伸缩性

二、工程搭建

实验目标：实现推送消息给指定的用户

pom.xml

 
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><parent><artifactId>springboot-demo</artifactId><groupId>com.et</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion><artifactId>netty</artifactId><properties><maven.compiler.source>8</maven.compiler.source><maven.compiler.target>8</maven.compiler.target></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-autoconfigure</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>io.netty</groupId><artifactId>netty-all</artifactId><version>4.1.87.Final</version></dependency><dependency><groupId>cn.hutool</groupId><artifactId>hutool-all</artifactId><version>5.6.1</version></dependency></dependencies>
</project>
 
属性文件
 
 
server:port: 8088
 
netty server
 
 
package com.et.netty.server;import com.et.netty.config.ProjectInitializer;
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;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 dongliang7* @projectName websocket-parent* @ClassName NettyServer.java* @description: TODO* @createTime 2023年02月06日 16:41:00*/
@Component
public class NettyServer {static final Logger log = LoggerFactory.getLogger(NettyServer.class);/*** 端口号*/@Value("${webSocket.netty.port:8889}")int port;EventLoopGroup bossGroup;EventLoopGroup workGroup;@AutowiredProjectInitializer nettyInitializer;@PostConstructpublic void start() throws InterruptedException {new Thread(() -> {bossGroup = new NioEventLoopGroup();workGroup = new NioEventLoopGroup();ServerBootstrap bootstrap = new ServerBootstrap();// bossGroup辅助客户端的tcp连接请求, workGroup负责与客户端之前的读写操作bootstrap.group(bossGroup, workGroup);// 设置NIO类型的channelbootstrap.channel(NioServerSocketChannel.class);// 设置监听端口bootstrap.localAddress(new InetSocketAddress(port));// 设置管道bootstrap.childHandler(nettyInitializer);// 配置完成，开始绑定server，通过调用sync同步方法阻塞直到绑定成功ChannelFuture channelFuture = null;try {channelFuture = bootstrap.bind().sync();log.info("Server started and listen on:{}", channelFuture.channel().localAddress());// 对关闭通道进行监听channelFuture.channel().closeFuture().sync();} catch (InterruptedException e) {e.printStackTrace();}}).start();}/*** 释放资源*/@PreDestroypublic void destroy() throws InterruptedException {if (bossGroup != null) {bossGroup.shutdownGracefully().sync();}if (workGroup != null) {workGroup.shutdownGracefully().sync();}}
}
 
ProjectInitializer
 
初始化，设置websocket handler
 
 
package com.et.netty.config;import com.et.netty.handler.WebSocketHandler;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;
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.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;/*** @author dongliang7* @projectName websocket-parent* @ClassName ProjectInitializer.java* @description: 管道配置* @createTime 2023年02月06日 16:43:00*/
@Component
public class ProjectInitializer extends ChannelInitializer<SocketChannel> {/*** webSocket协议名*/static final String WEBSOCKET_PROTOCOL = "WebSocket";/*** webSocket路径*/@Value("${webSocket.netty.path:/webSocket}")String webSocketPath;@AutowiredWebSocketHandler webSocketHandler;@Overrideprotected void initChannel(SocketChannel socketChannel) throws Exception {// 设置管道ChannelPipeline pipeline = socketChannel.pipeline();// 流水线管理通道中的处理程序（Handler），用来处理业务// webSocket协议本身是基于http协议的，所以这边也要使用http编解码器pipeline.addLast(new HttpServerCodec());pipeline.addLast(new ObjectEncoder());// 以块的方式来写的处理器pipeline.addLast(new ChunkedWriteHandler());pipeline.addLast(new HttpObjectAggregator(8192));pipeline.addLast(new WebSocketServerProtocolHandler(webSocketPath, WEBSOCKET_PROTOCOL, true, 65536 * 10));// 自定义的handler，处理业务逻辑pipeline.addLast(webSocketHandler);}
}
 
WebSocketHandler
 
 
package com.et.netty.handler;import cn.hutool.json.JSONObject;
import cn.hutool.json.JSONUtil;
import com.et.netty.config.NettyConfig;
import com.et.netty.server.NettyServer;
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;/*** @author dongliang7* @projectName websocket-parent* @ClassName WebSocketHandler.java* @description: TODO* @createTime 2023年02月06日 16:44:00*/
@Component
@ChannelHandler.Sharable
public class WebSocketHandler extends SimpleChannelInboundHandler<TextWebSocketFrame> {private static final Logger log = LoggerFactory.getLogger(NettyServer.class);/*** 一旦连接，第一个被执行*/@Overridepublic void handlerAdded(ChannelHandlerContext ctx) throws Exception {log.info("有新的客户端链接：[{}]", ctx.channel().id().asLongText());// 添加到channelGroup 通道组NettyConfig.getChannelGroup().add(ctx.channel());}/*** 读取数据*/@Overrideprotected void channelRead0(ChannelHandlerContext ctx, TextWebSocketFrame msg) throws Exception {log.info("服务器收到消息：{}", msg.text());// 获取用户ID,关联channelJSONObject jsonObject = JSONUtil.parseObj(msg.text());String uid = jsonObject.getStr("uid");NettyConfig.getChannelMap().put(uid, ctx.channel());// 将用户ID作为自定义属性加入到channel中，方便随时channel中获取用户IDAttributeKey<String> key = AttributeKey.valueOf("userId");ctx.channel().attr(key).setIfAbsent(uid);// 回复消息ctx.channel().writeAndFlush(new TextWebSocketFrame("服务器收到消息啦"));}@Overridepublic void handlerRemoved(ChannelHandlerContext ctx) throws Exception {log.info("用户下线了:{}", ctx.channel().id().asLongText());// 删除通道NettyConfig.getChannelGroup().remove(ctx.channel());removeUserId(ctx);}@Overridepublic void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {log.info("异常：{}", cause.getMessage());// 删除通道NettyConfig.getChannelGroup().remove(ctx.channel());removeUserId(ctx);ctx.close();}/*** 删除用户与channel的对应关系*/private void removeUserId(ChannelHandlerContext ctx) {AttributeKey<String> key = AttributeKey.valueOf("userId");String userId = ctx.channel().attr(key).get();NettyConfig.getChannelMap().remove(userId);}
}
 
NettyConfig
 
 
package com.et.netty.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 dongliang7* @projectName websocket-parent* @ClassName NettyConfig.java* @description: 管理全局Channel以及用户对应的channel（推送消息）* @createTime 2023年02月06日 16:43:00*/
public class NettyConfig {/*** 定义全局单利channel组 管理所有channel*/private static volatile ChannelGroup channelGroup = null;/*** 存放请求ID与channel的对应关系*/private static volatile ConcurrentHashMap<String, Channel> channelMap = null;/*** 定义两把锁*/private static final Object lock1 = new Object();private static final Object lock2 = new Object();public static ChannelGroup getChannelGroup() {if (null == channelGroup) {synchronized (lock1) {if (null == channelGroup) {channelGroup = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE);}}}return channelGroup;}public static ConcurrentHashMap<String, Channel> getChannelMap() {if (null == channelMap) {synchronized (lock2) {if (null == channelMap) {channelMap = new ConcurrentHashMap<>();}}}return channelMap;}public static Channel getChannel(String userId) {if (null == channelMap) {return getChannelMap().get(userId);}return channelMap.get(userId);}
}
 
controller
 
 
package com.et.netty.controller;import com.et.netty.service.PushMsgService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;/*** @author dongliang7* @projectName* @ClassName TestController.java* @description: TODO* @createTime 2023年02月06日 17:48:00*/
@RestController
@RequestMapping("/push")
public class TestController {@AutowiredPushMsgService pushMsgService;/*** 推送消息到具体客户端* @param uid*/@GetMapping("/{uid}")public void pushOne(@PathVariable String uid) {pushMsgService.pushMsgToOne(uid, "hello-------------------------");}/*** 推送消息到所有客户端*/@GetMapping("/pushAll")public void pushAll() {pushMsgService.pushMsgToAll("hello all-------------------------");}
}
 
PushMsgService
 
package com.et.netty.service;/*** @author dongliang7* @projectName websocket-parent* @ClassName PushMsgService.java* @description: 推送消息接口* @createTime 2023年02月06日 16:44:00*/
public interface PushMsgService {/*** 推送给指定用户*/void pushMsgToOne(String userId, String msg);/*** 推送给所有用户*/void pushMsgToAll(String msg);
}
 
PushMsgServiceImpl
 
package com.et.netty.service;import com.et.netty.config.NettyConfig;
import io.netty.channel.Channel;
import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;
import org.springframework.stereotype.Service;import java.util.Objects;/*** @author dongliang7* @projectName websocket-parent* @ClassName PushMsgServiceImpl.java* @description: 推送消息实现类* @createTime 2023年02月06日 16:45:00*/
@Service
public class PushMsgServiceImpl implements PushMsgService {@Overridepublic void pushMsgToOne(String userId, String msg) {Channel channel = NettyConfig.getChannel(userId);if (Objects.isNull(channel)) {throw new RuntimeException("未连接socket服务器");}channel.writeAndFlush(new TextWebSocketFrame(msg));}@Overridepublic void pushMsgToAll(String msg) {NettyConfig.getChannelGroup().writeAndFlush(new TextWebSocketFrame(msg));}
}
 
文章值贴出部分关键代码，具体的详情代码参加代码仓库的netty模块
 
代码仓库
 
  • https://github.com/Harries/springboot-demo
 
三、测试
 
启动springboot工程
 
2024-03-08 11:21:32.975  INFO 10348 --- [       Thread-2] com.et.netty.server.NettyServer          : Server started and listen on:/0:0:0:0:0:0:0:0:8889
 
postman创建websocket连接 ws://127.0.0.1:8889/webSocket，并发送消息{'uid':'sss'}给服务端95ed8191ebb1c8c9f021df580ed604bf.png打开浏览器，给用户sss推送消息 http://127.0.0.1:8088/push/sssbb8db40adbcff28d239bc1495dff7c36.png 
 
四、引用
 
  • https://www.cnblogs.com/dongl961230/p/17099057.html
  • http://www.liuhaihua.cn/archives/710299.html
 












本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/536241.html


如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！












相关文章










新手教程科普，手把手教你在bitget walelt用Uniswap








新手教程科普，手把手教你在bitget walelt用Uniswap




什么是 Uniswap (UNI)&#xff1f; 
Uniswap 是以太坊区块链上领先的去中心化交易所 (DEX)&#xff0c;允许用户交换和交易各种加密货币。 Uniswap 于 2018 年 11 月推出&#xff0c;是以太坊最早的 DApp 之一。目前有四个版本&#xff1b;其中V1、V2、V3都有开源代码库。 与 C…




阅读更多...

















JS数组相关知识








JS数组相关知识




获取数组的最大值/最小值&#xff1a; 
let arrary  [2,5,4]
let max  arrary[0]
for(let i  0;i<arrary.length;i){if(arrary[i]>max){max  arrary[i]}
}console.log(max);//查询数组最小值let arr  [2,21,34,23,45]
let min  arr[0]
for(let i 0;i<arr.length;i){if…




阅读更多...

















leetcode110.平衡二叉树








leetcode110.平衡二叉树




之前没有通过的样例  
return语句只写了一个 
return abs(l-r)<1缺少了 
isBalanced(root->left)&&isBalanced(root->right);补上就好了 
class Solution {
public:bool isBalanced(TreeNode* root) {if(!root){return true;}int lgetHeight(root->left);i…




阅读更多...

















每日OJ题_牛客HJ37 统计每个月兔子的总数（IO型OJ）








每日OJ题_牛客HJ37 统计每个月兔子的总数（IO型OJ）




目录 
牛客HJ37 统计每个月兔子的总数 
解析代码 牛客HJ37 统计每个月兔子的总数 
统计每个月兔子的总数_牛客题霸_牛客网 解析代码 
#include <iostream>
#include <vector>using namespace std;
int main()
{int n  0;cin >> n;vector<int> arr(n  1…




阅读更多...

















fastjson2 简单使用








fastjson2 简单使用




参考 
https://alibaba.github.io/fastjson2/ https://alibaba.github.io/fastjson2/annotations_cn.html https://alibaba.github.io/fastjson2/features_cn 
基本操作 
json 字符串转为 jsonObject&#xff1a; 
String json  "{\"name\":\"tom\",\…




阅读更多...

















【Python】python实现决策树算法和贝叶斯算法(附源代码）








【Python】python实现决策树算法和贝叶斯算法(附源代码）




使用一种你熟悉的程序设计语言&#xff0c;实现&#xff08;1&#xff09;贝叶斯算法和&#xff08;2&#xff09;决策树算法  目录 1、贝叶斯算法2、决策树算法3、两种算法比较 1、贝叶斯算法 
import pandas as pd
import numpy as np
from sklearn.model_selection import t…




阅读更多...

















Apache Paimon系列之：认识Paimon








Apache Paimon系列之：认识Paimon




Apache Paimon系列之&#xff1a;认识Paimon 一、认识Paimon二、统一存储三、基本概念1.文件布局2.Snapshot3.清单文件4.数据文件5.分区6.一致性保证 一、认识Paimon 
Apache Paimon的架构&#xff1a;  如上架构所示&#xff1a; 
读/写&#xff1a;Paimon 支持多种读/写数据和…




阅读更多...

















Mybatis 实体类类型参数传入sql语句








Mybatis 实体类类型参数传入sql语句




1.Mapper接口中抽象方法的声明&#xff0c;将实体信息传入到数据库表中。 
int insertEmployee(Employee employee);2.SQL语句 
<insert id"insertEmployee">insert into t_emp(emp_name,emp_salary) values(#{empName},#{empSalary})
</insert>3.对应关…




阅读更多...

















媒体单位专用小记者报名及各类活动报名系统介绍








媒体单位专用小记者报名及各类活动报名系统介绍




媒体单位专用小记者报名及各类活动报名系统介绍 
小记者活动鼓励孩子们关注生活和社会&#xff0c;丰富成长体验&#xff0c;开启心智&#xff0c;淬砺思想。这不仅有助于提高他们的理性思辨力&#xff0c;还能培养他们的社会责任感和公民意识。小记者活动为学生提供了一个全新…




阅读更多...

















C语言易错知识点：scanf函数








C语言易错知识点：scanf函数




scanf在C语言学习中比较常用&#xff0c;但因为其涉及屏幕缓冲区导致有的时候会调入陷阱&#xff0c;下面分享一下常见的需要注意的事项&#xff1a; 
1.输入末尾带有回车\n 
当我们输入数据后&#xff0c;最后按下回车时&#xff0c;屏幕缓冲区的末尾都会含有这个字符 scanf的…




阅读更多...

















String类及其常用方法








String类及其常用方法




文章目录 1.String类的特性与使用1.1 String类的特性1.2 String对象的创建方式1.3 String 的使用&#xff08;不同的拼接操作&#xff09; 2.String常用方法2.1 String的常用方法一2.2 String常用方法二2.3 String常用方法三 1.String类的特性与使用 
1.1 String类的特性 
Stri…




阅读更多...

















Linux常用操作命令








Linux常用操作命令




Linux常用操作命令 1.文件管理catfile 2.文档编辑3.文件传输4.磁盘管理5.磁盘维护6.网络通讯7.系统管理8.系统设置9.备份压缩10.设备管理 Linux 英文解释为 Linux is not Unix。 Linux内核最初只是由芬兰人李纳斯托瓦兹&#xff08;Linus Torvalds&#xff09;在赫尔辛基大学上…




阅读更多...


















推荐文章












最新文章


















Copyright @ 2022~2023