netty原始碼分析之新連線接入全解析

閃電俠發表於2019-03-02
Netty原始碼

本文收穫

通讀本文，你會了解到

  1. netty如何接受新的請求
  2. netty如何給新請求分配reactor執行緒
  3. netty如何給每個新連線增加ChannelHandler

其實，遠不止這些～

前序背景

讀這篇文章之前，最好掌握一些前序知識，包括netty中的reactor執行緒，以及服務端啟動過程 下面我帶你簡單地回顧一下

1.netty中的reactor執行緒

netty中最核心的東西莫過於兩種型別的reactor執行緒，可以看作netty中兩種型別的發動機，驅動著netty整個框架的運轉

一種型別的reactor執行緒是boos執行緒組，專門用來接受新的連線，然後封裝成channel物件扔給worker執行緒組；還有一種型別的reactor執行緒是worker執行緒組，專門用來處理連線的讀寫

不管是boos執行緒還是worker執行緒，所做的事情均分為以下三個步驟

  1. 輪詢註冊在selector上的IO事件
  2. 處理IO事件
  3. 執行非同步task

對於boos執行緒來說，第一步輪詢出來的基本都是 accept 事件，表示有新的連線，而worker執行緒輪詢出來的基本都是read/write事件，表示網路的讀寫事件

2.服務端啟動

服務端啟動過程是在使用者執行緒中開啟，第一次新增非同步任務的時候啟動boos執行緒被啟動，netty將處理新連線的過程封裝成一個channel，對應的pipeline會按順序處理新建立的連線(關於pipeline我後面會開篇詳細分析)

瞭解完兩個背景，我們開始進入正題

新連線的建立

簡單來說，新連線的建立可以分為三個步驟

  1. 檢測到有新的連線
  2. 將新的連線註冊到worker執行緒組
  3. 註冊新連線的讀事件

下面帶你庖丁解牛，一步步分析整個過程

檢測到有新連線進入

我們已經知道，當服務端綁啟動之後，服務端的channel已經註冊到boos reactor執行緒中，reactor不斷檢測有新的事件，直到檢測出有accept事件發生

NioEventLoop.java

private void processSelectedKey(SelectionKey k, AbstractNioChannel ch) {
    final AbstractNioChannel.NioUnsafe unsafe = ch.unsafe();
    int readyOps = k.readyOps();
    if ((readyOps & (SelectionKey.OP_READ | SelectionKey.OP_ACCEPT)) != 0 || readyOps == 0) {
        unsafe.read();
    }
}
複製程式碼

上面這段程式碼是reactor執行緒三部曲中的第二部曲，表示boos reactor執行緒已經輪詢到 SelectionKey.OP_ACCEPT 事件，說明有新的連線進入，此時將呼叫channel的 unsafe來進行實際的操作

關於 unsafe，這篇文章我不打算細講，下面是netty作者對於unsafe的解釋

Unsafe operations that should never be called from user-code. These methods are only provided to implement the actual transport.

你只需要瞭解一個大概的概念，就是所有的channel底層都會有一個與unsafe繫結，每種型別的channel實際的操作都由unsafe來實現

而從上一篇文章，服務端的啟動過程中，我們已經知道，服務端對應的channel的unsafe是 NioMessageUnsafe，那麼，我們進入到它的read方法，進入新連線處理的第二步

註冊到reactor執行緒

NioMessageUnsafe.java

private final List<Object> readBuf = new ArrayList<Object>();

public void read() {
    assert eventLoop().inEventLoop();
    final ChannelPipeline pipeline = pipeline();
    final RecvByteBufAllocator.Handle allocHandle = unsafe().recvBufAllocHandle();
    do {
        int localRead = doReadMessages(readBuf);
        if (localRead == 0) {
            break;
        }
        if (localRead < 0) {
            closed = true;
            break;
        }
    } while (allocHandle.continueReading());
    int size = readBuf.size();
    for (int i = 0; i < size; i ++) {
        pipeline.fireChannelRead(readBuf.get(i));
    }
    readBuf.clear();
    pipeline.fireChannelReadComplete();
}
複製程式碼

我省去了非關鍵部分的程式碼，可以看到，一上來，就用一條斷言確定該read方法必須是reactor執行緒呼叫，然後拿到channel對應的pipeline和 RecvByteBufAllocator.Handle(先不解釋)

接下來，呼叫 doReadMessages 方法不斷地讀取訊息，用 readBuf 作為容器，這裡，其實可以猜到讀取的是一個個連線，然後呼叫 pipeline.fireChannelRead()，將每條新連線經過一層服務端channel的洗禮

