SpringBoot整合Netty并使用Protobuf进行数据传输(附工程)

本篇文章主要介绍的是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:1 name:xuwujing age:18 SpringBoot整合Netty

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

开发准备

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

如果对Netty不熟的话，可以看看我之前写的一些文章。大神请无视~。~
地址：https://blog.csdn.net/column/details/17640.html

首先还是Maven的相关依赖:

<properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <java.version>1.8</java.version> <netty.version>4.1.22.Final</netty.version> <protobuf.version>3.5.1</protobuf.version> <springboot>1.5.9.RELEASE</springboot> <fastjson>1.2.41</fastjson> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> <version>${springboot}</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <version>${springboot}</version> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <version>${springboot}</version> <optional>true</optional> </dependency> <dependency> <groupId>io.netty</groupId> <artifactId>netty-all</artifactId> <version>${netty.version}</version> </dependency> <dependency> <groupId>com.google.protobuf</groupId> <artifactId>protobuf-java</artifactId> <version>${protobuf.version}</version> </dependency> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>${fastjson}</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> <scope>test</scope> </dependency> </dependencies>

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

代码编写