Springboot整合Netty自定義協議實現示例詳解
更新時間：2022年11月25日 09:55:55 作者：鱷魚兒
這篇文章主要為大家介紹了Springboot整合Netty自定義協議實現示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪
引言
Netty是由JBOSS提供的一個java開源框架，現為 Github上的獨立項目。Netty提供異步的、事件驅動的網絡應用程序框架和工具，用以快速開發(fā)高性能、高可靠性的網絡服務器和客戶端程序。
也就是說，Netty 是一個基于NIO的客戶、服務器端的編程框架，使用Netty 可以確保你快速和簡單的開發(fā)出一個網絡應用，例如實現了某種協議的客戶、服務端應用。Netty相當于簡化和流線化了網絡應用的編程開發(fā)過程。
Springboot整合Netty
導入netty包
新建springboot項目，并在項目以來中導入netty包，用fastjson包處理jsonStr。
<!-- netty -->
<dependency>
<groupId>io.netty</groupId>
<artifactId>netty-all</artifactId>
<version>4.1.42.Final</version>
</dependency>
<!-- Json處理 -->
<dependency>
<groupId>com.alibaba.fastjson2</groupId>
<artifactId>fastjson2</artifactId>
<version>2.0.16</version>
</dependency>
創(chuàng)建netty相關配置信息文件
- yml配置文件——application.yml
# netty 配置 netty: # boss線程數量 boss: 4 # worker線程數量 worker: 2 # 連接超時時間 timeout: 6000 # 服務器主端口 port: 18023 # 服務器備用端口 portSalve: 18026 # 服務器地址 host: 127.0.0.1
- netty配置實體類——NettyProperties與yml配置文件綁定 通過@ConfigurationProperties(prefix = "netty")注解讀取配置文件中的netty配置，通過反射注入值，需要在實體類中提供對應的setter和getter方法。
@ConfigurationProperties(prefix = "netty")對應的實體類屬性名稱不要求一定相同，只需保證“set”字符串拼接配置文件的屬性和setter方法名相同即可。
@Configuration
@ConfigurationProperties(prefix = "netty")
public class NettyProperties {
/**
* boss線程數量
*/
private Integer boss;
/**
* worker線程數量
*/
private Integer worker;
/**
* 連接超時時間
*/
private Integer timeout = 30000;
/**
* 服務器主端口
*/
private Integer port = 18023;
/**
* 服務器備用端口
*/
private Integer portSalve = 18026;
/**
* 服務器地址 默認為本地
*/
private String host = "127.0.0.1";
// setter、getter 。。。。
}
- 對netty進行配置，綁定netty相關配置設置 Netty通常由一個Bootstrap開始，主要作用是配置整個Netty程序，串聯各個組件，Netty中Bootstrap類是客戶端程序的啟動引導類，ServerBootstrap是服務端啟動引導類。
@Configuration
@EnableConfigurationProperties
public class NettyConfig {
final NettyProperties nettyProperties;
public NettyConfig(NettyProperties nettyProperties) {
this.nettyProperties = nettyProperties;
}
/**
* boss線程池-進行客戶端連接
*
* @return
*/
@Bean
public NioEventLoopGroup boosGroup() {
return new NioEventLoopGroup(nettyProperties.getBoss());
}
/**
* worker線程池-進行業(yè)務處理
*
* @return
*/
@Bean
public NioEventLoopGroup workerGroup() {
return new NioEventLoopGroup(nettyProperties.getWorker());
}
/**
* 服務端啟動器，監(jiān)聽客戶端連接
*
* @return
*/
@Bean
public ServerBootstrap serverBootstrap() {
ServerBootstrap serverBootstrap = new ServerBootstrap()
// 指定使用的線程組
.group(boosGroup(), workerGroup())
// 指定使用的通道
.channel(NioServerSocketChannel.class)
// 指定連接超時時間
.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, nettyProperties.getTimeout())
// 指定worker處理器
.childHandler(new NettyServerHandler());
return serverBootstrap;
}
}
- worker處理器，初始化通道以及配置對應管道的處理器 自定義了
##@##分割符 - 通過
DelimiterBasedFrameDecoder來處理拆包沾包問題； - 通過
MessageDecodeHandler將接收消息解碼處理成對象實例； - 通過
MessageEncodeHandler將發(fā)送消息增加分割符后并編碼； 最后通過ServerListenerHandler根據消息類型對應處理不同消息。
public class NettyServerHandler extends ChannelInitializer<SocketChannel> {
@Override
protected void initChannel(SocketChannel socketChannel) throws Exception {
// 數據分割符
String delimiterStr = "##@##";
ByteBuf delimiter = Unpooled.copiedBuffer(delimiterStr.getBytes());
ChannelPipeline pipeline = socketChannel.pipeline();
// 使用自定義處理拆包/沾包，并且每次查找的最大長度為1024字節(jié)
pipeline.addLast(new DelimiterBasedFrameDecoder(1024, delimiter));
// 將上一步解碼后的數據轉碼為Message實例
pipeline.addLast(new MessageDecodeHandler());
// 對發(fā)送客戶端的數據進行編碼，并添加數據分隔符
pipeline.addLast(new MessageEncodeHandler(delimiterStr));
// 對數據進行最終處理
pipeline.addLast(new ServerListenerHandler());
}
}
數據解碼 編碼
數據解碼和編碼都采用UTF8格式
public class MessageDecodeHandler extends ByteToMessageDecoder {
@Override
protected void decode(ChannelHandlerContext channelHandlerContext, ByteBuf in, List<Object> list) throws Exception {
ByteBuf frame = in.retainedDuplicate();
final String content = frame.toString(CharsetUtil.UTF_8);
Message message = new Message(content);
list.add(message);
in.skipBytes(in.readableBytes());
}
}
- 數據解碼轉換的實例 Message類用于承載消息、轉JsonString
public class Message {
/**
* 數據長度
*/
private Integer len;
/**
* 接收的通訊數據body
*/
private String content;
/**
* 消息類型
*/
private Integer msgType;
public Message(Object object) {
String str = object.toString();
JSONObject jsonObject = JSONObject.parseObject(str);
msgType = Integer.valueOf(jsonObject.getString("msg_type"));
content = jsonObject.getString("body");
len = str.length();
}
public String toJsonString() {
return "{" +
"\"msg_type\": " + msgType + ",\n" +
"\"body\": " + content +
"}";
}
// setter、getter 。。。。
}
- 數據編碼 netty服務端回復消息時，對消息轉JsonString增加分割符，并進行編碼。
public class MessageEncodeHandler extends MessageToByteEncoder<Message> {
// 數據分割符
String delimiter;
public MessageEncodeHandler(String delimiter) {
this.delimiter = delimiter;
}
@Override
protected void encode(ChannelHandlerContext channelHandlerContext, Message message, ByteBuf out) throws Exception {
out.writeBytes((message.toJsonString() + delimiter).getBytes(CharsetUtil.UTF_8));
}
}
- 數據處理器，針對不同類型數據分類處理 在處理不同接收數據時使用了枚舉類型，在使用switch時可以做下處理，具體參考代碼，這里只演示如何操作，并沒實現數據處理業(yè)務類。
public class ServerListenerHandler extends SimpleChannelInboundHandler<Message> {
private static final Logger log = LoggerFactory.getLogger(ServerListenerHandler.class);
/**
* 設備接入連接時處理
*
* @param ctx
*/
@Override
public void handlerAdded(ChannelHandlerContext ctx) {
log.info("有新的連接：[{}]", ctx.channel().id().asLongText());
}
/**
* 數據處理
*
* @param ctx
* @param msg
*/
@Override
protected void channelRead0(ChannelHandlerContext ctx, Message msg) {
// 獲取消息實例中的消息體
String content = msg.getContent();
// 對不同消息類型進行處理
MessageEnum type = MessageEnum.getStructureEnum(msg);
switch (type) {
case CONNECT:
// TODO 心跳消息處理
case STATE:
// TODO 設備狀態(tài)
default:
System.out.println(type.content + "消息內容" + content);
}
}
/**
* 設備下線處理
*
* @param ctx
*/
@Override
public void handlerRemoved(ChannelHandlerContext ctx) {
log.info("設備下線了:{}", ctx.channel().id().asLongText());
}
/**
* 設備連接異常處理
*
* @param ctx
* @param cause
*/
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) {
// 打印異常
log.info("異常：{}", cause.getMessage());
// 關閉連接
ctx.close();
}
}
- 數據類型枚舉類
public enum MessageEnum {
CONNECT(1, "心跳消息"),
STATE(2, "設備狀態(tài)");
public final Integer type;
public final String content;
MessageEnum(Integer type, String content) {
this.type = type;
this.content = content;
}
// case中判斷使用
public static MessageEnum getStructureEnum(Message msg) {
Integer type = Optional.ofNullable(msg)
.map(Message::getMsgType)
.orElse(0);
if (type == 0) {
return null;
} else {
List<MessageEnum> objectEnums = Arrays.stream(MessageEnum.values())
.filter((item) -> item.getType() == type)
.distinct()
.collect(Collectors.toList());
if (objectEnums.size() > 0) {
return objectEnums.get(0);
}
return null;
}
}
// setter、getter。。。。
}
到此Netty整個配置已經完成，但如果要跟隨springboot一起啟動，仍需要做一些配置。
netty啟動類配置
@Component
public class NettyServerBoot {
private static final Logger log = LoggerFactory.getLogger(NettyServerBoot.class);
@Resource
NioEventLoopGroup boosGroup;
@Resource
NioEventLoopGroup workerGroup;
final ServerBootstrap serverBootstrap;
final NettyProperties nettyProperties;
public NettyServerBoot(ServerBootstrap serverBootstrap, NettyProperties nettyProperties) {
this.serverBootstrap = serverBootstrap;
this.nettyProperties = nettyProperties;
}
/**
* 啟動netty
*
* @throws InterruptedException
*/
@PostConstruct
public void start() throws InterruptedException {
// 綁定端口啟動
serverBootstrap.bind(nettyProperties.getPort()).sync();
// 備用端口
serverBootstrap.bind(nettyProperties.getPortSalve()).sync();
log.info("啟動Netty: {},{}", nettyProperties.getPort(), nettyProperties.getPortSalve());
}
/**
* 關閉netty
*/
@PreDestroy
public void close() {
log.info("關閉Netty");
boosGroup.shutdownGracefully();
workerGroup.shutdownGracefully();
}
}
增加NettyServerBoot配置后，啟動application時，netty服務端會跟隨一起啟動。
同時，在springboot關閉前，會先銷毀netty服務。
完整源碼
以上就是Springboot整合Netty自定義協議實現示例詳解的詳細內容，更多關于Springboot整合Netty自定義協議的資料請關注腳本之家其它相關文章！
相關文章
springboot集成JWT實現身份認證(權鑒)的方法步驟
本文主要介紹了springboot集成JWT實現身份認證(權鑒)的方法步驟，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-04-04
這篇文章主要介紹了Java遍歷Map集合的方法,遍歷map的key集合然后通過key獲取value,本文給大家講解的非常詳細,需要的朋友可以參考下2024-05-05
今天小編就為大家分享一篇關于Java中extends一定是代表繼承嗎?，小編覺得內容挺不錯的，現在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2019-01-01
這篇文章主要介紹如何在spring boot中引入log4j，以及一些基礎用法，需要的朋友可以參考借鑒，下面來一起看看吧。2017-02-02
Java SpringBoot微服務框架驗證碼報錯問題解決方案
這篇文章主要介紹了Java SpringBoot微服務框架驗證碼報錯問題解決方案,包括dockerfile容器操作和完整dockerfile,本文給大家介紹的非常詳細,需要的朋友可以參考下2024-08-08
這篇文章主要介紹了Maven進階教程的相關資料，文中講解非常細致，幫助大家開始學習maven，感興趣的朋友可以了解下，希望能夠給你帶來幫助2021-08-08
Java中IdentityHashMap與HashMap區(qū)別詳解
這篇文章主要介紹了Java中IdentityHashMap與HashMap區(qū)別詳解,很多人不曉得IdentityHashMap的存在,其中不乏工作很多年的Java開發(fā)者,他們看到就說是第三方jar包,實際上它是Jdk源碼自帶的集合類,需要的朋友可以參考下2023-11-11
Java中ResultSetMetaData 元數據的具體使用
本文主要介紹了Java中ResultSetMetaData 元數據的具體使用，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-04-04
SpringMVC中利用@InitBinder來對頁面數據進行解析綁定的方法
本篇文章主要介紹了SpringMVC中利用@InitBinder來對頁面數據進行解析綁定的方法，非常具有實用價值，需要的朋友可以參考下2018-03-03
這篇文章主要為大家分享了最有價值的6道線程池面試題，涵蓋內容全面，包括數據結構和算法相關的題目、經典面試編程題等，對hashCode方法的設計、垃圾收集的堆和代進行剖析，感興趣的小伙伴們可以參考一下2021-06-06