netty的编解码器介绍

本blog主要介绍： 
1. Codec 编解码器 
2. Decoder 解码器 
3. Encoder 编码器

netty提供了强大的编解码器框架，使得咱们编写自定义的编解码器很容易，也容易封装个重用。

在网络应用中须要实现某种编解码器，将原始字节数据与自定义的消息对象进行互相转换。网络中都是以字节码的数据形式来传输数据的，服务器编码数据后发送到客户端，客户端须要对数据进行解码。编解码器由两部分组成：编码器、解码器。 

解码器：负责将消息从字节或其余序列形式转成指定的消息对象； 
编码器：将消息对象转成字节或其余序列形式在网络上传输。 

编码器和解码器的结构很简单，消息被编码后解码后会自动经过ReferenceCountUtil.release(message)释放，若是不想释放消息可使用ReferenceCountUtil.retain(message)，这将会使引用数量增长而没有消息发布，大多数时候不须要这么作。

其实，各类编解码器的实现都是ChannelHandler的实现。 

解码器

Netty提供了丰富的解码器抽象基类，咱们能够很容易的实现这些基类来自定义解码器。下面是解码器的一个类型：

• 解码字节到消息
• 解码消息到消息

解码器负责解码“入站”数据从一种格式到另外一种格式，解码器处理入站数据是抽象ChannelInboundHandler的实现。实践中使用解码器很简单，就是将入站数据转换格式后传递到ChannelPipeline中的下一个ChannelInboundHandler进行处理；这样的处理时很灵活的，咱们能够将解码器放在ChannelPipeline中，重用逻辑。

ByteToMessageDecoder

一般咱们须要将消息从 字节 解码成 消息 或者从 字节 解码成其余的 序列化字节 。这是一个常见的任务，Netty提供了抽象基类，咱们可使用它们来实现。Netty中提供的ByteToMessageDecoder能够将字节消息解码成POJO对象，下面列出了ByteToMessageDecoder两个主要方法：

decode(ChannelHandlerContext, ByteBuf, List<Object>)//这个方法是惟一的一个须要本身实现的抽象方法，做用是将ByteBuf数据解码成其余形式的数据。
decodeLast(ChannelHandlerContext, ByteBuf, List<Object>)//实际上调用的是decode(...)。

• 例如服务器从某个客户端接收到一个整数值的字节码，服务器将数据读入ByteBuf 并通过ChannelPipeline中的每一个 ChannelInboundHandle r进行处理，看下图： 

 
上图显示了从“入站”ByteBuf读取bytes后由 ToIntegerDecoder 进行解码，而后将解码后的消息存入List集合中，而后传递到ChannelPipeline中的下一个ChannelInboundHandler。看下面ToIntegerDecoder的实现代码：

/** 
 * Integer解码器,ByteToMessageDecoder实现 
 * 
 */  
public class ToIntegerDecoder extends ByteToMessageDecoder {  
    @Override  
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {  
        //接收到字节大于4个字节了就处理。
        if(in.readableBytes() >= 4){  
            out.add(in.readInt());  
        }  
    }  
}

• 从上面的代码可能会发现，咱们须要检查ByteBuf读以前是否有足够的字节，这是与TCP黏包有关，若没有这个检查岂不更好？是的，Netty提供了这样的处理容许byte-to-message解码。除了ByteToMessageDecoder以外，Netty还提供了许多其余的解码接口。

ReplayingDecoder

ReplayingDecoder是byte-to-message解码的一种特殊的抽象基类，byte-to-message解码读取缓冲区的数据以前须要检查缓冲区是否有足够的字节，使用ReplayingDecoder就无需本身检查；若ByteBuf中有足够的字节，则会正常读取；若没有足够的字节则会中止解码。也正由于这样的包装使得ReplayingDecoder带有必定的局限性。 
• 不是全部的操做都被ByteBuf支持，若是调用一个不支持的操做会抛出DecoderException。 
• ByteBuf.readableBytes()大部分时间不会返回指望值

若是你能忍受上面列出的限制，相比ByteToMessageDecoder，你可能更喜欢ReplayingDecoder。在知足需求的状况下推荐使用ByteToMessageDecoder，由于它的处理比较简单，没有ReplayingDecoder实现的那么复杂。ReplayingDecoder继承于ByteToMessageDecoder，因此他们提供的接口是相同的。下面代码是ReplayingDecoder的实现：

/**
 * Integer解码器,ReplayingDecoder实现
 */
public class ToIntegerReplayingDecoder extends ReplayingDecoder<Void> {

    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
        out.add(in.readInt());
    }
}

• 三、MessageToMessageDecoder

将消息对象转成消息对象但是使用MessageToMessageDecoder，它是一个抽象类，须要咱们本身实现其decode(…)。message-to-message同上面讲的byte-to-message的处理机制同样，看下图： 

实现代码：

/**
 * 将接收的Integer消息转成String类型，MessageToMessageDecoder实现
 * @author c.k
 *
 */
public class IntegerToStringDecoder extends MessageToMessageDecoder<Integer> {

    @Override
    protected void decode(ChannelHandlerContext ctx, Integer msg, List<Object> out) throws Exception {
        out.add(String.valueOf(msg));
    }
}

• 解码器总结

解码器是用来处理入站数据，Netty提供了不少解码器的实现，能够根据需求详细了解。

编码器

Netty提供了一些基类，咱们能够很简单的编码器。一样的，编码器有下面两种类型：

• 消息对象编码成消息对象
• 消息对象编码成字节码

相对解码器，编码器少了一个byte-to-byte的类型，由于出站数据这样作没有意义。编码器的做用就是将处理好的数据转成字节码以便在网络中传输。对照上面列出的两种编码器类型，Netty也分别提供了两个抽象类：MessageToByteEncoder和MessageToMessageEncoder。下面是类关系图： 

MessageToByteEncoder

MessageToByteEncoder是抽象类，咱们自定义一个继承MessageToByteEncoder的编码器只须要实现其提供的encode(…)方法。其工做流程以下图： 
 
实现代码以下：

/**
 * 编码器，将Integer值编码成byte[]，MessageToByteEncoder实现
 */
public class IntegerToByteEncoder extends MessageToByteEncoder<Integer> {
    @Override
    protected void encode(ChannelHandlerContext ctx, Integer msg, ByteBuf out) throws Exception {
        out.writeInt(msg);
    }
}

• MessageToMessageEncoder

须要将消息编码成其余的消息时可使用Netty提供的MessageToMessageEncoder抽象类来实现。例如将Integer编码成String，其工做流程以下图： 

代码实现以下：

/**
 * 编码器，将Integer编码成String，MessageToMessageEncoder实现
 */
public class IntegerToStringEncoder extends MessageToMessageEncoder<Integer> {

    @Override
    protected void encode(ChannelHandlerContext ctx, Integer msg, List<Object> out) throws Exception {
        out.add(String.valueOf(msg));
    }
}