ChannelHandler

转载自：http://blog.youkuaiyun.com/abc_key/article/details/37928441

     Netty提供了一个强大的处理这些事情的功能，允许用户自定义ChannelHandler的实现来处理数据。使得ChannelHandler更强大的是可以连接每个ChannelHandler来实现任务，这有助于代码的整洁和重用。但是处理数据只是ChannelHandler所做的事情之一，也可以处理I/O操作，例如写请求。所有这些都可以动态实现。

ChannelPipeline

       ChannelPipeline是ChannelHandler实例的列表，用于处理或截获通道的接收和发送数据。ChannelPipeline提供了一种高级的截取过滤器模式，让用户可以在ChannelPipeline中完全控制一个事件及如何处理ChannelHandler与ChannelPipeline的交互。
       对于每个新的通道，会创建一个新的ChannelPipeline并附加至该通道。一旦连接，Channel和ChannelPipeline之间的耦合是永久性的。Channel不能附加到其他的ChannelPipeline或从ChannelPipeline分离。
       下图描述了ChannelHandler在ChannelPipeline中的I/O处理，一个I/O操作可以由一个 ChannelInboundHandler或ChannelOutboundHandler进行处理，并通过调用 ChannelInboundHandler处理入站IO或通过ChannelOutboundHandler处理出站IO。
         
       如上图所示，ChannelPipeline是ChannelHandler的一个列表；如果一个入站I/O事件被触发，这个事件会从第一个开始依次通过ChannelPipeline中的ChannelInboundHandler；若是一个入站I/O事件，则会从最后一个开始依次通过ChannelPipeline中的ChannelOutboundHandler。ChannelHandler可以处理事件并检查类型，如果某个 ChannelHandler不能处理则会跳过，并将事件传递到下一个ChannelHandler。ChannelPipeline可以动态添加、删 除、替换其中的ChannelHandler，这样的机制可以提高灵活性。
       修改ChannelPipeline的方法：
       • addFirst(...)，添加ChannelHandler在ChannelPipeline的第一个位置
       • addBefore(...)，在ChannelPipeline中指定的ChannelHandler名称之前添加ChannelHandler
       • addAfter(...)，在ChannelPipeline中指定的ChannelHandler名称之后添加ChannelHandler
       • addLast(ChannelHandler...)，在ChannelPipeline的末尾添加ChannelHandler
       • remove(...)，删除ChannelPipeline中指定的ChannelHandler
       • replace(...)，替换ChannelPipeline中指定的ChannelHandler

ChannelPipeline pipeline = ch.pipeline();
FirstHandler firstHandler = new FirstHandler();
pipeline.addLast("handler1", firstHandler);
pipeline.addFirst("handler2", new SecondHandler());
pipeline.addLast("handler3", new ThirdHandler());
pipeline.remove("handler3");
pipeline.remove(firstHandler);
pipeline.replace("handler2", "handler4", new FourthHandler());

       被添加到ChannelPipeline的ChannelHandler将通过IO-Thread处理事件，这意味了必须不能有其他的IO- Thread阻塞来影响IO的整体处理；有时候可能需要阻塞，例如JDBC。因此，Netty允许通过添加一个EventExecutorGroup到每一个ChannelPipeline.add*方法，自定义的事件会被包含在EventExecutorGroup中的EventExecutor来处理，默认的实现是DefaultEventExecutorGroup。
       ChannelPipeline除了一些修改的方法，还有很多其他的方法，具体是方法及使用可以看API文档或源码。

ChannelHandlerContext

       每个ChannelHandler被添加到ChannelPipeline后，都会创建一个ChannelHandlerContext并与之创建的ChannelHandler关联绑定。ChannelHandlerContext允许ChannelHandler与其他的ChannelHandler实现进行交互，这是相同ChannelPipeline的一部分。ChannelHandlerContext不会改变添加到其中的ChannelHandler，因此它是安全的。
       在相同的ChannelPipeline中通过调用ChannelInboundHandler和ChannelOutboundHandler中各个方法中的一个方法来通知最近的handler，通知开始的地方取决如何设置。下图显示了ChannelHandlerContext、 ChannelHandler、ChannelPipeline的关系：
         
       如果你想有一些事件流全部通过ChannelPipeline，有两个不同的方法可以做到：
       • 调用Channel的方法
       • 调用ChannelPipeline的方法
       这两个方法都可以让事件流全部通过ChannelPipeline。无论从头部还是尾部开始，因为它主要依赖于事件的性质。如果是一个“入站”事件，它开始于头部；若是一个“出站”事件，则开始于尾部。
       下面的代码显示了一个写事件如何通过ChannelPipeline从尾部开始：

@Override
protected void initChannel(SocketChannel ch) throws Exception {
	ch.pipeline().addLast(new ChannelInboundHandlerAdapter() {
		@Override
		public void channelActive(ChannelHandlerContext ctx) throws Exception {
			//Event via Channel
			Channel channel = ctx.channel();
			channel.write(Unpooled.copiedBuffer("netty in action", CharsetUtil.UTF_8));
			//Event via ChannelPipeline
			ChannelPipeline pipeline = ctx.pipeline();
			pipeline.write(Unpooled.copiedBuffer("netty in action", CharsetUtil.UTF_8));
		}
	});
}

       下图表示通过Channel或ChannelPipeline的通知：
         

状态模型

       Netty有一个简单但强大的状态模型，并完美映射到ChannelInboundHandler的各个方法。下面是Channel生命周期四个不同的状态：
       • channelUnregistered
       • channelRegistered
       • channelActive
       • channelInactive
         
       还可以看到额外的状态变化，因为用户允许从EventLoop中注销Channel暂停事件执行，然后再重新注册。在这种情况下，你会看到多个 channelRegistered和channelUnregistered状态的变化，而永远只有一个channelActive和 channelInactive的状态，因为一个通道在其生命周期内只能连接一次，之后就会被回收；重新连接，则是创建一个新的通道。
       下图显示了从EventLoop中注销Channel后再重新注册的状态变化：
         

