Apache Mina 文档翻译

gaoke

第三章 - IoService
　　
在第二章我们已经看到无论在服务端还是在客户端，MINA里的IoService接口都是所有IO服务实现的基类。它负责处理你的应用程序和远程主机之间的交互，收发消息， 管理会话和连接等工作。IoService是一个接口，在服务端被实现为IoAcceptor，在客户端被实现为IoConnector。

在这一章中我们会了解到下面的内容：
    IoService简介
    IoService详细
    IoAcceptor接口
    IoConnector接口

IoService简介
　　在MINA里IoService提供基础的IO服务，管理IO会话。它是MINA架构中最重要的部分之一。最底层的IO操作都是在IoService和其子接口的实现类里完成的。

IoService思维导图


 

我们看看IoService的职责和它的实现类AbstractIoService。

职责

从上面的图中我们可以看到IoService有很多职责：

    会话管理：创建和删除会话，检测空闲会话。  
    过滤器链管理：调用过滤器链，允许用户运行期更改过滤器。
    调用IoHandler：当接受到新的消息后调用IoHandler等。
    统计管理：更新发送消息的个数，发送的字节数和其他一些情报。
    监听器管理：管理用户创建的监听器。
    通信管理：在服务器和客户端处理数据转换。

接口的细节

IoService是所有的提供IO服务器和会话管理的IoConnector和IoAcceptor的父接口。在它里面定义了如下方法：
    getTransportMetadata()
    addListener()
    removeListener()
    isDisposing()
    isDisposed()
    dispose()
    getHandler()
    setHandler()
    getManagedSessions()
    getManagedSessionCount()
    getSessionConfig()
    getFilterChainBuilder()
    setFilterChainBuilder()
    getFilterChain()
    isActive()
    getActivationTime()
    broadcast()
    setSessionDataStructureFactory()
    getScheduledWriteBytes()
    getScheduledWriteMessages()
    getStatistics()

下面我们介绍一下每个方法的功能：

getTransportMetadata()
这个方法返回运行中的IoAcceptor或IoConnector的传输元数据。这些元数据包括服务提供者名（nio, apr, rxtx），连接类型（面向连接的/面向非连接的）等。

addListener
向IoService添加IoServiceListener，来监听IoService产生的事件。

removeListener
删除已经添加到IoService里的IoServiceListener。

isDisposing
这个方法可以告诉我们IoService是不是正在被销毁。销毁过程可能要持续一段时间，所以在想要得到IoService的当前状态时这个方法很有用。

isDisposed
这个方法可以告诉我们IoService是不是已经被销毁。只有当IoService释放掉所有资源后才算是被销毁完毕。

dispose
这个方法释放掉IoService分配到的所有资源。因为释放过程可能会持续一段时间， 用户可以通过isDisposing()方法检查IO服务的状态， 通过isDisposed()方法判断IO服务是否销毁完毕。
请在关闭IO服务器时一定要调用dispose()

getHandler
取得IoService里设置的IoHandler实现。

setHandler
为IoService指定一个IoHandler。 通过这个IoHandler响应IoService产生的事件。这个IoHandler包含你的应用程序逻辑。

getManagedSessions
返回一个包含IoHandler管理的所有会话的map。一个被管理的会话指添加到服务监听器的会话。根据用户自己添加的监听器，这个方法可以用来处理空闲会话或其他会话。

getManagedSessionCount
返回IoHandler管理的所有会话的个数。

getSessionConfig
返回会话配置

getFilterChainBuilder
返回过滤器链的构造器。如果你想在一个会话创建时为它注入过滤器的实例，就要使用这个方法。

setFilterChainBuilder
为IoService设置过滤器链的构造器。

getFilterChain
返回当前的默认过滤器链。

isActive
这个方法可以告诉我们IoService是否处于活动状态。

getActivationTime
返回IoService被激活的时间。如果IoService未处于活动状态，返回IoService最后被激活的时间。

broadcast
向所有被管理的会话发送消息。

setSessionDataStructureFactory
为IoService设置IoSessionDataStructureFactory实例，IoSessionDataStructureFactory为新创建的会话提供相关的数据结构。

getScheduledWriteBytes
返回准备写操作的字节。例如在内存中存储的等待往socket发送的字节。

