Netty Review - Netty与Protostuff：打造高效的网络通信

文章目录

概念
Pre
Pom
Server & Client
ProtostuffUtil 解读
测试
小结

概念

在这里插入图片描述

Pre

每日一博 - Protobuf vs. Protostuff：性能、易用性和适用场景分析

Pom

    	<dependency><groupId>com.dyuproject.protostuff</groupId><artifactId>protostuff-api</artifactId><version>1.2.2</version></dependency><dependency><groupId>com.dyuproject.protostuff</groupId><artifactId>protostuff-core</artifactId><version>1.2.2</version></dependency><dependency><groupId>com.dyuproject.protostuff</groupId><artifactId>protostuff-runtime</artifactId><version>1.2.2</version></dependency>

Server & Client

package com.artisan.codec.protostuff;import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;/*** @author 小工匠* @version 1.0* @mark: show me the code , change the world*/
// 定义Netty服务器类
public class NettyServer {// main方法为程序入口点public static void main(String[] args) throws Exception {// 创建主从线程组，用于处理Netty的事件循环EventLoopGroup bossGroup = new NioEventLoopGroup(1);EventLoopGroup workerGroup = new NioEventLoopGroup();try {// 创建ServerBootstrap实例，用于设置服务器参数ServerBootstrap serverBootstrap = new ServerBootstrap();// 配置服务器线程组serverBootstrap.group(bossGroup, workerGroup)// 设置使用的Channel类型.channel(NioServerSocketChannel.class)// 设置Channel初始化处理器.childHandler(new ChannelInitializer<SocketChannel>() {@Overrideprotected void initChannel(SocketChannel ch) throws Exception {// 获取Channel的PipelineChannelPipeline pipeline = ch.pipeline();// 添加自定义的处理器pipeline.addLast(new NettyServerHandler());}});// 打印启动信息System.out.println("netty server start。。");// 绑定端口并启动服务器ChannelFuture channelFuture = serverBootstrap.bind(9876).sync();// 等待服务器Channel关闭channelFuture.channel().closeFuture().sync();} finally {// 优雅地关闭主从线程组bossGroup.shutdownGracefully();workerGroup.shutdownGracefully();}}
}

这段代码首先设置了两个EventLoopGroup，一个用于接受连接（boss），另一个用于处理已接受连接的IO操作（worker）。然后创建了一个ServerBootstrap实例来配置和启动服务器。在ServerBootstrap中指定了使用的EventLoopGroup、Channel类型以及子Channel的初始化处理器。初始化处理器中添加了一个自定义的NettyServerHandler，这应该是处理网络事件和业务逻辑的地方。

服务器启动后，会绑定到本地端口9876，并等待连接。程序最后会优雅地关闭线程组，释放资源。

需要注意的是，这段代码缺少了NettyServerHandler类的定义，这应该是处理网络事件和业务逻辑的具体实现。同时，这段代码没有异常处理和资源管理的健壮性考虑，例如可能需要捕获并处理Exception等。

NettyServerHandler的类，该类继承了ChannelInboundHandlerAdapter，表示一个自定义的Netty通道入站处理器。处理器中重写了channelRead和exceptionCaught方法，分别用于处理通道读取事件和异常事件。

在这里插入图片描述

package com.artisan.codec.protostuff;
// 引入Netty相关类
import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
/*** @author 小工匠* @version 1.0* @mark: show me the code , change the world*/
// 定义Netty服务器处理器类
public class NettyServerHandler extends ChannelInboundHandlerAdapter {// 重写channelRead方法，处理通道读取事件@Overridepublic void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {// 获取客户端发送的ByteBuf数据ByteBuf buf = (ByteBuf) msg;// 将ByteBuf数据转换为字节数组byte[] bytes = new byte[buf.readableBytes()];buf.readBytes(bytes);// 使用ProtostuffUtil工具类对字节数组进行反序列化操作System.out.println("从客户端读取到Object：" + ProtostuffUtil.deserializer(bytes, Artisan.class));}// 重写exceptionCaught方法，处理异常事件@Overridepublic void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {// 打印异常堆栈信息cause.printStackTrace();// 关闭通道ctx.close();}
}

在channelRead方法中，当通道读取到数据时，会将接收到的ByteBuf对象转换为字节数组，并使用ProtostuffUtil工具类的deserializer方法进行反序列化操作，将字节数组还原为Artisan对象。Artisan类是客户端发送的数据对应的Java对象。

在exceptionCaught方法中，当发生异常时，会打印异常堆栈信息，并关闭通道。这有助于及时发现并处理异常，避免程序出现异常无法处理的情况。

这段代码是一个使用Netty框架的简单客户端程序。客户端程序的主要作用是连接到服务器，并发送或接收数据。下面是对这段代码的解读和增加的中文注释：