ChannelHandler和其子类

       Netty中有3个实现了ChannelHandler接口的类，其中2个是接口，一个是抽象类。如下图：
         

ChannelHandler中的方法

       Netty定义了良好的类型层次结构来表示不同的处理程序类型，所有的类型的父类是ChannelHandler。ChannelHandler提供了在其生命周期内添加或从ChannelPipeline中删除的方法。
       • handlerAdded，ChannelHandler添加到实际上下文中准备处理事件
       • handlerRemoved，将ChannelHandler从实际上下文中删除，不再处理事件
       • exceptionCaught，处理抛出的异常

      上面三个方法都需要传递ChannelHandlerContext参数，每个ChannelHandler被添加到ChannelPipeline时会自动创建ChannelHandlerContext。ChannelHandlerContext允许在本地通道安全的存储和检索值。Netty还提供了一个实现了ChannelHandler的抽象类：ChannelHandlerAdapter。ChannelHandlerAdapter实现了父类的所有方法，基本上就是传递事件到ChannelPipeline中的下一个ChannelHandler直到结束。

ChannelInboundHandler
       ChannelInboundHandler提供了一些方法再接收数据或Channel状态改变时被调用。下面是ChannelInboundHandler的一些方法：
       • channelRegistered，ChannelHandlerContext的Channel被注册到EventLoop；
       • channelUnregistered，ChannelHandlerContext的Channel从EventLoop中注销
       • channelActive，ChannelHandlerContext的Channel已激活
       • channelInactive，ChannelHanderContxt的Channel结束生命周期
       • channelRead，从当前Channel的对端读取消息
       • channelReadComplete，消息读取完成后执行
       • userEventTriggered，一个用户事件被处罚
       • channelWritabilityChanged，改变通道的可写状态，可以使用Channel.isWritable()检查
       • exceptionCaught，重写父类ChannelHandler的方法，处理异常
       Netty提供了一个实现了ChannelInboundHandler接口并继承ChannelHandlerAdapter的 类：ChannelInboundHandlerAdapter。ChannelInboundHandlerAdapter实现了 ChannelInboundHandler的所有方法，作用就是处理消息并将消息转发到ChannelPipeline中的下一个 ChannelHandler。ChannelInboundHandlerAdapter的channelRead方法处理完消息后不会自动释放消息，若想自动释放收到的消息，可以使用SimpleChannelInboundHandler<I>。

/**
 * 实现ChannelInboundHandlerAdapter的Handler，不会自动释放接收的消息对象
 */
public class DiscardHandler extends ChannelInboundHandlerAdapter {
	@Override
	public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
		//手动释放消息
		ReferenceCountUtil.release(msg);
	}
}

/**
 * 继承SimpleChannelInboundHandler，会自动释放消息对象
 */
public class SimpleDiscardHandler extends SimpleChannelInboundHandler<Object> {
	@Override
	protected void channelRead0(ChannelHandlerContext ctx, Object msg) throws Exception {
		//不需要手动释放
	}
}

       如果需要其他状态改变的通知，可以重写Handler的其他方法。通常自定义消息类型来解码字节，可以实现 ChannelInboundHandler或ChannelInboundHandlerAdapter。有一个更好的解决方法，使用编解码器的框架可以很容的实现。使用ChannelInboundHandler、ChannelInboundHandlerAdapter、 SimpleChannelInboundhandler这三个中的一个来处理接收消息，使用哪一个取决于需求；大多数时候使用 SimpleChannelInboundHandler处理消息，使用ChannelInboundHandlerAdapter处理其他的“入站”事件或状态改变。
       ChannelInitializer用来初始化ChannelHandler，将自定义的各种ChannelHandler添加到ChannelPipeline中。

ChannelOutboundHandler
       ChannelOutboundHandler用来处理“出站”的数据消息。ChannelOutboundHandler提供了下面一些方法：
       • bind，Channel绑定本地地址
       • connect，Channel连接操作
       • disconnect，Channel断开连接
       • close，关闭Channel
       • deregister，注销Channel
       • read，读取消息，实际是截获ChannelHandlerContext.read()
       • write，写操作，实际是通过ChannelPipeline写消息，Channel.flush()属性到实际通道
       • flush，刷新消息到通道
       ChannelOutboundHandler是ChannelHandler的子类，实现了ChannelHandler的所有方法。所有最重要的方法采取ChannelPromise，因此一旦请求停止从ChannelPipeline转发参数则必须得到通知。Netty提供了ChannelOutboundHandler的实现：ChannelOutboundHandlerAdapter。 ChannelOutboundHandlerAdapter实现了父类的所有方法，并且可以根据需要重写感兴趣的方法。所有这些方法的实现，在默认情况下，都是通过调用ChannelHandlerContext的方法将事件转发到ChannelPipeline中下一个ChannelHandler。

public class DiscardOutboundHandler extends ChannelOutboundHandlerAdapter {
	@Override
	public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
		ReferenceCountUtil.release(msg);
		promise.setSuccess();
	}
}

       记得释放资源并通知ChannelPromise，若ChannelPromise没有被通知可能会导致其中一个ChannelFutureListener不被通知去处理一个消息。
       如果消息被消费并且没有被传递到ChannelPipeline中的下一个ChannelOutboundHandler，那么就需要调用ReferenceCountUtil.release(message)来释放消息资源。一旦消息被传递到实际的通道，它会自动写入消息或在通道关闭是释放。