Mina源码阅读笔记（三）-Mina的连接IoAccpetor

其实在mina的源码中，IoService可以总结成五部分service责任、Processor线程处理、handler处理器、接收器和连接器，分别对应着IoService、IoProcessor、IoHandler、IoAcceptor和IoConnector。在代码的中有如下包跟IoService关系密切：

1org.apache.mina.core.service

2org.apache.mina.transport.*

3org.apache.mina.core.polling 这个包主要是实现了轮询策略

其中core.service包中主要定义了上面五个部分的接口，以及IoHandler和IoProcessor的实现（Handler是一种常见的设计模式，具体的业务其实并没有多少，只是在结构上将层次划分的更清楚。Processor是mina内部定义的接口，一般不对外使用，用mina官方的话，主要performs actual I/O operations for IoSession. 这一部分我想放在IoSession中来讲）。而在transport包中实现了具体的连接方式，当然，这部分也是我们今天阅读的重点。我想要关注的也是mina底层如何用NIO实现各种连接。

所以这一节的重点是IoAcceptor和IoConnector，Handler和IoService只是稍稍带过，写点儿用法和构成。先看mina对IoService的介绍：IoService provides basic I/O Service and manages I/O Sessions within MINA.

上面的图简单介绍了IoService的职责，以及其具体实现类AbstractIoService中的职责。在比较大的框架中，都是采用了大量的抽象类之间继承，采用层级实现细节这样的方式来组织代码。所以在mina中看到Abstract开头的类，并不仅仅只是一个抽象，其实里面也包含很多的实现了。

IoService用来管理各种IO服务，在mina中，这些服务可以包括session、filter、handler等。在AbstractIoService中，也是通过线程池来装载这些服务的：

01private final Executor executor;

02   private final boolean createdExecutor;

03 

04   protected AbstractIoService(IoSessionConfig sessionConfig, Executor executor) {

05       //省略。。。

06 

07        if (executor == null) {

08            this.executor = Executors.newCachedThreadPool();

09            createdExecutor = true;

10        } else {

11            this.executor = executor;

12            createdExecutor = false;

13        }

14 

15        threadName = getClass().getSimpleName() + '-' + id.incrementAndGet();

16    }

然后我们关注一下service中的dispose方法，学习一下线程安全在这里的用法：

01/**

02     * A lock object which must be acquired when related resources are

03     * destroyed.

04     */

05    protected final Object disposalLock = new Object();

06 

07    private volatile boolean disposing;

08 

09private volatile boolean disposed;

10 

11private final boolean createdExecutor;

12 

13    public final void dispose(boolean awaitTermination) {

14        if (disposed) {

15            return;

16        }

17 

18        synchronized (disposalLock) {

19            if (!disposing) {

20                disposing = true;

21 

22                try {

23                    dispose0();

24                } catch (Exception e) {

25                    ExceptionMonitor.getInstance().exceptionCaught(e);

26                }

27            }

28        }

29 

30        if (createdExecutor) {

31            ExecutorService e = (ExecutorService) executor;

32            e.shutdownNow();

33            if (awaitTermination) {

34 

35                //Thread.currentThread().setName();

36 

37                try {

38                    LOGGER.debug("awaitTermination on {} called by thread=[{}]", this, Thread.currentThread().getName());

39                    e.awaitTermination(Integer.MAX_VALUE, TimeUnit.SECONDS);

40                    LOGGER.debug("awaitTermination on {} finished", this);

41                } catch (InterruptedException e1) {

42                    LOGGER.warn("awaitTermination on [{}] was interrupted", this);

43                    // Restore the interrupted status

44                    Thread.currentThread().interrupt();

45                }

46            }

47        }

48        disposed = true;

49    }

为了多线程之间变量内存的可见性，防止抢占资源时候出现意想不到的问题，这里用了volatile关键字修饰布尔型变量这样的经典用法，同时使用内置锁机制控制线程的访问。与IoService比较相关的还有个TransportMetadata，这个类主要记录了IoService的相关信息，在使用中，也不是很常见，所以略过这部分了。更多的线程运用在IoProcessor中会体现，这部分放到后面写，今天的主要目的还是连接IoAcceptor和IoConnector。

从现在开始就要复杂了，我们先从服务器的接收端开始写起，也就是IoAccpetor，先上一张宏观的图，来理清思路，图来自mina官网：

简单介绍一下，连接的实现有四种：

We have many of those implementing classes