package com.artisan.codec.protostuff;
// 引入Netty相关类
import io.netty.bootstrap.Bootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel;
/*** @author 小工匠* @version 1.0* @mark: show me the code , change the world*/
// 定义Netty客户端类
public class NettyClient {// main方法为程序入口点public static void main(String[] args) throws Exception {// 创建事件循环组EventLoopGroup group = new NioEventLoopGroup();try {// 创建Bootstrap实例，用于设置客户端参数Bootstrap bootstrap = new Bootstrap();// 配置客户端事件循环组bootstrap.group(group).channel(NioSocketChannel.class)// 设置客户端Channel初始化处理器.handler(new ChannelInitializer<SocketChannel>() {@Overrideprotected void initChannel(SocketChannel ch) throws Exception {// 获取Channel的PipelineChannelPipeline pipeline = ch.pipeline();// 添加自定义的处理器pipeline.addLast(new NettyClientHandler());}});// 打印启动信息System.out.println("netty client start。。");// 连接到服务器ChannelFuture channelFuture = bootstrap.connect("127.0.0.1", 9876).sync();// 等待客户端Channel关闭channelFuture.channel().closeFuture().sync();} finally {// 优雅地关闭事件循环组group.shutdownGracefully();}}
}

这段代码首先创建了一个NioEventLoopGroup，用于处理Netty的事件循环。然后创建了一个Bootstrap实例来配置和启动客户端。在Bootstrap中指定了使用的事件循环组、Channel类型以及子Channel的初始化处理器。初始化处理器中添加了一个自定义的NettyClientHandler，这是处理网络事件和业务逻辑的地方。

客户端启动后，会连接到服务器127.0.0.1的端口9876。程序最后会优雅地关闭事件循环组，释放资源。

NettyClientHandler的类，该类继承了ChannelInboundHandlerAdapter，表示一个自定义的Netty通道入站处理器。处理器中重写了channelRead和channelActive方法，分别用于处理通道读取事件和通道激活事件。

在这里插入图片描述

package com.artisan.codec.protostuff;import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import java.util.Arrays;
/*** @author 小工匠* @version 1.0* @mark: show me the code , change the world*/
// 定义Netty客户端处理器类
public class NettyClientHandler extends ChannelInboundHandlerAdapter {// 重写channelRead方法，处理通道读取事件@Overridepublic void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {// 打印服务器发送的消息System.out.println("收到服务器消息：" + msg);}// 重写channelActive方法，处理通道激活事件@Overridepublic void channelActive(ChannelHandlerContext ctx) throws Exception {// 打印客户端处理器发送数据信息System.out.println("NettyClientHandler发送数据");// 使用ProtostuffUtil工具类对对象进行序列化操作Artisan artisan = new Artisan(1, "artisan", new Address("xx", Arrays.asList("code", "run")));ByteBuf buf = Unpooled.copiedBuffer(ProtostuffUtil.serializer(artisan));// 向服务器发送序列化后的数据ctx.writeAndFlush(buf);}
}

这段代码定义了一个名为NettyClientHandler的Netty通道入站处理器，主要用于处理通道读取事件和通道激活事件。具体功能如下：

重写channelRead方法：当通道读取到数据时，该方法会被调用，并打印服务器发送的消息。
重写channelActive方法：当通道激活时（即成功连接到服务器），该方法会被调用。在该方法中，使用ProtostuffUtil工具类对Artisan对象进行序列化操作，并将序列化后的数据发送给服务器。

注意：在实际使用中，建议在channelActive方法最后添加buf.release();来释放ByteBuf对象，避免内存泄漏。

package com.artisan.codec.protostuff;import java.io.Serializable;/*** @author 小工匠* @version 1.0* @mark: show me the code , change the world*/
public class Artisan implements Serializable {private int id;private String name;private Address address;public Artisan() {}public Artisan(int id, String name) {super();this.id = id;this.name = name;}public Artisan(int id, String name, Address address) {this.id = id;this.name = name;this.address = address;}public int getId() {return id;}public void setId(int id) {this.id = id;}public String getName() {return name;}public void setName(String name) {this.name = name;}public Address getAddress() {return address;}public void setAddress(Address address) {this.address = address;}@Overridepublic String toString() {return "Artisan{" +"id=" + id +", name='" + name + '\'' +", address=" + address +'}';}
}

package com.artisan.codec.protostuff;import java.util.List;/*** @author 小工匠* @version 1.0* @mark: show me the code , change the world*/
public class Address {private String location;private List<String> hobbies;public String getLocation() {return location;}public void setLocation(String location) {this.location = location;}public List<String> getHobbiies() {return hobbies;}public void setHobbies(List<String> hobbies) {this.hobbies = hobbies;}public Address() {}public Address(String location) {this.location = location;}public Address(String location, List<String> hobbies) {this.location = location;this.hobbies = hobbies;}@Overridepublic String toString() {return "Address{" +"location='" + location + '\'' +", hobbies=" + hobbies +'}';}
}

ProtostuffUtil 解读

