Netty之旅二:口口相傳的高性能Netty到底是什么?


d0iosx.png

高清思維導圖原件(xmind/pdf/jpg)可以關注公眾號:一枝花算不算浪漫 回復netty01即可。

前言

上一篇文章講了NIO相關的知識點,相比於傳統IONIO已經做得很優雅了,為什么我們還要使用Netty

上篇文章最后留了很多坑,講了NIO使用的弊端,也是為了引出Netty而設立的,這篇文章我們就來好好揭開Netty的神秘面紗。

本篇文章的目的很簡單,希望看過后你能看懂Netty的示例代碼,針對於簡單的網絡通信,自己也能用Netty手寫一個開發應用出來!

一個簡單的Netty示例

以下是一個簡單聊天室Server端的程序,代碼參考自:http://www.imooc.com/read/82/article/2166

代碼有點長,主要核心代碼是在main()方法中,這里代碼也希望大家看懂,后面也會一步步剖析。

PS:我是用mac系統,直接在終端輸入telnet 127.0.0.1 8007 即可啟動一個聊天框,如果提示找不到telnet命令,可以通過brew進行安裝,具體步驟請自行百度。

/**
 * @Description netty簡易聊天室
 *
 * @Author 一枝花算不算浪漫
 * @Date 2020/8/10 6:52 上午
 */
public final class NettyChatServer {

    static final int PORT = Integer.parseInt(System.getProperty("port", "8007"));

    public static void main(String[] args) throws Exception {
        // 1. EventLoopGroup
        EventLoopGroup bossGroup = new NioEventLoopGroup(1);
        EventLoopGroup workerGroup = new NioEventLoopGroup();
        try {
            // 2. 服務端引導器
            ServerBootstrap serverBootstrap = new ServerBootstrap();
            // 3. 設置線bootStrap信息
            serverBootstrap.group(bossGroup, workerGroup)
                    // 4. 設置ServerSocketChannel的類型
                    .channel(NioServerSocketChannel.class)
                    // 5. 設置參數
                    .option(ChannelOption.SO_BACKLOG, 100)
                    // 6. 設置ServerSocketChannel對應的Handler,只能設置一個
                    .handler(new LoggingHandler(LogLevel.INFO))
                    // 7. 設置SocketChannel對應的Handler
                    .childHandler(new ChannelInitializer<SocketChannel>() {
                        @Override
                        public void initChannel(SocketChannel ch) throws Exception {
                            ChannelPipeline p = ch.pipeline();
                            // 可以添加多個子Handler
                            p.addLast(new LoggingHandler(LogLevel.INFO));
                            p.addLast(new ChatNettyHandler());
                        }
                    });

            // 8. 綁定端口
            ChannelFuture f = serverBootstrap.bind(PORT).sync();
            // 9. 等待服務端監聽端口關閉,這里會阻塞主線程
            f.channel().closeFuture().sync();
        } finally {
            // 10. 優雅地關閉兩個線程池
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }
    }

    private static class ChatNettyHandler extends SimpleChannelInboundHandler<ByteBuf> {
        @Override
        public void channelActive(ChannelHandlerContext ctx) {
            System.out.println("one conn active: " + ctx.channel());
            // channel是在ServerBootstrapAcceptor中放到EventLoopGroup中的
            ChatHolder.join((SocketChannel) ctx.channel());
        }

        @Override
        protected void channelRead0(ChannelHandlerContext ctx, ByteBuf byteBuf) throws Exception {
            byte[] bytes = new byte[byteBuf.readableBytes()];
            byteBuf.readBytes(bytes);
            String content = new String(bytes, StandardCharsets.UTF_8);
            System.out.println(content);

            if (content.equals("quit\r\n")) {
                ctx.channel().close();
            } else {
                ChatHolder.propagate((SocketChannel) ctx.channel(), content);
            }
        }

        @Override
        public void channelInactive(ChannelHandlerContext ctx) {
            System.out.println("one conn inactive: " + ctx.channel());
            ChatHolder.quit((SocketChannel) ctx.channel());
        }
    }

    private static class ChatHolder {
        static final Map<SocketChannel, String> USER_MAP = new ConcurrentHashMap<>();

        /**
         * 加入群聊
         */
        static void join(SocketChannel socketChannel) {
            // 有人加入就給他分配一個id
            String userId = "用戶"+ ThreadLocalRandom.current().nextInt(Integer.MAX_VALUE);
            send(socketChannel, "您的id為:" + userId + "\n\r");

            for (SocketChannel channel : USER_MAP.keySet()) {
                send(channel, userId + " 加入了群聊" + "\n\r");
            }

            // 將當前用戶加入到map中
            USER_MAP.put(socketChannel, userId);
        }

