Netty 源码分析（三）：服务器端的初始化和注册过程

为什么80%的码农都做不了架构师？>>>   

1. 简介

接下来我们会通过使用 Netty 去实现 NIO TCP 服务器的这个场景来解析 Netty 的源代码，深入了解 Netty 的设计。

使用 Netty 来实现一个 TCP 服务器，我们大致要做以下事情：

1. 创建 ServerSocketChannel、Channel、ChannelHandler 等一系列对象。这里的 Channel 将包含 ServerSocketChannel 和一系列 ChannelHandler。
2. 将 ServerSocketChannel 注册到 Selector 多路复用器上
3. 启动 EventLoop，并将 Channel 注册到其中
4. 为 ServerSocketChannel 绑定端口
5. 接受客户端连接，并将 SocketChannel 注册到 Selector 和 EventLoop 中
6. 处理读写事件 ...

2. 源码解析

我们先来了解 Server Channel 的初始化和注册的过程。初始化是来构建 Netty 本身的各种组件，应用用户的设置参数。注册的主要工作最终是将 SelectableChannel 注册到多路复用器 Selector。这一过程在所有基于 Java NIO 的项目里都是类似的。

服务端的整个构建过程是从 ServerBootstrap 开始的：

ServerBootstrap b = new ServerBootstrap();
b.group(bossGroup, workerGroup)
    .channel(NioServerSocketChannel.class)
    .handler(new LoggingHandler(LogLevel.DEBUG))
    .childHandler(channelInitializer)
    .bind(portNum).sync().channel().closeFuture().sync();

接下来我们从 AbstractBootstrap 的 bind(int port) 方法开始了解 Netty 的源码。

2.1 类：AbstractBootstrap，方法：ChannelFuture doBind(final SocketAddress localAddress)

bind(int port) 的实际工作绝大部分是在 AbstractBootstrap 的 ChannelFuture doBind(final SocketAddress localAddress) 实现的，我们来看其源码：

private ChannelFuture doBind(final SocketAddress localAddress) {
    final ChannelFuture regFuture = initAndRegister();
    final Channel channel = regFuture.channel();
    if (regFuture.cause() != null) {
        return regFuture;
    }
 
    if (regFuture.isDone()) {
        // At this point we know that the registration was complete and successful.
        ChannelPromise promise = channel.newPromise();
        doBind0(regFuture, channel, localAddress, promise);
        return promise;
    } else {
        // Registration future is almost always fulfilled already, but just in case it's not.
        final PendingRegistrationPromise promise = new PendingRegistrationPromise(channel);
        regFuture.addListener(new ChannelFutureListener() {
            @Override
            public void operationComplete(ChannelFuture future) throws Exception {
                Throwable cause = future.cause();
                if (cause != null) {
                    // Registration on the EventLoop failed so fail the ChannelPromise directly to not cause an
                    // IllegalStateException once we try to access the EventLoop of the Channel.
                    promise.setFailure(cause);
                } else {
                    // Registration was successful, so set the correct executor to use.
                    // See https://github.com/netty/netty/issues/2586
                    promise.executor = channel.eventLoop();
                }
                doBind0(regFuture, channel, localAddress, promise);
            }
        });
        return promise;
    }
}

doBind(SocketAddress localAddress) 方法主要会做三件事：

1. ServerChannel 初始化
2. 注册 ServerChannel 到 Selector
3. 将 ServerChannel bind 到本地端口上

最后一步 bind 需要在 register 完成之后再执行，但是因为这些动作都可能发生在不同的线程上，所以 bind 的动作是通过回调的方式实现的，具体细节后面再介绍。本篇将先介绍前两个操作。

因为 AbstractBootstrap 类的 initAndRegister() 方法是接下来第一个被调用的方法，所以我们接下来看它的源码。

2.2 类：AbstractBootstrap，方法：ChannelFuture initAndRegister()