之後清理容器，觸發 pipeline.fireChannelReadComplete()，整個過程清晰明瞭，不含一絲雜質，下面我們具體看下這兩個方法

1.doReadMessages(List) 2.pipeline.fireChannelRead(NioSocketChannel)

1.doReadMessages()

protected int doReadMessages(List<Object> buf) throws Exception {
    SocketChannel ch = javaChannel().accept();

    try {
        if (ch != null) {
            buf.add(new NioSocketChannel(this, ch));
            return 1;
        }
    } catch (Throwable t) {
        logger.warn("Failed to create a new channel from an accepted socket.", t);

        try {
            ch.close();
        } catch (Throwable t2) {
            logger.warn("Failed to close a socket.", t2);
        }
    }

    return 0;
}
複製程式碼

我們終於窺探到netty呼叫jdk底層nio的邊界 javaChannel().accept();，由於netty中reactor執行緒第一步就掃描到有accept事件發生，因此，這裡的accept方法是立即返回的，返回jdk底層nio建立的一條channel

netty將jdk的 SocketChannel 封裝成自定義的 NioSocketChannel，加入到list裡面，這樣外層就可以遍歷該list，做後續處理

從上篇文章中，我們已經知道服務端的建立過程中會建立netty中一系列的核心元件，包括pipeline,unsafe等等，那麼，接受一條新連線的時候是否也會建立這一系列的元件呢？

帶著這個疑問，我們跟進去

NioSocketChannel.java

public NioSocketChannel(Channel parent, SocketChannel socket) {
    super(parent, socket);
    config = new NioSocketChannelConfig(this, socket.socket());
}
複製程式碼

我們重點分析 super(parent, socket)，config相關的分析我們放到後面的文章中

NioSocketChannel的父類為 AbstractNioByteChannel

AbstractNioByteChannel.java

protected AbstractNioByteChannel(Channel parent, SelectableChannel ch) {
    super(parent, ch, SelectionKey.OP_READ);
}
複製程式碼

這裡，我們看到jdk nio裡面熟悉的影子—— SelectionKey.OP_READ，一般在原生的jdk nio程式設計中，也會註冊這樣一個事件，表示對channel的讀感興趣

我們繼續往上，追蹤到AbstractNioByteChannel的父類 AbstractNioChannel, 這裡，我相信讀了上篇文章的你對於這部分程式碼肯定是有印象的

protected AbstractNioChannel(Channel parent, SelectableChannel ch, int readInterestOp) {
    super(parent);
    this.ch = ch;
    this.readInterestOp = readInterestOp;
    try {
        ch.configureBlocking(false);
    } catch (IOException e) {
        try {
            ch.close();
        } catch (IOException e2) {
            if (logger.isWarnEnabled()) {
                logger.warn(
                        "Failed to close a partially initialized socket.", e2);
            }
        }
        throw new ChannelException("Failed to enter non-blocking mode.", e);
    }
}
複製程式碼

在建立服務端channel的時候，最終也會進入到這個方法，super(parent), 便是在AbstractChannel中建立一系列和該channel繫結的元件，如下

protected AbstractChannel(Channel parent) {
    this.parent = parent;
    id = newId();
    unsafe = newUnsafe();
    pipeline = newChannelPipeline();
}
複製程式碼

而這裡的 readInterestOp 表示該channel關心的事件是 SelectionKey.OP_READ，後續會將該事件註冊到selector，之後設定該通道為非阻塞模式

到了這裡，我終於可以將netty裡面最常用的channel的結構圖放給你看

簡化版channel繼承關係

這裡的繼承關係有所簡化，當前，我們只需要瞭解這麼多。

首先

  1. channel 繼承 Comparable 表示channel是一個可以比較的物件
  2. channel 繼承AttributeMap表示channel是可以繫結屬性的物件，在使用者程式碼中，我們經常使用channel.attr(...)方法就是來源於此
  3. ChannelOutboundInvoker是4.1.x版本新加的抽象，表示一條channel可以進行的操作
  4. DefaultAttributeMap用於AttributeMap抽象的預設方法,後面channel繼承了直接使用
  5. AbstractChannel用於實現channel的大部分方法，其中我們最熟悉的就是其建構函式中，建立出一條channel的基本元件
  6. AbstractNioChannel基於AbstractChannel做了nio相關的一些操作，儲存jdk底層的 SelectableChannel，並且在建構函式中設定channel為非阻塞
  7. 最後，就是兩大channel，NioServerSocketChannel，NioSocketChannel對應著服務端接受新連線過程和新連線讀寫過程

讀到這，關於channel的整體框架你基本已經瞭解了一大半了