        /**
         * 退出群聊
         */
        static void quit(SocketChannel socketChannel) {
            String userId = USER_MAP.get(socketChannel);
            send(socketChannel, "您退出了群聊" + "\n\r");
            USER_MAP.remove(socketChannel);

            for (SocketChannel channel : USER_MAP.keySet()) {
                if (channel != socketChannel) {
                    send(channel, userId + " 退出了群聊" + "\n\r");
                }
            }
        }

        /**
         * 擴散說話的內容
         */
        public static void propagate(SocketChannel socketChannel, String content) {
            String userId = USER_MAP.get(socketChannel);
            for (SocketChannel channel : USER_MAP.keySet()) {
                if (channel != socketChannel) {
                    send(channel, userId + ": " + content);
                }
            }
        }

        /**
         * 發送消息
         */
        static void send(SocketChannel socketChannel, String msg) {
            try {
                ByteBufAllocator allocator = ByteBufAllocator.DEFAULT;
                ByteBuf writeBuffer = allocator.buffer(msg.getBytes().length);
                writeBuffer.writeCharSequence(msg, Charset.defaultCharset());
                socketChannel.writeAndFlush(writeBuffer);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}

dkeb0s.png

代碼有點長,執行完的效果如上圖所示,下面所有內容都是圍繞着如何看懂以及如何寫出這樣的代碼來展開的,希望你看完 也能輕松手寫Netty服務端代碼~。通過簡單demo開發讓大家體驗了Netty實現相比NIO確實要簡單的多,但優點不限於此,只需要知道選擇Netty就對了。

Netty核心組件

對應着文章開頭的思維導圖,我們知道Netty的核心組件主要有:

  • Bootstrap && ServerBootstrap
  • EventLoopGroup
  • EventLoop
  • ByteBuf
  • Channel
  • ChannelHandler
  • ChannelFuture
  • ChannelPipeline
  • ChannelHandlerContext

類圖如下:

dk8ZC9.png

Bootstrap & ServerBootstrap

一看到BootStrap大家就應該想到啟動類、引導類這樣的詞匯,之前分析過EurekaServer項目啟動類時介紹過EurekaBootstrap, 他的作用就是上下文初始化、配置初始化。

Netty中我們也有類似的類,BootstrapServerBootstrap它們都是Netty程序的引導類,主要用於配置各種參數,並啟動整個Netty服務,我們看下文章開頭的示例代碼:

ServerBootstrap serverBootstrap = new ServerBootstrap();
serverBootstrap.group(bossGroup, workerGroup)      
        .channel(NioServerSocketChannel.class)
        .option(ChannelOption.SO_BACKLOG, 100)
        .handler(new LoggingHandler(LogLevel.INFO))
        .childHandler(new ChannelInitializer<SocketChannel>() {
            @Override
            public void initChannel(SocketChannel ch) throws Exception {
                ChannelPipeline p = ch.pipeline();
                p.addLast(new LoggingHandler(LogLevel.INFO));
                p.addLast(new ChatNettyHandler());
            }
        });

BootstrapServerBootstrap是針對於ClientServer端定義的兩套啟動類,區別如下:

  • Bootstrap是客戶端引導類,而ServerBootstrap是服務端引導類。
  • Bootstrap通常使用connect()方法連接到遠程的主機和端口,作為一個TCP客戶端
  • ServerBootstrap通常使用bind()方法綁定本地的端口,等待客戶端來連接。
  • ServerBootstrap可以處理Accept事件,這里面childHandler是用來處理Channel請求的,我們可以查看chaildHandler()方法的注解:

dk884H.png

  • Bootstrap客戶端引導只需要一個EventLoopGroup,但是一個ServerBootstrap通常需要兩個(上面的boosGroupworkerGroup)。

EventLoopGroup && EventLoop

EventLoopGroupEventLoop這兩個類名稱定義的很奇怪,對於初學者來說往往無法通過名稱來了解其中的含義,包括我也是這樣。

EventLoopGroup 可以理解為一個線程池,對於服務端程序,我們一般會綁定兩個線程池,一個用於處理 Accept 事件,一個用於處理讀寫事件,看下EventLoop系列的類目錄:

dU4Roj.png

通過上面的類圖,我們才恍然大悟,我的親娘咧,這不就是一個線程池嘛?(名字氣的犄角拐彎的真是難認)

EventLoopGroupEventLoop的集合,一個EventLoopGroup 包含一個或者多個EventLoop。我們可以將EventLoop看做EventLoopGroup線程池中的一個個工作線程。

至於這里為什么要用到兩個線程池,具體的其實可以參考Reactor設計模式,這里暫時不做過多的講解。

  • 一個 EventLoopGroup 包含一個或多個 EventLoop ,即 EventLoopGroup : EventLoop = 1 : n
  • 一個 EventLoop 在它的生命周期內,只能與一個 Thread 綁定,即 EventLoop : Thread = 1 : 1
  • 所有有 EventLoop 處理的 I/O 事件都將在它專有的 Thread 上被處理,從而保證線程安全,即 Thread : EventLoop = 1 : 1
  • 一個 Channel 在它的生命周期內只能注冊到一個 EventLoop 上,即 Channel : EventLoop = n : 1
  • 一個 EventLoop 可被分配至一個或多個 Channel ,即 EventLoop : Channel = 1 : n

當一個連接到達時,Netty 就會創建一個 Channel,然后從 EventLoopGroup 中分配一個 EventLoop 來給這個 Channel 綁定上,在該 Channel 的整個生命周期中都是有這個綁定的 EventLoop 來服務的。

ByteBuf

Java NIO中我們有 ByteBuffer緩沖池,對於它的操作我們應該印象深刻,往Buffer中寫數據時我們需要關注寫入的位置,切換成讀模式時我們還要切換讀寫狀態,不然將會出現大問題。

針對於NIO中超級難用的Buffer類, Netty 提供了ByteBuf來替代。ByteBuf聲明了兩個指針:一個讀指針,一個寫指針,使得讀寫操作進行分離,簡化buffer的操作流程。

dkQocV.png

另外Netty提供了發幾種ByteBuf的實現以供我們選擇,ByteBuf可以分為:

  • PooledUnpooled 池化和非池化
  • Heap 和 Direct,堆內存和堆外內存,NIO中創建Buffer也可以指定
  • Safe 和 Unsafe,安全和非安全

dkJ9TU.png

對於這么多種創建Buffer的方式該怎么選擇呢?Netty也為我們處理好了,我們可以直接使用(真是暖男Ntetty):

ByteBufAllocator allocator = ByteBufAllocator.DEFAULT;
ByteBuf buffer = allocator.buffer(length);

使用這種方式,Netty將最大努力的使用池化、Unsafe、對外內存的方式為我們創建buffer。

Channel

提起Channel並不陌生,上一篇講NIO的三大組件提到過,最常見的就是java.nio.SocketChanneljava.nio.ServerSocketChannel,他們用於非阻塞的I/0操作。類似於NIOChannel,Netty提供了自己的Channel和其子類實現,用於異步I/0操作和其他相關的操作。

Netty 中, Channel 是一個 Socket 連接的抽象, 它為用戶提供了關於底層 Socket 狀態(是否是連接還是斷開) 以及對 Socket 的讀寫等操作。每當 Netty 建立了一個連接后, 都會有一個對應的 Channel 實例。並且,有父子channel的概念。 服務器連接監聽的channel ,也叫 parent channel。 對應於每一個 Socket 連接的channel,也叫 child channel

既然channel 是 Netty 抽象出來的網絡 I/O 讀寫相關的接口,為什么不使用 JDK NIO 原生的 Channel 而要另起爐灶呢,主要原因如下:

  • JDK SocketChannelServersocketChannel 沒有統一的 Channel 接口供業務開發者使用,對一於用戶而言,沒有統一的操作視圖,使用起來並不方便。
  • JDKSocketChannel ScrversockctChannel 的主要職責就是網絡 I/O 操作,由於他們是 SPI 類接口,由具體的虛擬機廠家來提供,所以通過繼承 SPI 功能直接實現 ServersocketChannelSocketChannel 來擴展其工作量和重新 Channel 功類是差不多的。
  • Netty 的 ChannelPipeline Channel 需要夠跟 Netty 的整體架構融合在一起,例如 I/O 模型、基的定制模型,以及基於元數據描述配置化的 TCP 參數等,這些 JDK SocketChannelServersocketChannel都沒有提供,需要重新封裝。
  • 自定義的 Channel ,功實現更加靈活。

基於上述 4 原因,它的設計原理比較簡單, Netty 重新設計了 Channel 接口,並且給予了很多不同的實現。但是功能卻比較繁雜,主要的設計理念如下:

  • Channel 接口層,相關聯的其他操作封裝起來,采用 Facade 模式進行統一封裝,將網絡 I/O 操作、網絡 I/O 統一對外提供。
  • Channel 接口的定義盡量大而全,統一的視圖,由不同子類實現不同的功能,公共功能在抽象父類中實現,最大程度上實現接口的重用。
  • 具體實現采用聚合而非包含的方式,將相關的功類聚合在 Channel 中,由 Channel 統一負責分配和調度,功能實現更加靈活。

Channel 的實現類非常多,繼承關系復雜,從學習的角度我們抽取最重要的兩個 NioServerSocketChannel NioSocketChannel

服務端 NioServerSocketChannel 的繼承關系類圖如下:

dUn8G4.png

客戶端 NioSocketChannel 的繼承關系類圖如下:

dUnJz9.png

后面文章源碼系列會具體分析,這里就不進一步闡述分析了。

ChannelHandler

ChannelHandlerNetty中最常用的組件。ChannelHandler 主要用來處理各種事件,這里的事件很廣泛,比如可以是連接、數據接收、異常、數據轉換等。

ChannelHandler 有兩個核心子類 ChannelInboundHandlerChannelOutboundHandler,其中 ChannelInboundHandler 用於接收、處理入站( Inbound )的數據和事件,而 ChannelOutboundHandler 則相反,用於接收、處理出站( Outbound )的數據和事件。

dkJAp9.png

ChannelInboundHandler

ChannelInboundHandler處理入站數據以及各種狀態變化,當Channel狀態發生改變會調用ChannelInboundHandler中的一些生命周期方法.這些方法與Channel的生命密切相關。

入站數據,就是進入socket的數據。下面展示一些該接口的生命周期API

dUntMR.png

當某個 ChannelInboundHandler的實現重寫 channelRead()方法時,它將負責顯式地釋放與池化的 ByteBuf 實例相關的內存。 Netty 為此提供了一個實用方法ReferenceCountUtil.release()

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

這種方式還挺繁瑣的,Netty提供了一個SimpleChannelInboundHandler,重寫channelRead0()方法,就可以在調用過程中會自動釋放資源.

public class SimpleDiscardHandler
	extends SimpleChannelInboundHandler<Object> {
	@Override
	public void channelRead0(ChannelHandlerContext ctx,
									Object msg) {
			// 不用調用ReferenceCountUtil.release(msg)也會釋放資源
	}
}

ChannelOutboundHandler

出站操作和數據將由 ChannelOutboundHandler 處理。它的方法將被 ChannelChannelPipeline 以及 ChannelHandlerContext 調用。
ChannelOutboundHandler 的一個強大的功能是可以按需推遲操作或者事件,這使得可以通過一些復雜的方法來處理請求。例如, 如果到遠程節點的寫入被暫停了, 那么你可以推遲沖刷操作並在稍后繼續。

d0PxbT.png

ChannelPromiseChannelFuture: ChannelOutboundHandler中的大部分方法都需要一個ChannelPromise參數, 以便在操作完成時得到通知。 ChannelPromiseChannelFuture的一個子類,其定義了一些可寫的方法,如setSuccess()setFailure(),從而使ChannelFuture不可變。

ChannelHandlerAdapter

ChannelHandlerAdapter顧名思義,就是handler的適配器。你需要知道什么是適配器模式,假設有一個A接口,我們需要A的subclass實現功能,但是B類中正好有我們需要的功能,不想復制粘貼B中的方法和屬性了,那么可以寫一個適配器類Adpter繼承B實現A,這樣一來Adapter是A的子類並且能直接使用B中的方法,這種模式就是適配器模式。

就比如Netty中的SslHandler類,想使用ByteToMessageDecoder中的方法進行解碼,但是必須是ChannelHandler子類對象才能加入到ChannelPipeline中,通過如下簽名和其實現細節(SslHandler實現細節就不貼了)就能夠作為一個handler去處理消息了。

public class SslHandler extends ByteToMessageDecoder implements ChannelOutboundHandler

ChannelHandlerAdapter提供了一些實用方法isSharable()如果其對應的實現被標注為 Sharable, 那么這個方法將返回 true, 表示它可以被添加到多個 ChannelPipeline中 。如果想在自己的ChannelHandler中使用這些適配器類,只需要擴展他們,重寫那些想要自定義的方法即可。

ChannelPipeline

每一個新創建的 Channel 都將會被分配一個新的 ChannelPipeline。這項關聯是永久性的; Channel 既不能附加另外一個 ChannelPipeline,也不能分離其當前的。在 Netty 組件的生命周期中,這是一項固定的操作,不需要開發人員的任何干預。

Netty 的 ChannelHandler 為處理器提供了基本的抽象, 目前你可以認為每個 ChannelHandler 的實例都類似於一種為了響應特定事件而被執行的回調。從應用程序開發人員的角度來看, 它充當了所有處理入站和出站數據的應用程序邏輯的攔截載體。ChannelPipeline提供了 ChannelHandler 鏈的容器,並定義了用於在該鏈上傳播入站和出站事件流的 API。當 Channel 被創建時,它會被自動地分配到它專屬的 ChannelPipeline

ChannelHandler 安裝到 ChannelPipeline 中的過程如下所示:

  • 一個ChannelInitializer的實現被注冊到了ServerBootstrap
  • ChannelInitializer.initChannel()方法被調用時,ChannelInitializer將在 ChannelPipeline 中安裝一組自定義的 ChannelHandler
  • ChannelInitializer 將它自己從 ChannelPipeline 中移除

dkJuTO.png

如上圖所示:這是一個同時具有入站和出站 ChannelHandlerChannelPipeline的布局,並且印證了我們之前的關於 ChannelPipeline 主要由一系列的 ChannelHandler 所組成的說法。 ChannelPipeline還提供了通過 ChannelPipeline 本身傳播事件的方法。如果一個入站事件被觸發,它將被從 ChannelPipeline的頭部開始一直被傳播到 Channel Pipeline 的尾端。

你可能會說, 從事件途經 ChannelPipeline的角度來看, ChannelPipeline 的頭部和尾端取決於該事件是入站的還是出站的。然而 Netty 總是將 ChannelPipeline的入站口(圖 的左側)作為頭部,而將出站口(該圖的右側)作為尾端。
當你完成了通過調用 ChannelPipeline.add*()方法將入站處理器( ChannelInboundHandler)和 出 站 處 理 器 ( ChannelOutboundHandler ) 混 合 添 加 到 ChannelPipeline之 后 , 每 一 個ChannelHandler 從頭部到尾端的順序位置正如同我們方才所定義它們的一樣。因此,如果你將圖 6-3 中的處理器( ChannelHandler)從左到右進行編號,那么第一個被入站事件看到的 ChannelHandler 將是1,而第一個被出站事件看到的 ChannelHandler 將是 5。

ChannelPipeline 傳播事件時,它會測試 ChannelPipeline 中的下一個 ChannelHandler 的類型是否和事件的運動方向相匹配。如果不匹配, ChannelPipeline 將跳過該ChannelHandler 並前進到下一個,直到它找到和該事件所期望的方向相匹配的為止。 (當然, ChannelHandler 也可以同時實現ChannelInboundHandler 接口和 ChannelOutboundHandler 接口。)

修改ChannelPipeline

修改指的是添加或刪除ChannelHandler,見代碼示例:

ChannelPipeline pipeline = ..;
FirstHandler firstHandler = new FirstHandler();
// 先添加一個Handler到ChannelPipeline中
pipeline.addLast("handler1", firstHandler);
// 這個Handler放在了first,意味着放在了handler1之前
pipeline.addFirst("handler2", new SecondHandler());
// 這個Handler被放到了last,意味着在handler1之后
pipeline.addLast("handler3", new ThirdHandler());
...
// 通過名稱刪除
pipeline.remove("handler3");
// 通過對象刪除
pipeline.remove(firstHandler);
// 名稱"handler2"替換成名稱"handler4",並切handler2的實例替換成了handler4的實例
pipeline.replace("handler2", "handler4", new ForthHandler());

ChannelPipeline的出入站API

入站API所示:

[圖片上傳失敗...(image-6037f5-1598167949595)]

出站API所示:

dUndZ6.png

ChannelPipeline 這個組件上面所講的大致只需要記住這三點即可:

  • ChannelPipeline 保存了與 Channel 相關聯的 ChannelHandler
  • ChannelPipeline 可以根據需要,通過添加或者刪除 ChannelHandler 來動態地修改
  • ChannelPipeline 有着豐富的API用以被調用,以響應入站和出站事件

ChannelHandlerContext

ChannelHandler 被添加到 ChannelPipeline 時,它將會被分配一個 ChannelHandlerContext ,它代表了 ChannelHandlerChannelPipeline 之間的綁定。ChannelHandlerContext 的主要功能是管理它所關聯的ChannelHandler和在同一個 ChannelPipeline 中的其他ChannelHandler之間的交互。

如果調用ChannelChannelPipeline上的方法,會沿着整個ChannelPipeline傳播,如果調用ChannelHandlerContext上的相同方法,則會從對應的當前ChannelHandler進行傳播。

ChannelHandlerContext API如下表所示:

dUn0IO.png

  • ChannelHandlerContextChannelHandler之間的關聯(綁定)是永遠不會改變的,所以緩存對它的引用是安全的;
  • 如同在本節開頭所解釋的一樣,相對於其他類的同名方法,ChannelHandlerContext的方法將產生更短的事件流, 應該盡可能地利用這個特性來獲得最大的性能。

ChannelHandlerChannelPipeline的關聯使用

dUnDiD.png

ChannelHandlerContext訪問channel

ChannelHandlerContext ctx = ..;
// 獲取channel引用
Channel channel = ctx.channel();
// 通過channel寫入緩沖區
channel.write(Unpooled.copiedBuffer("Netty in Action",
CharsetUtil.UTF_8));

ChannelHandlerContext訪問ChannelPipeline

ChannelHandlerContext ctx = ..;
// 獲取ChannelHandlerContext
ChannelPipeline pipeline = ctx.pipeline();
// 通過ChannelPipeline寫入緩沖區
pipeline.write(Unpooled.copiedBuffer("Netty in Action",
CharsetUtil.UTF_8));

dUnrJe.png

有時候我們不想從頭傳遞數據,想跳過幾個handler,從某個handler開始傳遞數據.我們必須獲取目標handler之前的handler關聯的ChannelHandlerContext

ChannelHandlerContext ctx = ..;
// 直接通過ChannelHandlerContext寫數據,發送到下一個handler
ctx.write(Unpooled.copiedBuffer("Netty in Action", CharsetUtil.UTF_8));

dUnyzd.png

好了,ChannelHandlerContext的基本使用應該掌握了,但是你真的理解ChannelHandlerContext,ChannelPipelineChannelhandler之間的關系了嗎?不理解也沒關系,因為源碼以后會幫你理解的更為深刻。

核心組件之間的關系

  • 一個 Channel 對應一個 ChannelPipeline
  • 一個 ChannelPipeline 包含一條雙向的 ChannelHandlerContext
  • 一個 ChannelHandlerContext 中包含一個 ChannelHandler
  • 一個 Channel 會綁定到一個EventLoop
  • 一個 NioEventLoop 維護了一個 Selector(使用的是 Java 原生的 Selector)
  • 一個 NioEventLoop 相當於一個線程

粘包拆包問題

粘包拆包問題是處於網絡比較底層的問題,在數據鏈路層、網絡層以及傳輸層都有可能發生。我們日常的網絡應用開發大都在傳輸層進行,由於UDP有消息保護邊界,不會發生粘包拆包問題,而因此粘包拆包問題只發生在TCP協議中。具體講TCP是個”流"協議,只有流的概念,沒有包的概念,對於業務上層數據的具體含義和邊界並不了解,它只會根據TCP緩沖區的實際情況進行包的划分。所以在業務上認為,一個完整的包可能會被TCP拆分成多個包進行發送,也有可能把多個小的包封裝成一個大的數據包發送,這就是所謂的TCP粘包和拆包問題。

問題舉例說明

下面針對客戶端分別發送了兩個數據表Packet1Packet2給服務端的時候,TCP粘包和拆包會出現的情況進行列舉說明:

(1)第一種情況,服務端分兩次正常收到兩個獨立數據包,即沒有發生拆包和粘包的現象;

dUncQA.png

(2)第二種情況,接收端只收到一個數據包,由於TCP是不會出現丟包的,所以這一個數據包中包含了客戶端發送的兩個數據包的信息,這種現象即為粘包。這種情況由於接收端不知道這兩個數據包的界限,所以對於服務接收端來說很難處理。

dUn2Lt.png

(3)第三種情況,服務端分兩次讀取到了兩個數據包,第一次讀取到了完整的Packet1Packet2包的部分內容,第二次讀取到了Packet2的剩余內容,這被稱為TCP拆包;

d0Pq8s.png

(4)第四種情況,服務端分兩次讀取到了兩個數據包,第一次讀取到了部分的Packet1內容,第二次讀取到了Packet1剩余內容和Packet2的整包。

dUn5FS.png

如果此時服務端TCP接收滑窗非常小,而數據包Packet1Packet2比較大,很有可能服務端需要分多次才能將兩個包接收完全,期間發生多次拆包。以上列舉情況的背后原因分別如下:

  1. 應用程序寫入的數據大於套接字緩沖區大小,這將會發生拆包。
  2. 應用程序寫入數據小於套接字緩沖區大小,網卡將應用多次寫入的數據發送到網絡上,這將會發生粘包。
  3. 進行MSS(最大報文長度)大小的TCP分段,當TCP報文長度-TCP頭部長度>MSS的時候將發生拆包。
  4. 接收方法不及時讀取套接字緩沖區數據,這將發生粘包。

如何基於Netty處理粘包、拆包問題

由於底層的TCP無法理解上層的業務數據,所以在底層是無法保證數據包不被拆分和重組的,這個問題只能通過上層的應用協議棧設計來解決,根據業界的主流協議的解決方案,可以歸納如下:

  1. 消息定長,例如每個報文的大小為固定長度200字節,如果不夠,空位補空格;
  2. 在包尾增加回車換行符進行分割,例如FTP協議;
  3. 將消息分為消息頭和消息體,消息頭中包含表示消息總長度的字段,通常設計思路為消息頭的第一個字段使用int32來表示消息的總長度;
  4. 更復雜的應用層協議。

之前Netty示例中其實並沒有考慮讀半包問題,這在功能測試往往沒有問題,但是一旦請求數過多或者發送大報文之后,就會存在該問題。如果代碼沒有考慮,往往就會出現解碼錯位或者錯誤,導致程序不能正常工作,下面看看Netty是如何根據主流的解決方案進行抽象實現來幫忙解決這一問題的。

如下表所示,Netty為了找出消息的邊界,采用封幀方式:

方式 解碼 編碼
固定長度 FixedLengthFrameDecoder 簡單
分隔符 DelimiterBasedFrameDecoder 簡單
專門的 length 字段 LengthFieldBasedFrameDecoder LengthFieldPrepender

注意到,Netty提供了對應的解碼器來解決對應的問題,有了這些解碼器,用戶不需要自己對讀取的報文進行人工解碼,也不需要考慮TCP的粘包和半包問題。為什么這么說呢?下面列舉一個包尾增加分隔符的例子:

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.util.CharsetUtil;

import java.util.concurrent.atomic.AtomicInteger;

/**
 * @Author: wuxiaofei
 * @Date: 2020/8/15 0015 19:15
 * @Version: 1.0
 * @Description:入站處理器
 */
@ChannelHandler.Sharable
public class DelimiterServerHandler extends ChannelInboundHandlerAdapter {

    private AtomicInteger counter = new AtomicInteger(0);
    private AtomicInteger completeCounter = new AtomicInteger(0);

    /*** 服務端讀取到網絡數據后的處理*/
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        ByteBuf in = (ByteBuf)msg;
        String request = in.toString(CharsetUtil.UTF_8);
        System.out.println("Server Accept["+request
                +"] and the counter is:"+counter.incrementAndGet());
        String resp = "Hello,"+request+". Welcome to Netty World!"
                + DelimiterEchoServer.DELIMITER_SYMBOL;
        ctx.writeAndFlush(Unpooled.copiedBuffer(resp.getBytes()));
    }

    /*** 服務端讀取完成網絡數據后的處理*/
    @Override
    public void channelReadComplete(ChannelHandlerContext ctx)
            throws Exception {
        ctx.fireChannelReadComplete();
        System.out.println("the ReadComplete count is "
                +completeCounter.incrementAndGet());
    }

    /*** 發生異常后的處理*/
    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        ctx.close();
    }
}

import io.netty.bootstrap.ServerBootstrap;
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.Channel;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.codec.DelimiterBasedFrameDecoder;

import java.net.InetSocketAddress;

/**
 * @Author: wuxiaofei
 * @Date: 2020/8/15 0015 19:17
 * @Version: 1.0
 * @Description:服務端
 */
public class DelimiterEchoServer {

