Bootstrap、ServerBootstrap
Bootstrap 意思是引導,一個 Netty 應用通常由一個 Bootstrap 開始,主要作用是配置整個 Netty 程式,串聯各個元件,Netty 中 Bootstrap 類是用戶端程式的啟動引導類,ServerBootstrap 是服務端啟動引導類。
常見的方法有
- public ServerBootstrap group(EventLoopGroup parentGroup, EventLoopGroup childGroup):該方法用于伺服器端,用來設定兩個 EventLoop。
- public B group(EventLoopGroup group):該方法用于用戶端,用來設定一個 EventLoop。
- public B channel(Class<? extends C> channelClass):該方法用來設定一個伺服器端的通道實作。
- public <T> B option(ChannelOption<T> option, T value):用來給 ServerChannel 添加配置。
- public <T> ServerBootstrap childOption(ChannelOption<T> childOption, T value):用來給接收到的通道添加配置。
- public ServerBootstrap childHandler(ChannelHandler childHandler):該方法用來設定業務處理類(自定義的 handler)。
- public ChannelFuture bind(int inetPort):該方法用于伺服器端,用來設定占用的端口号。
- public ChannelFuture connect(String inetHost, int inetPort):該方法用于用戶端,用來連接配接伺服器端。
Future、ChannelFuture
Netty 中所有的 IO 操作都是異步的,不能立刻得知消息是否被正确處理。但是可以過一會等它執行完成或者直接注冊一個監聽,具體的實作就是通過 Future 和 ChannelFutures,他們可以注冊一個監聽,當操作執行成功或失敗時監聽會自動觸發注冊的監聽事件。
常見的方法有
- Channel channel():傳回目前正在進行 IO 操作的通道。
- ChannelFuture sync():等待異步操作執行完畢。
Channel
- 1、Netty 網絡通信的元件,能夠用于執行網絡 I/O 操作。
- 2、通過Channel 可獲得目前網絡連接配接的通道的狀态。
- 3、通過Channel 可獲得 網絡連接配接的配置參數 (例如接收緩沖區大小)。
- 4、Channel 提供異步的網絡 I/O 操作(如建立連接配接,讀寫,綁定端口),異步調用意味着任何 I/O 調用都将立即傳回,并且不保證在調用結束時所請求的 I/O 操作已完成。
- 5、調用立即傳回一個 ChannelFuture 執行個體,通過注冊監聽器到 ChannelFuture 上,可以 I/O 操作成功、失敗或取消時回調通知調用方。
- 6、支援關聯 I/O 操作與對應的處理程式。
- 7、不同協定、不同的阻塞類型的連接配接都有不同的 Channel 類型與之對應。
常用的 Channel 類型:
- NioSocketChannel:異步的用戶端 TCP Socket 連接配接。
- NioServerSocketChannel:異步的伺服器端 TCP Socket 連接配接。
- NioDatagramChannel:異步的 UDP 連接配接。
- NioSctpChannel:異步的用戶端 Sctp 連接配接。
- NioSctpServerChannel:異步的 Sctp 伺服器端連接配接,這些通道涵蓋了 UDP 和 TCP 網絡 IO 以及檔案 IO。
Selector
Netty 基于 Selector 對象實作 I/O 多路複用,通過 Selector 一個線程可以監聽多個連接配接的 Channel 事件。
當向一個 Selector 中注冊 Channel 後,Selector 内部的機制就可以自動不斷地查詢(Select) 這些注冊的 Channel 是否有已就緒的 I/O 事件(例如可讀,可寫,網絡連接配接完成等),這樣程式就可以很簡單地使用一個線程高效地管理多個 Channel 。
ChannelHandler 及其實作類
- ChannelHandler:是一個接口,處理 I/O 事件或攔截 I/O 操作,并将其轉發到其 ChannelPipeline(業務處理鍊)中的下一個處理程式。
- ChannelHandler:本身并沒有提供很多方法,因為這個接口有許多的方法需要實作,友善使用期間,可以繼承它的子類。
- ChannelHandler:及其實作類一覽圖
![](https://img.laitimes.com/img/_0nNw4CM6IyYiwiM6ICdiwiI9s2RkBnVHFmb1clWvB3MaVnRtp1XlBXe0xCMy81dvRWYoNHLwEzX5xCMx8FesU2cfdGLwMzX0xiRGZkRGZ0Xy9GbvNGLpZTY1EmMZVDUSFTU4VFRR9Fd4VGdsQTMfVmepNHLrJXYtJXZ0F2dvwVZnFWbp1zczV2YvJHctM3cv1Ce-cmbw5iM5ADOxQmY1kDMiJWN1UGNzYzX5UDOyUTM4EzLcBTMyIDMy8CXn9Gbi9CXzV2Zh1WavwVbvNmLvR3YxUjLyM3Lc9CX6MHc0RHaiojIsJye.png)
ChannelHandler 本身并沒有提供很多方法,因為這個接口有許多的方法需要實作,友善使用期間,可以繼承它的子類:
- ChannelInboundHandler:用于處理入站 I/O 事件。
- ChannelOutboundHandler:用于處理出站 I/O 操作。
或者使用以下擴充卡類:
- ChannelInboundHandlerAdapter:用于處理入站 I/O 事件。
- ChannelOutboundHandlerAdapter:用于處理出站 I/O 操作。
- ChannelDuplexHandler:用于處理入站和出站事件。
我們經常需要自定義一個 Handler 類去繼承 ChannelInboundHandlerAdapter,然後通過重寫相應方法實作業務邏輯,我們接下來看看一般都需要重寫哪些方法
public class ChannelInboundHandlerAdapter extends ChannelHandlerAdapter implements ChannelInboundHandler {
public ChannelInboundHandlerAdapter() { }
public void channelRegistered(ChannelHandlerContext ctx) throws Exception {
ctx.fireChannelRegistered();
}
public void channelUnregistered(ChannelHandlerContext ctx) throws Exception {
ctx.fireChannelUnregistered();
}
//通道就緒事件
public void channelActive(ChannelHandlerContext ctx) throws Exception {
ctx.fireChannelActive();
}
public void channelInactive(ChannelHandlerContext ctx) throws Exception {
ctx.fireChannelInactive();
}
//通道讀取資料事件
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
ctx.fireChannelRead(msg);
}
//資料讀取完畢事件
public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
ctx.fireChannelReadComplete();
}
public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
ctx.fireUserEventTriggered(evt);
}
public void channelWritabilityChanged(ChannelHandlerContext ctx) throws Exception {
ctx.fireChannelWritabilityChanged();
}
//通道發生異常事件
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
ctx.fireExceptionCaught(cause);
}
}
Pipeline 和 ChannelPipeline
ChannelPipeline 是一個重點:
- 1、ChannelPipeline 是一個 Handler 的集合,它負責處理和攔截 inbound 或者 outbound 的事件和操作,相當于一個貫穿 Netty 的鍊。(也可以這樣了解:ChannelPipeline 是 儲存 ChannelHandler 的 List,用于處理或攔截 Channel 的入站事件和出站操作)。
- 2、ChannelPipeline 實作了一種進階形式的攔截過濾器模式,使使用者可以完全控制事件的處理方式,以及 Channel 中各個的 ChannelHandler 如何互相互動。
- 3、在 Netty 中每個 Channel 都有且僅有一個 ChannelPipeline 與之對應,它們的組成關系如下:
- 一個 Channel 包含了一個 ChannelPipeline,而 ChannelPipeline 中又維護了一個由 ChannelHandlerContext 組成的雙向連結清單,并且每個 ChannelHandlerContext 中又關聯着一個 ChannelHandler。
- 入站事件和出站事件在一個雙向連結清單中,入站事件會從連結清單 head 往後傳遞到最後一個入站的 handler,出站事件會從連結清單 tail 往前傳遞到最前一個出站的 handler,兩種類型的 handler 互不幹擾
常用方法:
- ChannelPipeline addFirst(ChannelHandler... handlers):把一個業務處理類(handler)添加到鍊中的第一個位置。
- ChannelPipeline addLast(ChannelHandler... handlers):把一個業務處理類(handler)添加到鍊中的最後一個位置。
ChannelHandlerContext
- 1、儲存 Channel 相關的所有上下文資訊,同時關聯一個 ChannelHandler 對象。
- 2、即ChannelHandlerContext 中 包 含 一 個 具 體 的 事 件 處 理 器 ChannelHandler , 同 時ChannelHandlerContext 中也綁定了對應的 pipeline 和 Channel 的資訊,友善對 ChannelHandler進行調用。
常用方法:
- ChannelFuture close():關閉通道。
- ChannelOutboundInvoker flush():重新整理。
- ChannelFuture writeAndFlush(Object msg):将 數 據 寫 到 ChannelPipeline 中 當 前ChannelHandler 的下一個 ChannelHandler 開始處理(出站)
ChannelOption
- 1、Netty 在建立 Channel 執行個體後,一般都需要設定 ChannelOption 參數。
- 2、ChannelOption 參數如下:
ChannelOption.SO_BACKLOG
對應 TCP/IP 協定 listen 函數中的 backlog 參數,用來初始化伺服器可連接配接隊列大小。服
務端處理用戶端連接配接請求是順序處理的,是以同一時間隻能處理一個用戶端連接配接。多個用戶端來的時候,服務端将不能處理的用戶端連接配接請求放在隊列中等待處理,backlog 參數指定了隊列的大小。
ChannelOption.SO_KEEPALIVE
一直保持連接配接活動狀态。
EventLoopGroup 和其實作類 NioEventLoopGroup
- 1、EventLoopGroup 是一組 EventLoop 的抽象,Netty 為了更好的利用多核 CPU 資源,一般會有多個 EventLoop 同時工作,每個 EventLoop 維護着一個 Selector 執行個體。
- 2、EventLoopGroup 提供 next 接口,可以從組裡面按照一定規則擷取其中一個 EventLoop來處理任務。在 Netty 伺服器端程式設計中,我們一般都需要提供兩個 EventLoopGroup,例如:BossEventLoopGroup 和 WorkerEventLoopGroup。
- 3、通常一個服務端口即一個 ServerSocketChannel對應一個Selector 和一個EventLoop線程。BossEventLoop 負責接收用戶端的連接配接并将 SocketChannel 交給 WorkerEventLoopGroup 來進行 IO 處理,如下圖所示
- BossEventLoopGroup 通常是一個單線程的 EventLoop,EventLoop 維護着一個注冊了ServerSocketChannel 的 Selector 執行個體BossEventLoop 不斷輪詢 Selector 将連接配接事件分離出來。
- 通常是 OP_ACCEPT 事件,然後将接收到的 SocketChannel 交給WorkerEventLoopGroup。
常用方法:
- public NioEventLoopGroup():構造方法。
- public Future<?> shutdownGracefully():斷開連接配接,關閉線程。
Unpooled 類
常用方法如下所示
通過給定的資料和字元編碼傳回一個 ByteBuf 對象(類似于 NIO 中的 ByteBuffer 但有差別)
public static ByteBuf copiedBuffer(CharSequence string, Charset charset)
Unpooled使用
public class NettyByteBuf01 {
public static void main(String[] args) {
//建立一個ByteBuf
//該對象包含一個數組arr,是一個byte[10]
//Netty的ByteBuf在讀寫切換不需要flip方法反轉,
// 因為底層維護了一個readerIndex 和 writerIndex
//通過readerIndex、writerIndex、capacity将ByteBuf分成三段
//0 ---> readerIndex 已經讀取的區域
//readerIndex ---> writerIndex 可以讀取的區域
//writerIndex ---> capacity 可以寫入的區域
ByteBuf buffer = Unpooled.buffer(10);
for (int i = 0; i < 10; i++) {
buffer.readBytes(i);
}
//輸出
for (int i = 0; i < buffer.capacity(); i++) {
System.out.println(buffer.readByte());
//執行指定索引擷取資料readerIndex不會變化
//System.out.println(buffer.getByte(i));
}
}
}
public class NettyByteBuf02 {
public static void main(String[] args) {
//建立一個ByteBuf
ByteBuf byteBuf = Unpooled.copiedBuffer("hello world! 重慶", CharsetUtil.UTF_8);
//使用相關的api
if(byteBuf.hasArray()){
byte[] content = byteBuf.array();
//将content轉成中文字元串
System.out.println(new String(content,CharsetUtil.UTF_8));
System.out.println("byteBuf:"+byteBuf);
System.out.println(byteBuf.arrayOffset());
System.out.println(byteBuf.readerIndex());
System.out.println(byteBuf.writerIndex());
System.out.println(byteBuf.capacity());
System.out.println(byteBuf.readableBytes());//可讀的位元組數
//使用for循環讀取
for (int i = 0; i < byteBuf.readableBytes(); i++) {
System.out.println((char)byteBuf.getByte(i));
}
//按某個範圍讀取
System.out.println(byteBuf.getCharSequence(0,5,CharsetUtil.UTF_8));
}
}
}