netty源码解析(4.0)-13 Channel NIO实现: 关闭和清理

　　Channel提供了3个方法用来实现关闭清理功能：disconnect,close,deregister。本章重点分析这个3个方法的功能的NIO实现。

　　disconnect实现: 断开连接

　　disconnect方法的调用栈如下:

io.netty.channel.AbstractChannel#disconnect()
io.netty.channel.DefaultChannelPipeline#disconnect()
io.netty.channel.AbstractChannelHandlerContext#disconnect()
io.netty.channel.AbstractChannelHandlerContext#disconnect(io.netty.channel.ChannelPromise)
io.netty.channel.AbstractChannelHandlerContext#invokeDisconnect
io.netty.channel.DefaultChannelPipeline.HeadContext#disconnect
io.netty.channel.AbstractChannel.AbstractUnsafe#disconnect
io.netty.channel.socket.nio.NioSocketChannel#doDisconnect
io.netty.channel.socket.nio.NioSocketChannel#doClose

　　disconnect稍微复杂一些， 在io.netty.channel.AbstractChannelHandlerContext#disconnect(io.netty.channel.ChannelPromise)实现中，会根据channel是否支持disconnect操作来决定下一步动作：

if (!channel().metadata().hasDisconnect()) {
    next.invokeClose(promise);
} else {
    next.invokeDisconnect(promise);
} 　　

　 之所以这样设计，是因为TCP和UDP的disconnect含义是不一样的，对TCP来说disconnect就是关闭socket；对UDP来说，它没有连接的概念，默认情况下通过udp socket发送数据需要指定远程地址，但如果调用connect之后，就不需指定这个地址，数据报会被发送到connect指定的地址上，disconnect含义是删除connect指定的地址，发送数据时必须指定地址。所以在NIO的Channel实现中，TCP的disconnect是调用socket的close方法，UDP的disconnect是调用socket的disconnect方法，下面是两种不同的disconnect实现。

//TCP io.netty.channel.socket.nio.NioSocketChannel#doDisconnect
@Override
protected void doDisconnect() throws Exception {
    doClose();
}
@Override
protected void doClose() throws Exception {
    super.doClose();
    javaChannel().close();
}
//UDP io.netty.channel.socket.nio.NioDatagramChannel#doDisconnect
@Override
protected void doDisconnect() throws Exception {
    javaChannel().disconnect();
}

　　io.netty.channel.AbstractChannel.AbstractUnsafe#disconnect实现了disconnect的逻辑，先调用doDisconnect方法，这个方法是io.netty.channel.AbstractChannel定义的的抽象方法。如果channel的状态从active变成inactive，就调用pipeline的fireChannelInactive方法触发channelInactive事件。

　　

　　close实现: 关闭channel

　　close方法的调用栈:

io.netty.channel.AbstractChannel#close()
io.netty.channel.DefaultChannelPipeline#close()
io.netty.channel.AbstractChannelHandlerContext#close()
io.netty.channel.AbstractChannelHandlerContext#close(io.netty.channel.ChannelPromise)
io.netty.channel.AbstractChannelHandlerContext#invokeClose
io.netty.channel.DefaultChannelPipeline.HeadContext#close
io.netty.channel.AbstractChannel.AbstractUnsafe#close(io.netty.channel.ChannelPromise)
io.netty.channel.AbstractChannel.AbstractUnsafe#close(final ChannelPromise promise, final Throwable cause ,final ClosedChannelException closeCause, final boolean notify)
io.netty.channel.AbstractChannel.AbstractUnsafe#doClose0
io.netty.channel.socket.nio.NioSocketChannel#doClose　　

　　close的逻辑实现在io.netty.channel.AbstractChannel.AbstractUnsafe#close(final ChannelPromise promise, final Throwable cause ,final ClosedChannelException closeCause, final boolean notify)中，这个close方法主要实现了一下几个功能:

1. 确保在多线程环境下，多次调用close和一次调用的影响一致，并且可以通过promis得到同样的结果。
2. 保证在执行close的过程中，不能向channel写数据。
3. 调用doClose0执行执真正的close操作。
4. 调用deregister对channel做最后的清理工作，并触发channelInactive, channelUnregistered事件。

　　以下是这个方法的代码:

private void close(final ChannelPromise promise, final Throwable cause,
                   final ClosedChannelException closeCause, final boolean notify) {
    if (!promise.setUncancellable()) {
        return;
    }

    if (closeInitiated) {
        if (closeFuture.isDone()) {
            // Closed already.
            safeSetSuccess(promise);
        } else if (!(promise instanceof VoidChannelPromise)) { // Only needed if no VoidChannelPromise.
            // This means close() was called before so we just register a listener and return
            closeFuture.addListener(new ChannelFutureListener() {
                @Override
                public void operationComplete(ChannelFuture future) throws Exception {
                    promise.setSuccess();
                }
            });
        }
        return;
    }

    closeInitiated = true;

    final boolean wasActive = isActive();
    final ChannelOutboundBuffer outboundBuffer = this.outboundBuffer;
    this.outboundBuffer = null; // Disallow adding any messages and flushes to outboundBuffer.
    Executor closeExecutor = prepareToClose();
    if (closeExecutor != null) {
        closeExecutor.execute(new Runnable() {
            @Override
            public void run() {
                try {
                    // Execute the close.
                    doClose0(promise);
                } finally {
                    // Call invokeLater so closeAndDeregister is executed in the EventLoop again!
                    invokeLater(new Runnable() {
                        @Override
                        public void run() {
                            if (outboundBuffer != null) {
                                // Fail all the queued messages
                                outboundBuffer.failFlushed(cause, notify);
                                outboundBuffer.close(closeCause);
                            }
                            fireChannelInactiveAndDeregister(wasActive);
                        }
                    });
                }
            }
        });
    } else {
        try {
            // Close the channel and fail the queued messages in all cases.
            doClose0(promise);
        } finally {
            if (outboundBuffer != null) {
                // Fail all the queued messages.
                outboundBuffer.failFlushed(cause, notify);
                outboundBuffer.close(closeCause);
            }
        }
        if (inFlush0) {
            invokeLater(new Runnable() {
                @Override
                public void run() {
                    fireChannelInactiveAndDeregister(wasActive);
                }
            });
        } else {
            fireChannelInactiveAndDeregister(wasActive);
        }
    }
}

 　　7-23行，在这个方法被多次调用的时候，只有一次可以执行的21行以后的代码。从代码看，这一点是用closeInitiated属性来保证的，但它是一个普通boolean类型的属性，在多线程情况下存在可见性问题。事实上一个channel unsafe实例的close方法，只会在一个线程中执行，closeInitiated只在这个方法中使用，因此不存在多线程间的可见性问题。虽然可能在多个不同的线程中多次调用Channel的close方法，但是这个close方法，只会在channel的eventLoop线程中执行。凡是通过io.netty.channel.DefaultChannelPipeline.HeadContext调用的channel unsafe方法，都一定在channel的eventLoop线程中执行。

　　26,27行，把channel unsafe的outboundBuffer设置为null,  这样，在close的过程中，所有channel的write方法都会通过promise返回错误。

　　28行，prepareToClose默认实现是返回null, 它是一个protected方法，可以根据需要覆盖它，用来在关闭之前做一些准备工作，同时指定一个executor，让接下来的关闭动作都在这个executor中执行。

　　33-49行，53-72行，这两段代码实现的都是功能都是一样的，不同的是33-49行在prepareToClose提供的executor中执行。调用doClose0执行关闭操作，清理outboundBuffer(43,44),  调用fireChannelInactiveAndDeregister(46)触发channelInactive和channelDeregister事件。63-72行，通过inFlush0属性检查当前是否正在进程flush操作，如果是，使用invokerLater确保在当前方法和flush操作完成之后再触发事件。

　　doClose0中是真正的关闭操作，它先调用doClose，然后设置promise的返回值:

//io.netty.channel.AbstractChannel.AbstractUnsafe#doClose0
private void doClose0(ChannelPromise promise) {
    try {
        doClose();
        closeFuture.setClosed();
        safeSetSuccess(promise);
    } catch (Throwable t) {
        closeFuture.setClosed();
        safeSetFailure(promise, t);
    }
}
//io.netty.channel.socket.nio.NioSocketChannel#doClose
@Override
protected void doClose() throws Exception {
    super.doClose();
    javaChannel().close();
}

 　　fireChannelInactiveAndDeregister是调用deregister实现，也就是说，正常情况下，调用Channel的close方法之后就会自动完成一个channel最后的清理工作，不需要再调用deregister方法。

private void fireChannelInactiveAndDeregister(final boolean wasActive) {
    deregister(voidPromise(), wasActive && !isActive());
}

　　deregister实现：从eventLoop中注销channel

　　deregister的调用栈:

io.netty.channel.AbstractChannel#deregister()
io.netty.channel.DefaultChannelPipeline#deregister()
io.netty.channel.AbstractChannelHandlerContext#deregister()
io.netty.channel.AbstractChannelHandlerContext#deregister(io.netty.channel.ChannelPromise)
io.netty.channel.AbstractChannelHandlerContext#invokeDeregister
io.netty.channel.DefaultChannelPipeline.HeadContext#deregister
io.netty.channel.AbstractChannel.AbstractUnsafe#deregister(io.netty.channel.ChannelPromise)
io.netty.channel.AbstractChannel.AbstractUnsafe#deregister(io.netty.channel.ChannelPromise, boolean)
io.netty.channel.nio.AbstractNioChannel#doDeregister

 　　deregister的逻辑在中实现io.netty.channel.AbstractChannel.AbstractUnsafe#deregister(final ChannelPromise promise, final boolean fireChannelInactive)，这个方法的实现比较简单，主要就是调用doDeregister方法执行deregister操作，然后触发channelInactive事件(如果fireChannelInactive参数是true)和channelUnregistered事件。

private void deregister(final ChannelPromise promise, final boolean fireChannelInactive) {
    if (!promise.setUncancellable()) {
        return;
    }
    if (!registered) {
        safeSetSuccess(promise);
        return;
    }
    invokeLater(new Runnable() {
        @Override
        public void run() {
            try {
                doDeregister();
            } catch (Throwable t) {
                logger.warn("Unexpected exception occurred while deregistering a channel.", t);
            } finally {
                if (fireChannelInactive) {
                    pipeline.fireChannelInactive();
                }
                if (registered) {
                    registered = false;
                    pipeline.fireChannelUnregistered();
                }
                safeSetSuccess(promise);
            }
        }
    });
}

　　这里使用invokeLater执行主要逻辑的目的是为了保证把当前正在eventLoop队列中所有任何都执行完之后再执行真正的deregister操作。

　　doDeregister默认实现是空，什么都没做，它是个protected方法。真正的实现在io.netty.channel.nio.AbstractNioChannel中，它只是简单地调用eventLoop的cancel方法把SocketChannel对应的SelectionKey从Selector中删除，这样selector就不会监听到这个socket上的任何事件了。

@Override
protected void doDeregister() throws Exception {
    eventLoop().cancel(selectionKey());
}