    public static final String DELIMITER_SYMBOL = "@~";
    public static final int PORT = 9997;

    public static void main(String[] args) throws InterruptedException {
        DelimiterEchoServer delimiterEchoServer = new DelimiterEchoServer();
        System.out.println("服務器即將啟動");
        delimiterEchoServer.start();
    }

    public void start() throws InterruptedException {
        final DelimiterServerHandler serverHandler = new DelimiterServerHandler();
        EventLoopGroup group = new NioEventLoopGroup();/*線程組*/
        try {
            ServerBootstrap b = new ServerBootstrap();/*服務端啟動必須*/
            b.group(group)/*將線程組傳入*/
                .channel(NioServerSocketChannel.class)/*指定使用NIO進行網絡傳輸*/
                .localAddress(new InetSocketAddress(PORT))/*指定服務器監聽端口*/
                /*服務端每接收到一個連接請求,就會新啟一個socket通信,也就是channel,
                所以下面這段代碼的作用就是為這個子channel增加handle*/
                .childHandler(new ChannelInitializerImp());
            ChannelFuture f = b.bind().sync();/*異步綁定到服務器,sync()會阻塞直到完成*/
            System.out.println("服務器啟動完成,等待客戶端的連接和數據.....");
            f.channel().closeFuture().sync();/*阻塞直到服務器的channel關閉*/
        } finally {
            group.shutdownGracefully().sync();/*優雅關閉線程組*/
        }
    }

