开发基于protostuff编解码技术的Netty程序：传输pojo对象

[toc]

---

开发基于protostuff编解码技术的Netty程序：传输pojo对象

前言

这次开发的Netty程序主要是在网络中传输Java对象，传输的对象不仅限于字符串，也可以是自定义的其它类型对象。

前面使用protostuff都是比较单纯地使用，进行简单的一些测试，下面要完成的这个例子功能虽然不复杂，但相对使用起来会比较综合一些。通过序列化工具类的开发、编解码器的开发，然后将其应用到我们的Netty程序当中。

开发这个Netty程序来传输pojo对象是为了后面进行远程过程调用框架的开发做一定的准备，因为在远程调用时，返回的结果就是一个对象，返回的对象类型取决于调用的方法，所以通过Netty程序来传输pojo对象只是开发自定义RPC框架中的一小部分，但却也是十分重要的一部分。

另外需要注意的是，Netty框架本身的使用很重要，而怎么去开发序列化工具类（即如何通过protostuff来开发具有能用性的序列化工具）、如何基于序列化工具类开发Netty的编码器与解码器、如何在Netty中使用自定义开发的编码器与解码器等这些知识都是十重要，而且也是一定要掌握的。

代码中都已经写好了注释，程序是可以直接跑起来的，依赖的相关包，因为使用的是maven工程，所以在后面也会给出pom.xml文件的内容。

protostuff序列化工具类开发

工具类的开发过程可以参考前面的文章基于protostuff的序列化工具类开发，下面直接给出具有缓存功能的序列化工具类的代码：

SerializationUtil2.java

package cn.xpleaf.protostuff.netty.utils;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import com.dyuproject.protostuff.LinkedBuffer;
import com.dyuproject.protostuff.ProtostuffIOUtil;
import com.dyuproject.protostuff.runtime.RuntimeSchema;

/**
 * 具备缓存功能的序列化工具类，基于Protostuff实现（其基于Google Protobuf实现）
 * 
 * @author yeyonghao
 *
 */
public class SerializationUtil2 {

    // 缓存schema对象的map
    private static Map, RuntimeSchema> cachedSchema = new ConcurrentHashMap, RuntimeSchema>();

    /**
     * 根据获取相应类型的schema方法
     * 
     * @param clazz
     * @return
     */
    @SuppressWarnings({ "unchecked", "unused" })
    private  RuntimeSchema getSchema(Class clazz) {
        // 先尝试从缓存schema map中获取相应类型的schema
        RuntimeSchema schema = (RuntimeSchema) cachedSchema.get(clazz);
        // 如果没有获取到对应的schema，则创建一个该类型的schema
        // 同时将其添加到schema map中
        if (schema == null) {
            schema = RuntimeSchema.createFrom(clazz);
            if (schema != null) {
                cachedSchema.put(clazz, schema);
            }
        }
        // 返回schema对象
        return schema;
    }

    /**
     * 序列化方法，将对象序列化为字节数组（对象 ---> 字节数组）
     * 
     * @param obj
     * @return
     */
    @SuppressWarnings("unchecked")
    public static  byte[] serialize(T obj) {
        // 获取泛型对象的类型
        Class clazz = (Class) obj.getClass();
        // 创建泛型对象的schema对象
        RuntimeSchema schema = RuntimeSchema.createFrom(clazz);
        // 创建LinkedBuffer对象
        LinkedBuffer buffer = LinkedBuffer.allocate(LinkedBuffer.DEFAULT_BUFFER_SIZE);
        // 序列化
        byte[] array = ProtostuffIOUtil.toByteArray(obj, schema, buffer);
        // 返回序列化对象
        return array;
    }

    /**
     * 反序列化方法，将字节数组反序列化为对象（字节数组 ---> 对象）
     * 
     * @param data
     * @param clazz
     * @return
     */
    public static  T deserialize(byte[] data, Class clazz) {
        // 创建泛型对象的schema对象
        RuntimeSchema schema = RuntimeSchema.createFrom(clazz);
        // 根据schema实例化对象
        T message = schema.newMessage();
        // 将字节数组中的数据反序列化到message对象
        ProtostuffIOUtil.mergeFrom(data, message, schema);
        // 返回反序列化对象
        return message;
    }
}

编码器与解码器开发

EchoEncoder.java

package cn.xpleaf.protostuff.netty.utils;

import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.MessageToByteEncoder;

/**
 * PojoEncoder继承自Netty中的MessageToByteEncoder类，
 * 并重写抽象方法encode(ChannelHandlerContext ctx, Object msg, ByteBuf out)
 * 它负责将Object类型的POJO对象编码为byte数组，然后写入到ByteBuf中
 * 
 * @author yeyonghao
 *
 */
public class EchoEncoder extends MessageToByteEncoder