final ChannelFuture initAndRegister() {
    final Channel channel = channelFactory().newChannel();
    try {
        init(channel);
    } catch (Throwable t) {
        channel.unsafe().closeForcibly();
        // as the Channel is not registered yet we need to force the usage of the GlobalEventExecutor
        return new DefaultChannelPromise(channel, GlobalEventExecutor.INSTANCE).setFailure(t);
    }
 
    ChannelFuture regFuture = group().register(channel); // 见 2.5
    if (regFuture.cause() != null) {
        if (channel.isRegistered()) {
            channel.close();
        } else {
            channel.unsafe().closeForcibly();
        }
    }
 
    // If we are here and the promise is not failed, it's one of the following cases:
    // 1) If we attempted registration from the event loop, the registration has been completed at this point.
    //    i.e. It's safe to attempt bind() or connect() now because the channel has been registered.
    // 2) If we attempted registration from the other thread, the registration request has been successfully
    //    added to the event loop's task queue for later execution.
    //    i.e. It's safe to attempt bind() or connect() now:
    //         because bind() or connect() will be executed *after* the scheduled registration task is executed
    //         because register(), bind(), and connect() are all bound to the same thread.
 
    return regFuture;
}

这个方法主要做了下面几件事：

• Channel channel = channelFactory().newChannel(); 此处通过 channelFactory() 方法得到的 ChannelFactory 实现类是 ReflectiveChannelFactory。（这个类是默认实现，AbstractBootstrap 还提供了方法用来设置其它 ChannelFactory 的实现）这个类将通过 channel(NioServerSocketChannel.class) 提供的类反射创建出 NioServerSocketChannel。而在 NioServerSocketChannel 的构造函数里，一个 java.nio.channels.ServerSocketChannel 将被构建出来。

• 接下来，在 NioServerSocketChannel 的父类 AbstractNioChannel 的构造函数中，ServerSocketChannel 被设置成非阻塞模式 ch.configureBlocking(false);

• 在 AbstractNioChannel 父类 AbstractChannel 的构造函数里，有两个重要的对象被构造出来

protected AbstractChannel(Channel parent) {
    this.parent = parent;
    unsafe = newUnsafe();
    pipeline = new DefaultChannelPipeline(this);
}

在这里 unsafe 和 pipeline 被构建出来。构造出 unsafe 的 newUnsafe() 方法是在子类中实现，在本例中 NioMessageUnsafe（还有一个类似的 NioByteUnsafe，其为 NioSocketChannel 提供了具体的 IO 实现），它包含了很多具体的方法实现。而 DefaultChannelPipeline 则是另一个重要的类，接下来我们来看看它的构造函数。

2.3 类 DefaultChannelPipeline 的构造函数

public DefaultChannelPipeline(AbstractChannel channel) {
    if (channel == null) {
       throw new NullPointerException("channel");
    }
    this.channel = channel;
 
    tail = new TailContext(this);
    head = new HeadContext(this);
 
    head.next = tail;
    tail.prev = head;
}

DefaultChannelPipeline 构造函数中做了一件很重要的事，就是构造了 ChannelHandler 链。TailContext 和 HeadContext 都继承了 AbstractChannelHandlerContext。另外，TailContext 实现了 ChannelInboundHandler，HeadContext 实现了 ChannelOutboundHandler（Netty 5 在此处有变化，其不再区分 ChannelInboundHandler 和 ChannelOutboundHandler）。

上面这些就是 final Channel channel = channelFactory().newChannel(); 所做的事情。接下来我们来了解 init(Channel channel) 方法所做的事情。在这里，void init(Channel channel) 方法由 AbstractBootstrap 的子类 ServerBootstrap 实现

2.4 类：ServerBootstrap，方法：void init(Channel channel)

void init(Channel channel) throws Exception {
    final Map, Object> options = options();
    synchronized (options) {
        channel.config().setOptions(options);
    }
 
    final Map, Object> attrs = attrs();
    synchronized (attrs) {
        for (Entry, Object> e: attrs.entrySet()) {
            @SuppressWarnings("unchecked")
            AttributeKey