package com.artisan.codec.protostuff;import com.dyuproject.protostuff.LinkedBuffer;
import com.dyuproject.protostuff.ProtostuffIOUtil;
import com.dyuproject.protostuff.Schema;
import com.dyuproject.protostuff.runtime.RuntimeSchema;import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;/*** @author 小工匠* @version 1.0* @mark: show me the code , change the world* @desc: protostuff 序列化工具类，基于protobuf封装*/
public class ProtostuffUtil {// 使用ConcurrentHashMap缓存Schema，提高性能private static Map<Class<?>, Schema<?>> cachedSchema = new ConcurrentHashMap<Class<?>, Schema<?>>(); // 定义一个ConcurrentHashMap，用于缓存Schema// 获取类的Schema，如果缓存中没有则创建一个新的Schema并缓存起来private static <T> Schema<T> getSchema(Class<T> clazz) { // 定义一个泛型方法，用于获取类的SchemaSchema<T> schema = (Schema<T>) cachedSchema.get(clazz); // 从缓存中获取Schemaif (schema == null) { // 如果Schema为空schema = RuntimeSchema.getSchema(clazz); // 创建一个新的Schemaif (schema != null) { // 如果新的Schema不为空cachedSchema.put(clazz, schema); // 将新的Schema添加到缓存中}}return schema; // 返回Schema}/*** 序列化** @param obj 要序列化的对象* @return 序列化后的字节流*/public static <T> byte[] serializer(T obj) { // 定义一个泛型方法，用于序列化对象@SuppressWarnings("unchecked")Class<T> clazz = (Class<T>) obj.getClass(); // 获取对象的类类型LinkedBuffer buffer = LinkedBuffer.allocate(LinkedBuffer.DEFAULT_BUFFER_SIZE); // 分配一个LinkedBuffer缓冲区try {Schema<T> schema = getSchema(clazz); // 获取对象的Schemareturn ProtostuffIOUtil.toByteArray(obj, schema, buffer); // 将对象序列化为字节流} catch (Exception e) {throw new IllegalStateException(e.getMessage(), e); // 如果出现异常，则抛出自定义异常} finally {buffer.clear(); // 清理LinkedBuffer缓冲区}}/*** 反序列化** @param data  序列化的字节流* @param clazz 对象的类类型* @return 反序列化后的对象*/public static <T> T deserializer(byte[] data, Class<T> clazz) { // 定义一个泛型方法，用于反序列化字节流try {T obj = clazz.newInstance(); // 创建一个新的对象实例Schema<T> schema = getSchema(clazz); // 获取对象的SchemaProtostuffIOUtil.mergeFrom(data, obj, schema); // 将字节流反序列化为对象return obj; // 返回反序列化后的对象} catch (Exception e) {throw new IllegalStateException(e.getMessage(), e); // 如果出现异常，则抛出自定义异常}}public static void main(String[] args) {byte[] userBytes = ProtostuffUtil.serializer(new Artisan(1, "artisan", new Address("ssss", Arrays.asList("code", "run"))));Artisan artisan = ProtostuffUtil.deserializer(userBytes, Artisan.class);System.out.println(artisan);}
}

ProtostuffUtil提供了对Google的Protocol Buffers（protobuf）序列化格式的封装。该工具类使用com.dyuproject.protostuff库，这是一个Google protobuf的Java扩展库，提供了更简单、更灵活的API。

缓存Schema: ProtostuffUtil使用一个ConcurrentHashMap来缓存不同类的Schema。这样做可以避免在每次序列化或反序列化时都创建新的Schema，从而提高性能。
```
private static Map<Class<?>, Schema<?>> cachedSchema = new ConcurrentHashMap<>();
```

获取Schema: 工具类提供了一个泛型方法getSchema(Class<T> clazz)来获取某个类的Schema。如果Schema已经在缓存中，就直接返回；否则，创建一个新的Schema并将其添加到缓存中。

private static <T> Schema<T> getSchema(Class<T> clazz) {Schema<T> schema = cachedSchema.get(clazz);if (schema == null) {schema = RuntimeSchema.getSchema(clazz);if (schema != null) {cachedSchema.put(clazz, schema);}}return schema;
}

序列化: serializer(T obj)方法用于将对象序列化为字节流。这个方法使用ProtostuffIOUtil.toByteArray方法完成序列化，并返回序列化后的字节流。

public static <T> byte[] serializer(T obj) {@SuppressWarnings("unchecked")Class<T> clazz = (Class<T>) obj.getClass();LinkedBuffer buffer = LinkedBuffer.allocate(LinkedBuffer.DEFAULT_BUFFER_SIZE);try {Schema<T> schema = getSchema(clazz);return ProtostuffIOUtil.toByteArray(obj, schema, buffer);} catch (Exception e) {throw new IllegalStateException(e.getMessage(), e);} finally {buffer.clear();}
}

反序列化: deserializer(byte[] data, Class<T> clazz)方法用于将字节流反序列化为对象。这个方法使用ProtostuffIOUtil.mergeFrom方法完成反序列化，并返回反序列化后的对象。

public static <T> T deserializer(byte[] data, Class<T> clazz) {try {T obj = clazz.newInstance();Schema<T> schema = getSchema(clazz);ProtostuffIOUtil.mergeFrom(data, obj, schema);return obj;} catch (Exception e) {throw new IllegalStateException(e.getMessage(), e);}
}