    private static class ChannelInitializerImp extends ChannelInitializer<Channel> {

        @Override
        protected void initChannel(Channel ch) throws Exception {
            ByteBuf delimiter = Unpooled.copiedBuffer(DELIMITER_SYMBOL
                    .getBytes());
            //服務端收到數據包后經過DelimiterBasedFrameDecoder即分隔符基礎框架解碼器解碼為一個個帶有分隔符的數據包。
            ch.pipeline().addLast( new DelimiterBasedFrameDecoder(1024,
                    delimiter));
            ch.pipeline().addLast(new DelimiterServerHandler());
        }
    }

}

添加到ChannelPipelineDelimiterBasedFrameDecoder用於對使用分隔符結尾的消息進行自動解碼,當然還有沒有用到的FixedLengthFrameDecoder用於對固定長度的消息進行自動解碼等解碼器。正如上門的代碼使用案例,有了Netty提供的幾碼器可以輕松地完成對很多消息的自動解碼,而且不需要考慮TCP粘包/拆包導致的讀半包問題,極大地提升了開發效率。

Netty示例代碼詳解

相信看完上面的鋪墊,你對Netty編碼有了一定的了解了,下面再來整體梳理一遍吧。

dVp7yn.png

1、設置EventLoopGroup線程組(Reactor線程組)

EventLoopGroup bossGroup = new NioEventLoopGroup(1);
EventLoopGroup workerGroup = new NioEventLoopGroup();

上面我們說過Netty中使用Reactor模式,bossGroup表示服務器連接監聽線程組,專門接受 Accept 新的客戶端client 連接。另一個workerGroup表示處理每一連接的數據收發的線程組,來處理消息的讀寫事件。

2、服務端引導器

ServerBootstrap serverBootstrap = new ServerBootstrap();

集成所有配置,用來啟動Netty服務端。

3、設置ServerBootstrap信息

serverBootstrap.group(bossGroup, workerGroup);

將兩個線程組設置到ServerBootstrap中。

4、設置ServerSocketChannel類型

serverBootstrap.channel(NioServerSocketChannel.class);

設置通道的IO類型,Netty不止支持Java NIO,也支持阻塞式IO,例如OIOOioServerSocketChannel.class)