好了，讓我們退棧，繼續之前的原始碼分析，在建立出一條 NioSocketChannel之後，放置在List容器裡面之後，就開始進行下一步操作

2.pipeline.fireChannelRead(NioSocketChannel)

AbstractNioMessageChannel.java

pipeline.fireChannelRead(NioSocketChannel);
複製程式碼

在沒有正式介紹pipeline之前，請讓我簡單介紹一下pipeline這個元件

在netty的各種型別的channel中，都會包含一個pipeline，字面意思是管道，我們可以理解為一條流水線工藝，流水線工藝有起點，有結束，中間還有各種各樣的流水線關卡，一件物品，在流水線起點開始處理，經過各個流水線關卡的加工，最終到流水線結束

對應到netty裡面，流水線的開始就是HeadContxt，流水線的結束就是TailConext，HeadContxt中呼叫Unsafe做具體的操作，TailConext中用於向使用者丟擲pipeline中未處理異常以及對未處理訊息的警告，關於pipeline的具體分析我們後面再詳細探討

通過前面一篇文章，我們已經知道在服務端處理新連線的pipeline中，已經自動新增了一個pipeline處理器 ServerBootstrapAcceptor, 並已經將使用者程式碼中設定的一系列的引數傳入了建構函式，接下來，我們就來看下ServerBootstrapAcceptor

