本章介紹
- ChannelPipeline
- ChannelHandlerContext
- ChannelHandler
- Inbound vs outbound(入站和出站)
6.1 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中的ChannelHandler；若是一個入站I/O事件，則會從最後一個開始依次通過ChannelPipeline中的ChannelHandler。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除了一些修改的方法，還有很多其他的方法，具體是方法及使用可以看API文檔或源碼。
6.2 ChannelHandlerContext
每個ChannelHandler被添加到ChannelPipeline後，都會創建一個ChannelHandlerContext並與之創建的ChannelHandler關聯綁定。ChannelHandlerContext允許ChannelHandler與其他的ChannelHandler實現進行交互，這是相同ChannelPipeline的一部分。ChannelHandlerContext不會改變添加到其中的ChannelHandler，因此它是安全的。
6.2.1 通知下一個ChannelHandler
在相同的ChannelPipeline中通過調用ChannelInboundHandler和ChannelOutboundHandler中各個方法中的一個方法來通知最近的handler，通知開始的地方取決你如何設置。下圖顯示了ChannelHandlerContext、ChannelHandler、ChannelPipeline的關係：
如果你想有一些事件流全部通過ChannelPipeline，有兩個不同的方法可以做到：
- 調用Channel的方法
- 調用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));
}
});
}
可能你想從ChannelPipeline的指定位置開始，不想流經整個ChannelPipeline，如下情況：
- 爲了節省開銷，不感興趣的ChannelHandler不讓通過
- 排除一些ChannelHandler
// Get reference of ChannelHandlerContext
ChannelHandlerContext ctx = ..;
// Write buffer via ChannelHandlerContext
ctx.write(Unpooled.copiedBuffer("Netty in Action", CharsetUtil.UTF_8));
如上圖顯示的，從指定的ChannelHandlerContext開始，跳過前面所有的ChannelHandler，使用ChannelHandlerContext操作是常見的模式，最常用的是從ChannelHanlder調用操作，也可以在外部使用ChannelHandlerContext，因爲這是線程安全的。
6.2.2 修改ChannelPipeline
調用ChannelHandlerContext的pipeline()方法能訪問ChannelPipeline，能在運行時動態的增加、刪除、替換ChannelPipeline中的ChannelHandler。可以保持ChannelHandlerContext供以後使用，如外部Handler方法觸發一個事件，甚至從一個不同的線程。
下面代碼顯示了保存ChannelHandlerContext供之後使用或其他線程使用：
public class WriteHandler extends ChannelHandlerAdapter {
private ChannelHandlerContext ctx;
@Override
public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
this.ctx = ctx;
}
public void send(String msg){
ctx.write(msg);
}
}@Sharable
public class NotSharableHandler extends ChannelInboundHandlerAdapter {
private int count;
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
count++;
System.out.println("channelRead(...) called the " + count + " time");
ctx.fireChannelRead(msg);
}
}爲什麼要共享ChannelHandler？使用@Sharable註解共享一個ChannelHandler在一些需求中還是有很好的作用的，如使用一個ChannelHandler來統計連接數或來處理一些全局數據等等。
6.3 狀態模型
Netty有一個簡單但強大的狀態模型，並完美映射到ChannelInboundHandler的各個方法。下面是Channel生命週期四個不同的狀態：
- channelUnregistered
- channelRegistered
- channelActive
- channelInactive
還可以看到額外的狀態變化，因爲用戶允許從EventLoop中註銷Channel暫停事件執行，然後再重新註冊。在這種情況下，你會看到多個channelRegistered和channelUnregistered狀態的變化，而永遠只有一個channelActive和channelInactive的狀態，因爲一個通道在其生命週期內只能連接一次，之後就會被回收；重新連接，則是創建一個新的通道。
下圖顯示了從EventLoop中註銷Channel後再重新註冊的狀態變化：
6.4 ChannelHandler和其子類
Netty中有3個實現了ChannelHandler接口的類，其中2個是接口，一個是抽象類。如下圖：
6.4.1 ChannelHandler中的方法
Netty定義了良好的類型層次結構來表示不同的處理程序類型，所有的類型的父類是ChannelHandler。ChannelHandler提供了在其生命週期內添加或從ChannelPipeline中刪除的方法。
- handlerAdded，ChannelHandler添加到實際上下文中準備處理事件
- handlerRemoved，將ChannelHandler從實際上下文中刪除，不再處理事件
- exceptionCaught，處理拋出的異常
6.4.2 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的方法，處理異常
看下面代碼：
/**
* 實現ChannelInboundHandlerAdapter的Handler，不會自動釋放接收的消息對象
* @author c.k
*
*/
public class DiscardHandler extends ChannelInboundHandlerAdapter {
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
//手動釋放消息
ReferenceCountUtil.release(msg);
}
}/**
* 繼承SimpleChannelInboundHandler，會自動釋放消息對象
* @author c.k
*
*/
public class SimpleDiscardHandler extends SimpleChannelInboundHandler<Object> {
@Override
protected void channelRead0(ChannelHandlerContext ctx, Object msg) throws Exception {
//不需要手動釋放
}
}ChannelInitializer用來初始化ChannelHandler，將自定義的各種ChannelHandler添加到ChannelPipeline中。
6.4.3 ChannelOutboundHandler
ChannelOutboundHandler用來處理“出站”的數據消息。ChannelOutboundHandler提供了下面一些方法：
- bind，Channel綁定本地地址
- connect，Channel連接操作
- disconnect，Channel斷開連接
- close，關閉Channel
- deregister，註銷Channel
- read，讀取消息，實際是截獲ChannelHandlerContext.read()
- write，寫操作，實際是通過ChannelPipeline寫消息，Channel.flush()屬性到實際通道
- flush，刷新消息到通道
看下面的代碼：
public class DiscardOutboundHandler extends ChannelOutboundHandlerAdapter {
@Override
public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
ReferenceCountUtil.release(msg);
promise.setSuccess();
}
}如果消息被消費並且沒有被傳遞到ChannelPipeline中的下一個ChannelOutboundHandler，那麼就需要調用ReferenceCountUtil.release(message)來釋放消息資源。一旦消息被傳遞到實際的通道，它會自動寫入消息或在通道關閉是釋放。