getScheduledWriteMessages
返回准备写操作的消息。例如在内存中存储的等待往socket发送的消息。

getStatistics
返回当前IoService的IoServiceStatistics对象



IoService详细
　　在MINA里IoService主要有两种实现：

    IoAcceptor
    IoConnector

为创建一个服务器你需要选择一个IoAcceptor接口的实现。在客户端，你同样需要选择一个IoConnector的实现。

IoAcceptor
　　这个接口的命名是因为accept()方法。accept()方法可以用来创建客户端和服务器连接。服务器接受(accepts)进来的连接请求。

从这个角度看，我们其实可以把这个接口命名为“Server”（实际上从MINA3.0中就采用了这个名字）。

因为我们可能利用多种传输协议，所以MINA提供了多个实现类。基本上没有必要自己实现一个新的IoAcceptor。

我们可以利用如下IoAcceptor的实现：

    NioSocketAcceptor : 基于非阻塞的TCP传输协议的IoAcceptor
    NioDatagramAcceptor : 基于非阻塞的UDP传输协议的IoAcceptor
    AprSocketAcceptor : 基于APR阻塞式的Socket传输IoAcceptor
    VmPipeSocketAcceptor : 基于VM内通信的IoAcceptor

你只需要根据需要选择一个既可。

下面是IoAcceptor接口和实现的类图。


 

创建IoAcceptor

根据你使用的传输协议，选择了IoAcceptor实现以后，我们看看它是如何工作的。



public TcpServer() throws IOException {
// 创建一个TCP acceptor
IoAcceptor acceptor = new NioSocketAcceptor();
// 为acceptor设置一个IoHandler实例 (你的应用程序逻辑)
acceptor.setHandler(this);
// Bind : 开始服务
acceptor.bind(new InetSocketAddress(PORT));
System.out.println("Server started...");
}
　　

就是这么简单，如果你想启动一个UDP服务器，只需要把第一行代码替换为：

...
// 创建一个UDP acceptor
IoAcceptor acceptor = new NioDatagramAcceptor();
...
　　

销毁IoAcceptor

可以通过dispose()方法来停止这个服务。当所有等待处理的会话都处理完毕后服务才会最终停止：

// 停止服务，并等待所有会话进入非活动状态
acceptor.dispose();
　　

通过传递一个boolean类型参数，你也可以等待所有的执行线程都处理完毕：



// 停止服务，并等待所有会话都处理完毕。
acceptor.dispose( true );
　　

状态

你可以通过以下方法获得IoService的状态：

    isActive() : 如果服务可以接受进来的请求，这个方法返回true
    isDisposing() : dispose()被调用后这个方法返回true。它不能告诉你服务是否真正被销毁了(一些会话可能还会被处理)
    isDisposed() : 当dispose(boolean)方法被调用后， 这个方法返回true，表示所有的线程都停止了。

管理IoHandler

你可以通过setHandler(IoHandler)和getHandler()方法为IoService添加IoHandler实例和取得已经添加的IoHandler实例。

管理过滤器链

如果你想管理过滤器链， 你需要调用getFilterChain()方法：

// 添加一个日志过滤器
DefaultIoFilterChainBuilder chain = acceptor.getFilterChain();
chain.addLast("logger", new LoggingFilter());
　　

你也可以在IoService创建之前创建过滤器链。



// 添加一个日志过滤器
DefaultIoFilterChainBuilder chain = new DefaultIoFilterChainBuilder();
chain.addLast("logger", new LoggingFilter());
// 把已经创建的过滤器链设置到acceptor
acceptor.setFilterChainBuilder(chain);



IoConnector
　　就像服务器端需要使用IoAcceptor一样，客户端需要实现IoConnector。 同样我们有很多实现类：

    NioSocketConnector : 基于非阻塞的TCP传输协议的IoConnector
    NioDatagramConnector : 基于非阻塞的UDP传输协议的IoConnector
    AprSocketConnector : 基于APR阻塞式的Socket传输IoConnector
    ProxyConnector : 提供Proxy支持的IoConnector
    SerialConnector : 串口通信用的IoConnector
    VmPipeConnector : 基于VM内通信的IoConnector

你只需要根据需要选择一个既可。

下面是IoConnector接口和实现的类图。