ServerBootstrapAcceptor.java

 private static class ServerBootstrapAcceptor extends ChannelInboundHandlerAdapter {
    private final EventLoopGroup childGroup;
    private final ChannelHandler childHandler;
    private final Entry<ChannelOption<?>, Object>[] childOptions;
    private final Entry<AttributeKey<?>, Object>[] childAttrs;

    ServerBootstrapAcceptor(
            EventLoopGroup childGroup, ChannelHandler childHandler,
            Entry<ChannelOption<?>, Object>[] childOptions, Entry<AttributeKey<?>, Object>[] childAttrs) {
        this.childGroup = childGroup;
        this.childHandler = childHandler;
        this.childOptions = childOptions;
        this.childAttrs = childAttrs;
    }

    public void channelRead(ChannelHandlerContext ctx, Object msg) {
        final Channel child = (Channel) msg;

        child.pipeline().addLast(childHandler);

        for (Entry<ChannelOption<?>, Object> e: childOptions) {
            try {
                if (!child.config().setOption((ChannelOption<Object>) e.getKey(), e.getValue())) {
                    logger.warn("Unknown channel option: " + e);
                }
            } catch (Throwable t) {
                logger.warn("Failed to set a channel option: " + child, t);
            }
        }

        for (Entry<AttributeKey<?>, Object> e: childAttrs) {
            child.attr((AttributeKey<Object>) e.getKey()).set(e.getValue());
        }

        try {
            childGroup.register(child).addListener(new ChannelFutureListener() {
                @Override
                public void operationComplete(ChannelFuture future) throws Exception {
                    if (!future.isSuccess()) {
                        forceClose(child, future.cause());
                    }
                }
            });
        } catch (Throwable t) {
            forceClose(child, t);
        }
    }
複製程式碼

前面的 pipeline.fireChannelRead(NioSocketChannel); 最終通過head->unsafe->ServerBootstrapAcceptor的呼叫鏈，呼叫到這裡的 ServerBootstrapAcceptor 的channelRead方法

而 channelRead 一上來就把這裡的msg強制轉換為 Channel, 為什麼這裡可以強制轉換？讀者可以思考一下

然後，拿到該channel，也就是我們之前new出來的 NioSocketChannel對應的pipeline，將使用者程式碼中的 childHandler，新增到pipeline，這裡的 childHandler 在使用者程式碼中的體現為

ServerBootstrap b = new ServerBootstrap();
b.group(bossGroup, workerGroup)
 .channel(NioServerSocketChannel.class)
 .childHandler(new ChannelInitializer<SocketChannel>() {
     @Override
     public void initChannel(SocketChannel ch) throws Exception {
         ChannelPipeline p = ch.pipeline();
         p.addLast(new EchoServerHandler());
     }
 });
複製程式碼

其實對應的是 ChannelInitializer，到了這裡，NioSocketChannel中pipeline對應的處理器為 head->ChannelInitializer->tail，牢記，後面會再次提到！

接著，設定 NioSocketChannel 對應的 attr和option，然後進入到 childGroup.register(child)，這裡的childGroup就是我們在啟動程式碼中new出來的NioEventLoopGroup，具體可以參考這篇文章

我們進入到NioEventLoopGroup的register方法，代理到其父類MultithreadEventLoopGroup

MultithreadEventLoopGroup.java

public ChannelFuture register(Channel channel) {
    return next().register(channel);
}
複製程式碼

這裡又扯出來一個 next()方法，我們跟進去

MultithreadEventLoopGroup.java

@Override
public EventLoop next() {
    return (EventLoop) super.next();
}
複製程式碼

回到其父類

MultithreadEventExecutorGroup.java

@Override
public EventExecutor next() {
    return chooser.next();
}
複製程式碼

這裡的chooser對應的類為 EventExecutorChooser，字面意思為事件執行器選擇器，放到我們這裡的上下文中的作用就是從worker reactor執行緒組中選擇一個reactor執行緒

public interface EventExecutorChooserFactory {

    /**
     * Returns a new {@link EventExecutorChooser}.
     */
    EventExecutorChooser newChooser(EventExecutor[] executors);

    /**
     * Chooses the next {@link EventExecutor} to use.
     */
    @UnstableApi
    interface EventExecutorChooser {

        /**
         * Returns the new {@link EventExecutor} to use.
         */
        EventExecutor next();
    }
}
複製程式碼

關於chooser的具體建立我不打算展開，相信前面幾篇文章中的原始碼閱讀技巧可以幫助你找出choose的始末，這裡，我直接告訴你（但是勸你還是自行分析一下，簡單得很），chooser的實現有兩種

public final class DefaultEventExecutorChooserFactory implements EventExecutorChooserFactory {

    public static final DefaultEventExecutorChooserFactory INSTANCE = new DefaultEventExecutorChooserFactory();

    private DefaultEventExecutorChooserFactory() { }

    @SuppressWarnings("unchecked")
    @Override
    public EventExecutorChooser newChooser(EventExecutor[] executors) {
        if (isPowerOfTwo(executors.length)) {
            return new PowerOfTowEventExecutorChooser(executors);
        } else {
            return new GenericEventExecutorChooser(executors);
        }
    }

    private static boolean isPowerOfTwo(int val) {
        return (val & -val) == val;
    }

    private static final class PowerOfTowEventExecutorChooser implements EventExecutorChooser {
        private final AtomicInteger idx = new AtomicInteger();
        private final EventExecutor[] executors;

        PowerOfTowEventExecutorChooser(EventExecutor[] executors) {
            this.executors = executors;
        }

        @Override
        public EventExecutor next() {
            return executors[idx.getAndIncrement() & executors.length - 1];
        }
    }

    private static final class GenericEventExecutorChooser implements EventExecutorChooser {
        private final AtomicInteger idx = new AtomicInteger();
        private final EventExecutor[] executors;

        GenericEventExecutorChooser(EventExecutor[] executors) {
            this.executors = executors;
        }

        @Override
        public EventExecutor next() {
            return executors[Math.abs(idx.getAndIncrement() % executors.length)];
        }
    }
}
複製程式碼

預設情況下，chooser通過 DefaultEventExecutorChooserFactory被建立，在建立reactor執行緒選擇器的時候，會判斷reactor執行緒的個數，如果是2的冪，就建立PowerOfTowEventExecutorChooser，否則，建立GenericEventExecutorChooser

兩種型別的選擇器在選擇reactor執行緒的時候，都是通過Round-Robin的方式選擇reactor執行緒，唯一不同的是，PowerOfTowEventExecutorChooser是通過與運算，而GenericEventExecutorChooser是通過取餘運算，與運算的效率要高於求餘運算，可見，netty為了效率優化簡直喪心病狂！

選擇完一個reactor執行緒，即 NioEventLoop 之後，我們回到註冊的地方

public ChannelFuture register(Channel channel) {
    return next().register(channel);
}
複製程式碼

代理到 NioEventLoop 的父類的register方法

SingleThreadEventLoop.java

@Override
public ChannelFuture register(Channel channel) {
    return register(new DefaultChannelPromise(channel, this));
}
複製程式碼

其實，這裡已經和服務端啟動的過程一樣了，詳細步驟可以參考服務端啟動詳解這篇文章，我們直接跳到關鍵環節

AbstractNioChannel.java

private void register0(ChannelPromise promise) {
    boolean firstRegistration = neverRegistered;
    doRegister();
    neverRegistered = false;
    registered = true;

    pipeline.invokeHandlerAddedIfNeeded();

    safeSetSuccess(promise);
    pipeline.fireChannelRegistered();
    if (isActive()) {
        if (firstRegistration) {
            pipeline.fireChannelActive();
        } else if (config().isAutoRead()) {
            beginRead();
        }
    }
}
複製程式碼

和服務端啟動過程一樣，先是呼叫 doRegister();做真正的註冊過程，如下

protected void doRegister() throws Exception {
    boolean selected = false;
    for (;;) {
        try {
            selectionKey = javaChannel().register(eventLoop().selector, 0, this);
            return;
        } catch (CancelledKeyException e) {
            if (!selected) {
                eventLoop().selectNow();
                selected = true;
            } else {
                throw e;
            }
        }
    }
}
複製程式碼

將該條channel繫結到一個selector上去，一個selector被一個reactor執行緒使用，後續該channel的事件輪詢，以及事件處理，非同步task執行都是由此reactor執行緒來負責

繫結完reactor執行緒之後，呼叫 pipeline.invokeHandlerAddedIfNeeded()

前面我們說到，到目前為止NioSocketChannel 的pipeline中有三個處理器，head->ChannelInitializer->tail，最終會呼叫到 ChannelInitializer 的 handlerAdded 方法

public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
    if (ctx.channel().isRegistered()) {
        initChannel(ctx);
    }
}
複製程式碼

handlerAdded方法呼叫 initChannel 方法之後，呼叫remove(ctx);將自身刪除

AbstractNioChannel.java

private boolean initChannel(ChannelHandlerContext ctx) throws Exception {
    if (initMap.putIfAbsent(ctx, Boolean.TRUE) == null) { 
        try {
            initChannel((C) ctx.channel());
        } catch (Throwable cause) {
            exceptionCaught(ctx, cause);
        } finally {
            remove(ctx);
        }
        return true;
    }
    return false;
}
複製程式碼

而這裡的 initChannel 方法又是神馬玩意？讓我們回到使用者方法，比如下面這段使用者程式碼

使用者程式碼

ServerBootstrap b = new ServerBootstrap();
b.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 EchoServerHandler());
     }
 });
複製程式碼

哦，原來最終跑到我們自己的程式碼裡去了啊！我就不解釋這段程式碼是幹嘛的了，你懂的～

完了之後，NioSocketChannel繫結的pipeline的處理器就包括 head->LoggingHandler->EchoServerHandler->tail

註冊讀事件

接下來，我們還剩下這些程式碼沒有分析完

AbstractNioChannel.java

private void register0(ChannelPromise promise) {
    // ..
    pipeline.fireChannelRegistered();
    if (isActive()) {
        if (firstRegistration) {
            pipeline.fireChannelActive();
        } else if (config().isAutoRead()) {
            beginRead();
        }
    }
}
複製程式碼

pipeline.fireChannelRegistered();，其實沒有幹啥有意義的事情，最終無非是再呼叫一下業務pipeline中每個處理器的 ChannelHandlerAdded方法處理下回撥

isActive()在連線已經建立的情況下返回true，所以進入方法塊，進入到 pipeline.fireChannelActive();，這裡的分析和netty原始碼分析之服務端啟動全解析分析中的一樣，在這裡我詳細步驟先省略，直接進入到關鍵環節

AbstractNioChannel.java

@Override
protected void doBeginRead() throws Exception {
    // Channel.read() or ChannelHandlerContext.read() was called
    final SelectionKey selectionKey = this.selectionKey;
    if (!selectionKey.isValid()) {
        return;
    }

    readPending = true;

    final int interestOps = selectionKey.interestOps();
    if ((interestOps & readInterestOp) == 0) {
        selectionKey.interestOps(interestOps | readInterestOp);
    }
}
複製程式碼

你應該還記得前面 register0() 方法的時候，向selector註冊的事件程式碼是0，而 readInterestOp對應的事件程式碼是 SelectionKey.OP_READ，參考前文中建立 NioSocketChannel 的過程，稍加推理，聰明的你就會知道，這裡其實就是將 SelectionKey.OP_READ事件註冊到selector中去，表示這條通道已經可以開始處理read事件了

總結

至此，netty中關於新連線的處理已經向你展示完了，我們做下總結

  1. boos reactor執行緒輪詢到有新的連線進入
  2. 通過封裝jdk底層的channel建立 NioSocketChannel以及一系列的netty核心元件
  3. 將該條連線通過chooser，選擇一條worker reactor執行緒繫結上去
  4. 註冊讀事件，開始新連線的讀寫

下篇文章將深挖netty中的核心元件 pipeline，敬請期待

如果你想系統地學Netty，我的小冊《Netty 入門與實戰：仿寫微信 IM 即時通訊系統》可以幫助你，如果你想系統學習Netty原理，那麼你一定不要錯過我的Netty原始碼分析系列視訊：coding.imooc.com/class/230.h…

相關文章