5、設置參數

serverBootstrap.option(ChannelOption.SO_BACKLOG, 100);

通過option()方法可以設置很多參數,這里SO_BACKLOG標識服務端接受連接的隊列長度,如果隊列已滿,客戶端連接將被拒絕。默認值,Windows為200,其他為128,這里設置的是100。

6、設置Handler

serverBootstrap.handler(new LoggingHandler(LogLevel.INFO));

設置 ServerSocketChannel對應的Handler,這里只能設置一個,它會在SocketChannel建立起來之前執行。

7、設置子Handler

serverBootstrap.childHandler(new ChannelInitializer<SocketChannel>() {
    @Override
    public void initChannel(SocketChannel ch) throws Exception {
        ChannelPipeline p = ch.pipeline();
        p.addLast(new LoggingHandler(LogLevel.INFO));
        p.addLast(new ChatNettyHandler());
    }
});

Netty中提供了一種可以設置多個Handler的途徑,即使用ChannelInitializer方式。ChannelPipelineNetty處理請求的責任鏈,這是一個ChannelHandler的鏈表,而ChannelHandler就是用來處理網絡請求的內容的。

每一個channel,都有一個處理器流水線。裝配child channel流水線,調用childHandler()方法,傳遞一個ChannelInitializer 的實例。