• NioSocketAcceptor : the non-blocking Socket transport IoAcceptor
• NioDatagramAcceptor : the non-blocking UDP transport IoAcceptor
• AprSocketAcceptor : the blocking Socket transport IoAcceptor, based on APR
• VmPipeSocketAcceptor : the in-VM IoAcceptor

我们按照图上用箭头标出的两条路来分析我们最常用的NioSocketAcceptor，回顾一下调用这个类的过程：

01// Create a TCP acceptor

02    IoAcceptor acceptor = new NioSocketAcceptor();

03 

04    // Associate the acceptor to an IoHandler instance (your application)

05    acceptor.setHandler(this);

06 

07    // Bind : this will start the server...

08    acceptor.bind(new InetSocketAddress(PORT));

09 

10    System.out.println("Server started...");

从左边的路走起：

接口IoAcceptor直接继承了IoService接口，并定义了自己特有的操作。其操作的具体实现由AbstractIoAcceptor完成（注意是上图左边的类来实现的）。我们继续从左边往下看，与IoAcceptor直接关联的是SocketAcceptor接口，它们（IoAcceptor和SocketAcceptor）之间也是接口的继承关系，所以根据前面的经验，我们可以猜测，SocketAcceptor一定又新定义了一些属于自己需要去实现的操作，这样做肯定是为了与另一种实现DatagaramAcceptor来区别，事实也确实如此，看下图：

这里需要注意的是上图被框出来的部分，他们的返回类型均被缩小了（我记不得是向下转型还是向上转型，应该是向下吧，现在返回的都是子类），这样实现的好处是绝对的专一，避免了转型上的错误。

在看NioSocketAcceptor之前，我们还是要先看右边这条路：

1public abstract class AbstractIoAcceptor extends AbstractIoService implements IoAcceptor

回顾一下，AbstractIoService实现了对session的管理，IoAcceptor定义了一些建立连接时用到的一系列方法，这样一来，AbstractIoAcceptor一来有了对session使用的功能，二来需要实现建立连接里需要用到的那些方法，理清楚了这些，我们可以看AbstractIoAcceptor的具体实现：

01private final List<SocketAddress> defaultLocalAddresses = new ArrayList<SocketAddress>();

02 

03    private final List<SocketAddress> unmodifiableDefaultLocalAddresses = Collections

04            .unmodifiableList(defaultLocalAddresses);

05 

06    private final Set<SocketAddress> boundAddresses = new HashSet<SocketAddress>();

07 

08    private boolean disconnectOnUnbind = true;

09 

10    /**

11     * The lock object which is acquired while bind or unbind operation is performed.

12     * Acquire this lock in your property setters which shouldn't be changed while

13     * the service is bound.

14     */

15    protected final Object bindLock = new Object();

这里有三点要说：

l  这里的Address不是用了list就是用了set，注意这些都是用来保存LocalAddress的，mina在设计的时候考虑的很全面，服务器可能会有多个网卡的啊。

l  解释下unmodifiableList，JDK自带方法：Returns an unmodifiable view of the specified list. This method allows modules to provide users with "read-only" access to internal lists. Query operations on the returned list "read through" to the specified list, and attempts to modify the returned list, whether direct or via its iterator, result in an UnsupportedOperationException. The returned list will be serializable if the specified list is serializable. Similarly, the returned list will implement RandomAccess if the specified list does.

l  时刻注意线程安全的问题。

AbstractIoAcceptor主要是对localAddress的操作，里面涉及到集合类的使用和内置锁的使用，其他没有什么特别的，大家可以看看源码，容易理解。主要可以看看里面的bind方法，这个里面涉及了两层锁。

AbstractPollingIoAcceptor在实现连接中至关重要的一个类，他是socket轮询策略的主要实现，有那么几点要关注：

l  polling strategy : The underlying sockets will be checked in an active loop and woke up when an socket needed to be processed.

l  An Executor will be used for running client accepting and an AbstractPollingIoProcessor will be used for processing client I/O operations like reading, writing and closing.（将连接和业务分开，AbstractPollingIoProcessor部分会在session部分写）。

l  All the low level methods for binding, accepting, closing need to be provided by the subclassing implementation.

这个类光看用到的工具就知道他不简单了，之前我们见过的处理线程安全问题都只是用了内置锁，这里终于用到了concurrent包里的东西了。这个类里没有出现NIO中selector这样的东西，而是做了一种策略，这种策略是在线程处理上的，采用队列和信号量协同处理socket到来时候连接的策略。推荐大家仔细看看这个类，里面的注释很详细，我列几个成员变量，你看看有兴趣没：

01/** A lock used to protect the selector to be waked up before it's created */

02    private final Semaphore lock = new Semaphore(1);

03 

04    private final IoProcessor<S> processor;

05 

06    private final boolean createdProcessor;

07 

08    private final Queue<AcceptorOperationFuture> registerQueue = new ConcurrentLinkedQueue<AcceptorOperationFuture>();

09 

10    private final Queue<AcceptorOperationFuture> cancelQueue = new ConcurrentLinkedQueue<AcceptorOperationFuture>();

11 

12    private final Map<SocketAddress, H> boundHandles = Collections.synchronizedMap(new HashMap<SocketAddress, H>());

13 

14    private final ServiceOperationFuture disposalFuture = new ServiceOperationFuture();

15 

16    /** A flag set when the acceptor has been created and initialized */

17    private volatile boolean selectable;

18 

19    /** The thread responsible of accepting incoming requests */

20    private AtomicReference<Acceptor> acceptorRef = new AtomicReference<Acceptor>();

21 

22    protected boolean reuseAddress = false;

在这个类里还有一个Acceptor的内部类，实现runnable接口，主要用作接收客户端的请求。这个类也有可看性。这里面的东西不是很好写，需要大家自己去细细品味。

看最后一个类，两边的焦点，NioSocketAcceptor。看之前在AbstractPollingIoAcceptor里有句话：All the low level methods for binding, accepting, closing need to be provided by the subclassing implementation.这里总该有NIO的一些东西了：

1public final class NioSocketAcceptor extends AbstractPollingIoAcceptor<NioSession, ServerSocketChannel> implements

2        SocketAcceptor {

3 

4    private volatile Selector selector;

我想看到的东西终于来了，selector，先不说，接着往下看：

01@Override

02    protected void init() throws Exception {

03        selector = Selector.open();

04}

05 

06  @Override

07    protected NioSession accept(IoProcessor<NioSession> processor, ServerSocketChannel handle) throws Exception {

08 

09        SelectionKey key = handle.keyFor(selector);

10 

11        if ((key == null) || (!key.isValid()) || (!key.isAcceptable())) {

12            return null;

13        }

14 

15        // accept the connection from the client

16        SocketChannel ch = handle.accept();

17 

18        if (ch == null) {

19            return null;

20        }

21 

22        return new NioSocketSession(this, processor, ch);

23    }

24 

25  @Override

26    protected ServerSocketChannel open(SocketAddress localAddress) throws Exception {

27        // Creates the listening ServerSocket

28        ServerSocketChannel channel = ServerSocketChannel.open();

29 

30        boolean success = false;

31 

32        try {

33            // This is a non blocking socket channel

34            channel.configureBlocking(false);

35 

36            // Configure the server socket,

37            ServerSocket socket = channel.socket();

38 

39            // Set the reuseAddress flag accordingly with the setting

40            socket.setReuseAddress(isReuseAddress());

41 

42            // and bind.

43            socket.bind(localAddress, getBacklog());

44 

45            // Register the channel within the selector for ACCEPT event

46            channel.register(selector, SelectionKey.OP_ACCEPT);

47            success = true;

48        } finally {

49            if (!success) {

50                close(channel);

51            }

52        }

53        return channel;

54    }

都是最基本的java NIO吧，是不是很熟悉，是不是有种相见恨晚的感觉，是不是很简单。当然简单是相对的，因为之间做了那么多铺垫，所以程序设计真的是一种艺术，看你怎么去设计。

只是你想过没有，这是一个final的类，不能继承，那我们在调用的时候从来没有写acceptor.open，这时候这个方法什么时候执行呢，在这个类里面也没有展示出来。这个疑问先留着，后面会说，这当然也是一种机制。

--------------------------------------------------------------

一写发现有那么多，本来想把IoConnector也写的，可是一个Acceptor就出乎意料的多，IoConnector差不多结构，放到下次去写了。下次会和上篇代码一样，给出一个简单的阉割版实现，每次都做一个简单的实现，源码都读完了，是不是就把mina也都写了一遍，但愿能实现。我其实想在最后写个基于P2P的通信框架，有点儿构思，但是没实力写，主要是结构组织的不好，所以还要多读读源码。

所以我发现照着源码做一个删减版代码出来的也是很好的一种读源码的方法，今天大神@ppdep开始读nginx的源码了，祝他好运。。。还有就是kafka看的我恶心，居然连个依赖库都没有，构建工具也没有，还得自己找。。