Netty 框架學習 —— ChannelHandler 與 ChannelPipeline

ChannelHandler

1. Channel 生命周期

Channel 的生命周期狀態如下：

Channel 的生命周期按上表從上到下所示，當狀態發生改變時，將會生成對應的事件，這些事件將會被轉發到 ChannelPipeline 中的 ChannelHandler，隨后其可以做出回應

2. ChannelHandler 生命周期

下表列出了 ChannelHandler 定義的生命周期操作，在 ChannelHandler 被添加到 ChannelPipeline 或者被從 ChannelPipeline 移除時會呼叫這些操作，這些方法中的每一個都接受一個 ChannelHandlerContext 引數

3. ChannelInboundHandler 介面

ChannelInboundHandler 是 ChannelHandler 介面的子介面，處理入站資料以及各種狀態變化，下表列出 ChannelInboundHandler 的生命周期方法，這些方法將會在資料被接收時或者與其對應的 Channel 狀態發生改變時被呼叫

當某個 ChannelInboundHandler 的實作重寫 channelRead() 方法時，它將負責顯式地釋放與池化 ByteBuf 實體相關的記憶體，Netty 為此提供了一個實用方法 ReferenceCountUtil.release()

@Sharable
public class DiscardHandler extends ChannelInboundHandlerAdapter {
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) {
        ReferenceCountUtil.release(msg);
    }
}

這種方式可能會很煩瑣，另一種更加簡單的方式是使用 SimpleChannelInboundHandler

@Sharable
public class SimpleDiscardHandler extends SimpleChannelInboundHandlerAdapter<Object> {
    @Override
    public void channelRead0(ChannelHandlerContext ctx, Object msg) {
        // 不需要顯式進行資源釋放
    }
}

由于 SimpleChannelInboundHandler 會自動釋放資源，所以你不應該存盤任何指向訊息的參考，因為這些參考都將會失效

4. ChannelOutboundHandler 介面

出站操作和資料由 ChannelOutboundHandler 處理，它的方法將被 Channel、ChannelPipeline 以及 ChannelHandlerContext 呼叫

ChannelOutboundHandler 的一個強大的功能是可以按需推遲操作或者事件，使得可以通過一些復雜的方法來處理請求，例如，如果到遠程節點的寫入被暫停了，那么你可以推遲沖刷操作并在稍后繼續

下標顯示了所有由 ChannelOutboundHandler 本身所定義的方法

ChannelOutboundHandler 中的大部分方法都需要一個 ChannelPromise 引數，以便在操作完成時得到通知，CHannelPromise 是 ChannelFuture 的一個子類，定義了一些可寫方法

5. ChannelHandler 配接器

可以使用 ChannelInboundHandlerAdapter 和 ChannelOutboundHandlerAdapter 類作為自己的 Channel 的起始點，這兩個配接器分別提供了 ChannelInboundHandler 和 CHannelOutboundHandler 的基本實作，并擴展抽象類 ChannelHandlerAdapter

ChannelHandlerAdapter 還提供了實用方法 isSharable()，如果其對應的實作被標記為 Sharable，那么這個方法將回傳 true，表示它可以被添加到多個 ChannelPipeline 中

如果想在自己的 ChannelHandler 中使用這些配接器類，只需要簡單地擴展它們，并重寫自定義方法

ChannelPipeline 介面

可以把 ChannelPipeline 理解成一個攔截流經 Channel 的入站和出站事件的 ChannelHandler 實體鏈，每一個新創建的 Channel 都將會被分配一個新的 ChannelPipeline，Channel 不能附加到另一個 ChannelPipeline，也不能從當前分離，根據事件的起源，事件將會被 ChannelInboundHandler 或者 ChannelOutboundHandler 處理，隨后，通過呼叫 ChannelHandlerContext 實作，它將被轉發給同一超型別的下一個 ChannelHandler

一個典型的同時具有入站和出站 ChannelHandler 的 ChannelPipeline 布局如圖所示

在 ChannelPipeline 傳播事件時，它會測驗 ChannelPipeline 中的下一個 ChannelHandler 的型別是否和事件的運動方向相匹配，如果不匹配，ChannelPipeline 將跳過該 ChannelHandler 并前進到下一個，直到找到和該事件所期望的方向相匹配

1. 修改 ChannelPipeline

通過呼叫 ChannelPipeline 上的相關方法，ChannelHandler 可以添加、洗掉或者替換其他的 ChannelHandler，當然也包括它自己