child channel 創建成功,開始通道初始化的時候,在bootstrap啟動器中配置的ChannelInitializer 實例就會被調用。

這個時候,才真正的執行去執行 initChannel 初始化方法,開始通道流水線裝配。

流水線裝配,主要是在流水線pipeline的后面,增加負責數據讀寫、處理業務邏輯的handler

處理器 ChannelHandler 用來處理網絡請求內容,有ChannelInboundHandlerChannelOutboundHandler兩種,ChannlPipeline會從頭到尾順序調用ChannelInboundHandler處理網絡請求內容,從尾到頭調用ChannelOutboundHandler處理網絡請求內容

8、綁定端口號

ChannelFuture f = serverBootstrap.bind(PORT).sync();

綁定端口號

9、等待服務端端口號關閉

f.channel().closeFuture().sync();

等待服務端監聽端口關閉,sync()會阻塞主線程,內部調用的是 Objectwait()方法

10、關閉EventLoopGroup線程組

bossGroup.shutdownGracefully();
workerGroup.shutdownGracefully();

總結

這篇文章主要是從一個demo作為引子,然后介紹了Netty的包結構、Reactor模型、編程規范等等,目的很簡單,希望你能夠讀懂這段demo並寫出來。

后面開始繼續Netty源碼解析部分,敬請期待。

參考資料

  1. 《Netty in Action》書籍
  2. 慕課Netty專欄
  3. 掘金閃電俠Netty小冊
  4. 芋道源碼Netty專欄
  5. Github[fork from krcys]

感謝Netty專欄作者們優秀的文章內容~

原創干貨分享.png


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM