netty服务端发送信息并同步接收_SpringBoot整合Netty(附源码)

前言

本篇文章主要介绍的是SpringBoot整合Netty以及使用Protobuf进行数据传输的相关内容。Protobuf会简单的介绍下用法，至于Netty在之前的文章中已经简单的介绍过了，这里就不再过多细说了。

Protobuf

介绍

protocolbuffer(以下简称PB)是google 的一种数据交换的格式，它独立于语言，独立于平台。google 提供了多种语言的实现：java、c#、c++、go 和python，每一种实现都包含了相应语言的编译器以及库文件。

由于它是一种二进制的格式，比使用 xml进行数据交换快许多。可以把它用于分布式应用之间的数据通信或者异构环境下的数据交换。作为一种效率和兼容性都很优秀的二进制数据传输格式，可以用于诸如网络传输、配置文件、数据存储等诸多领域。

官方地址：

https://github.com/google/protobuf

使用

这里的使用就只介绍Java相关的使用。首先我们需要建立一个proto文件，在该文件定义我们需要传输的文件。

例如我们需要定义一个用户的信息，包含的字段主要有编号、名称、年龄。

那么该protobuf文件的格式如下:

注：这里使用的是proto3，相关的注释我已写了，这里便不再过多讲述了。需要注意一点的是proto文件和生成的Java文件名称不能一致!

syntax = "proto3";// 生成的包名option java_package="com.pancm.protobuf";//生成的java名option java_outer_classname = "UserInfo";message UserMsg {  // ID  int32 id = 1;  // 姓名  string name = 2;  // 年龄  int32 age = 3;  // 状态  int32 state = 4; } 

创建好该文件之后，我们把该文件和protoc.exe(生成Java文件的软件)放到E盘目录下的protobuf文件夹下，然后再到该目录的dos界面下输入:protoc.exe --java_out=文件绝对路径名称。

例如：

protoc.exe --java_out=E:protobuf User.proto

输入完之后，回车即可在同级目录看到已经生成好的Java文件，然后将该文件放到项目中该文件指定的路径下即可。

注：生成protobuf的文件软件和测试的protobuf文件我也整合到该项目中了，可以直接获取的。

Java文件生成好之后，我们再来看怎么使用。

这里我就直接贴代码了，并且将注释写在代码中，应该更容易理解些。

代码示例:

// 按照定义的数据结构，创建一个对象  UserInfo.UserMsg.Builder userInfo = UserInfo.UserMsg.newBuilder();  userInfo.setId(1); userInfo.setName("xuwujing"); userInfo.setAge(18); UserInfo.UserMsg userMsg = userInfo.build();  // 将数据写到输出流  ByteArrayOutputStream output = new ByteArrayOutputStream();  userMsg.writeTo(output);  // 将数据序列化后发送  byte[] byteArray = output.toByteArray();  // 接收到流并读取 ByteArrayInputStream input = new ByteArrayInputStream(byteArray);  // 反序列化  UserInfo.UserMsg userInfo2 = UserInfo.UserMsg.parseFrom(input);  System.out.println("id:" + userInfo2.getId());  System.out.println("name:" + userInfo2.getName());  System.out.println("age:" + userInfo2.getAge()); 

注：这里说明一点，因为protobuf是通过二进制进行传输，所以需要注意下相应的编码。还有使用protobuf也需要注意一下一次传输的最大字节长度。

输出结果：

id:1name:xuwujingage:18SpringBoot整合Netty

说明：如果想直接获取工程那么可以直接跳到底部，通过链接下载工程代码。

• 开发准备
• 环境要求
• JDK：1.8
• Netty: 4.0或以上(不包括5)
• Protobuf：3.0或以上

如果对Netty不熟的话，可以看看这些文章。大神请无视~。~

https://blog.csdn.net/column/details/17640.html

首先还是Maven的相关依赖:

UTF-81.84.1.22.Final3.5.11.5.9.RELEASE1.2.411.81.8org.springframework.boot spring-boot-starter ${springboot}org.springframework.boot spring-boot-starter-test ${springboot}testorg.springframework.boot spring-boot-devtools ${springboot}trueio.netty netty-all ${netty.version}com.google.protobuf protobuf-java ${protobuf.version}com.alibaba fastjson ${fastjson}junit junit 4.12test

添加了相应的maven依赖之后，配置文件这块暂时没有什么可以添加的，因为暂时就一个监听的端口而已。

代码编写

代码模块主要分为服务端和客户端。

主要实现的业务逻辑：

服务端启动成功之后，客户端也启动成功，这时服务端会发送一条protobuf格式的信息给客户端，然后客户端给予相应的应答。客户端与服务端连接成功之后，客户端每个一段时间会发送心跳指令给服务端，告诉服务端该客户端还存过中，如果客户端没有在指定的时间发送信息，服务端会关闭与该客户端的连接。当客户端无法连接到服务端之后，会每隔一段时间去尝试重连，只到重连成功!

服务端

首先是编写服务端的启动类，相应的注释在代码中写得很详细了，这里也不再过多讲述了。不过需要注意的是，在之前的我写的Netty文章中，是通过main方法直接启动服务端，因此是直接new一个对象的。而在和SpringBoot整合之后，我们需要将Netty交给springBoot去管理，所以这里就用了相应的注解。

代码如下:

@Service("nettyServer")public class NettyServer { private static final int port = 9876; // 设置服务端端口 private static EventLoopGroup boss = new NioEventLoopGroup(); // 通过nio方式来接收连接和处理连接 private static EventLoopGroup work = new NioEventLoopGroup(); // 通过nio方式来接收连接和处理连接 private static ServerBootstrap b = new ServerBootstrap(); @Autowired private NettyServerFilter nettyServerFilter; public void run() { try { b.group(boss, work); b.channel(NioServerSocketChannel.class); b.childHandler(nettyServerFilter); // 设置过滤器 // 服务器绑定端口监听 ChannelFuture f = b.bind(port).sync(); System.out.println("服务端启动成功,端口是:" + port); // 监听服务器关闭监听 f.channel().closeFuture().sync(); } catch (InterruptedException e) { e.printStackTrace(); } finally { // 关闭EventLoopGroup，释放掉所有资源包括创建的线程 work.shutdownGracefully(); boss.shutdownGracefully(); } }}

服务端主类编写完毕之后，我们再来设置下相应的过滤条件。

这里需要继承Netty中ChannelInitializer类，然后重写initChannel该方法，进行添加相应的设置，如心跳超时设置，传输协议设置，以及相应的业务实现类。

代码如下:

 @Component public class NettyServerFilter extends ChannelInitializer { @Autowired private NettyServerHandler nettyServerHandler; @Override protected void initChannel(SocketChannel ch) throws Exception { ChannelPipeline ph = ch.pipeline(); //入参说明: 读超时时间、写超时时间、所有类型的超时时间、时间格式 ph.addLast(new IdleStateHandler(5, 0, 0, TimeUnit.SECONDS)); // 解码和编码，应和客户端一致 //传输的协议 Protobuf ph.addLast(new ProtobufVarint32FrameDecoder()); ph.addLast(new ProtobufDecoder(UserMsg.getDefaultInstance())); ph.addLast(new ProtobufVarint32LengthFieldPrepender()); ph.addLast(new ProtobufEncoder()); //业务逻辑实现类 ph.addLast("nettyServerHandler