下表列出了由 ChannelHandler 修改 ChannelPipeline 的相關方法

ChannelPipeline 的用于訪問 ChannelHandler 的操作

2. 觸發事件

ChannelPipeline 的 API 公開了用于呼叫入站和出站操作的附加方法

ChannelPipeline 的入站操作如表

ChannelPipeline 的出站操作如表

總結一下：

• ChannelPipeline 保存了與 Channel 相關聯的 ChannelHandler
• ChannelPipeline 可以根據需要，動態修改 ChannelHandler
• ChannelPipeline 有豐富的 API 用以回應入站和出站事件

ChannelContext 介面

ChannelHandlerContext 代表了 ChannelHandler 和 ChannelPipeline 之間的關聯，每當有 ChannelHandler 添加到 ChannelPipeline 中時，都會創建 ChannelHandlerContext，ChannelHandlerContext 的主要功能是管理它所關聯的 ChannelHandler 和在同一個 ChannelPipeline 中的其他 ChannelHandler 之間的互動

ChannelHandlerContext 有很多方法，其中一些方法也存在于 Channel 和 ChannelPipeline 上，不同的是，如果呼叫 Channel 或者 ChannelHandlerPipeline 上的這些方法，它們將沿著整個 ChannelPipeline 進行傳播，而呼叫位于 ChannelHandlerContext 上的相同方法，則將從當前所關聯的 ChannelHandler 開始，并且只會傳播給位于該 ChannelPipeline 中的下一個能處理該事件的 ChannelHandler

1. 使用 ChannelHandlerContext

Channel、ChannelPipeline、ChannelHandler 以及 ChannelHandlerContext 之間的關系如圖所示

通過 ChannelHandler 或 ChannelPipeline 操作，事件將傳播整個 ChannelPipeline，但在 ChannelHandler 的級別上，事件從上一個 ChannelHandler 到下一個 ChannelHandler 的移動是由 ChannelHandlerContext 上的呼叫完成的

為什么想要從 ChannelPipeline 中的某個特定點開始傳播事件？

• 減少將事件傳經對它不感興趣的 ChannelHandler 所帶來的開銷
• 避免將事件傳經那些可能會對它感興趣的 ChannelHandler

要想呼叫從某個特定的 ChannelHandler 開始的處理程序，必須獲取該 ChannelHandler 之前的 ChannelHandler 所關聯的 ChannelHandlerContext，這個 ChannelHandlerContext 將呼叫和它所關聯的 ChannelHandler 之后的 ChannelHandler

我們還可以通過呼叫 ChannelHandlerContext 上的 pipeline() 方法來獲得 ChannelPipeline 的參考，進而得以在運行時操作 ChannelHandler

例外處理

1. 處理入站例外

如果在處理入站事件的程序中有例外拋出，那么它將從它在 ChannelInboundHandler 里被觸發的那一點開始流經 ChannelPipeline，要想處理這種型別的入站例外，你需要在你的 ChannelInboundHandler 實作重寫以下方法，否則默認將例外轉發給下一個 ChannelHandler：

public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception

因為例外會按照入站方向繼續流動，因此實作了處理例外邏輯的 ChannelInboundHandler 通常位于 ChannelPipeline 的最后，確保例外總能被處理

2. 處理出站例外

用于處理出站操作的正常完成以及例外的選項，都基于以下通知機制：

• 每個出站操作都將回傳一個 ChannelFuture，注冊到 ChannelFuture 的 ChannelFutureListener 將在操作完成時通知結果
• 幾乎所有的 ChannelOutboundHandler 上的方法都會傳入一個 ChannelPromise 實體，作為 ChannelFuture 的子類，ChannelPromise 也可以被分配用于異步通知的監聽器

添加 ChannelFutureListener 只需要呼叫 ChannelFuture實體上的 addListener(ChannelFutureListener) 方法，并且有兩種方式可以做到，第一種是呼叫出站操作（如 write 方法）所回傳的 ChannelFuture 上的 addListener() 方法；第二種是 ChannelFutureListener 添加到作為引數傳遞的 ChannelOutboundHandler 的方法的 ChannelPromise

所以，如果你的 ChannelOutboundHandler 拋出例外，Netty 本身會通知任何已經注冊到對應 ChannelPromise 的注冊器

標籤：Java

上一篇：一分鐘學會Python中pip的安裝與使用

下一篇：終于把 TCP 與 UDP 協議整明白了！