第三章 IoService
一个MINA的IoService,如同在应用架构章节看到的那样,它是所有提供IO服务的类的基类,无论是服务端还是客户端。
它将处理你应用中与远程的节点的所有交互,包括接收和发送消息,会话管理,连接管理等等。
它是一个接口,IoAcceptor是其在服务端的实现类,IoConnector 是其在客户端的实现类。
我们将在以下章节中介绍这个接口:
a) IoService简介
b) IoService详解
c) IoAcceptor
d) IoConnector
3.1 IoService简介
IoService在MINA内部提供了基础的IO服务和信息的IO会话。是MINA架构的核心部分。IoService的实现类和子接口处理大部分的底层IO操作。
3.1.1 IoService思维导图
让我们看看IoService及其实现类AbstractIoService都做了什么。
3.1.2 职责:
从上图中我们可以看到,IoService的职责很多:
1.会话管理:创建、删除会话,检测空闲会话
2.过滤器链管理:处理过滤器链,允许用户改变过滤器链
3.调用处理器:当接收到新消息时调用处理器
4.统计管理:更新发送的消息数、字节数及其他数据
5.监听器管理:管理可配置的监听器
6.通信管理:处理客户端和服务器间的数据传输
3.1.3详细接口:
IoService是所有提供IO服务和管理IO会话的IoConnector和IoAcceptor的接口。这个接口中包含所有进行IO操作相关的方法。
让我们深入探讨一下接口的各种方法:
getTransportMetadata()
这个方法返回正在运行中的IoConnector和IoAcceptor中传送的元数据。典型的数据包括提供者名称(nio、apr、rxtx)和连接类型(连接导向和非连接导向的)等等。
addListener
添加一个IoServiceListener 来监听与IoService相关的事件。
removeListener
移除一个附加在IoService上的监听器IoServiceListener
isDisposing
这个方法返回当前的服务是否正在运行中,虽然调用时返回结果需要一段时间,但在获取服务当前的状态时是非常有用的。
isDisposed
这个方法返回当前服务是否已释放资源,停止服务。一个服务只有在它所分配的所有资源已被释放时才被认定为是已释放资源的服务。
dispose
这个方法是否服务所分配的所有资源,因为释放资源的过程可能需要一段时间,因此用户可以使用isDisposing()和 isDisposed()方法来检测当前的资源是否释放完成。
getHandler
返回当前服务所关联的Io处理器。
setHandler
设置当前服务的Io处理器,这个处理器将负责处理这个服务的所有事件,你的业务逻辑也应该包含在这个处理器中。
getManagedSessions
返回一个包含当前服务所管理会话的map。服务所管理的会话是指被服务所监听的会话。它将被用来处理空闲的会话,已经会话的其他信息,这个依赖于服务监听的类型。
getManagedSessionCount
返回当前服务所管理的所有会话的数量
getSessionConfig
返回服务的会话配置
getFilterChainBuilder
返回当前服务的过滤器链构造器。这在新增会话是想要注入一个新的过滤器是非常有用的。
setFilterChainBuilder
定义这个服务所使用的过滤器链构造器。
getFilterChain
返回当前服务缺省的过滤器链。
isActive
告知当前服务是否是激活的。
getActivationTime
返回当前服务的激活时间。如果当前服务已处于非激活状态,则返回去最后一次的激活时间。
broadcast
向当前服务所管理的会话广播指定的消息
setSessionDataStructureFactory
设置为由这个服务所创建的会话提供关联数据结构的IoSessionDataStructureFactory
getScheduledWriteBytes
返回待写消息的字节总数(例如在内存中存储的将要写入指定socket的字节总数)
getScheduledWriteMessages
返回待写的消息总数(例如内存中存储的等待写入的消息)
getStatistics
返回当前服务的IoServiceStatistics对象
3.2 IoService 详情
IoService是一个接口,MINA中有两个非常重要的类是其实现类:
•IoAcceptor
•IoConnector
为了构建一个服务器,你需要选择一个IoAcceptor接口的实现类,如果是客户端应用,你需要实现IoConnector接口。
3.2.1 IoAcceptor
从根本上讲,这个接口是根据accept()方法来命名的,它负责在客户端和服务器之间创建一个新的连接。这个服务器接收连接所输入的请求。
有些时候,我们也把这个接口称作‘服务器’(这是一个即将发布的MINA3.0中的新名字)。
因为我们可能处理多种协议(TCP/UDP/…),所以这个接口有多个实现,一般情况下,你不需要自己来实现一个新的。
这里有一些实现类:
•NioSocketAcceptor :这是一个非阻塞Socket通信的IoAcceptor
•NioDatagramAcceptor : 这是一个非阻塞的UDP 通信 IoAcceptor
•AprSocketAcceptor : 这是一个基于APR的阻塞Socket 通信 IoAcceptor
•VmPipeSocketAcceptor :这是一个VM内部通信 IoAcceptor
你只需要选择一个符合你需要的即可。
下图是IoAcceptor接口及其实现类的类图:
3.2.2 IoConnector
因为我们必须为服务器使用一个IoAcceptor,所有你也必须为客户端使用一个IoConnector的实现类。这里有很多个实现类:
•NioSocketConnector : 非阻塞的Socket 通信 IoConnector
•NioDatagramConnector : 非阻塞的UDP 通信 IoConnector
•AprSocketConnector :基于APR的阻塞 Socket 通信 IoConnector
•ProxyConnector : 一个提供代理支持的 IoConnector
•SerialConnector : 一个支持串行通信的IoConnector
•VmPipeConnector : 一个VM内通信的 IoConnector
你需要做的只是选择适合你使用的。
下图是IoConnector接口和类的类图:
3.2.3 Acceptor
为了构建一个服务器,你必须选择一个IoAcceptor接口的实现类。
3.2.3.1 创建
首先,你必须做的是选择你想要实例化的IoAcceptor的实现类。你需要在早期就做好选择,这一切都依赖于你所使用的网络协议。让我们一起看一个例子来了解一下它是如何工作的:
publicTcpServer()throws IOException {
// Create a TCP acceptor
IoAcceptor acceptor =new NioSocketAcceptor();
// Associate the acceptor to an IoHandler instance (your application)
acceptor.setHandler(this);
// Bind : this will start the server...
acceptor.bind(new InetSocketAddress(PORT));
System.out.println("Server started...");
}
这样,一个TCP服务器就创建好了,如果你想要启动一个UDP服务器,只需要简单地把上面的第一行代码替换为:
...
// Create an UDP acceptor
IoAcceptor acceptor =new NioDatagramAcceptor();
3.2.3.2 停止
服务可以通过调用dispose()方法来停止。这个服务将在所有会话都处理完毕后停止:
// Stop the service, waiting for the pending sessions to be inactive
acceptor.dispose();
你可以通过给这个方法设置一个boolean参数决定是否等待所有线程处理完成。
// Stop the service, waiting for the processing session to be properly completed
acceptor.dispose(true);
3.2.3.3 状态
你可以通过调用以下方法来查询IoService的状态:
(1)isActive():如果服务可以接收到来的请求时返回true;
(2)isDisposing():如果dispose()方法被调用时返回true。这个方法不能确定当前的服务是否真的停止了,因为有一些会话可能还在处理中。
(3)isDisposed():如果dispose(boolean)方法被调用,并且执行中的线程已执行完毕时返回true。
3.2.3.4管理IoHandler
你可以通过调用setHandler(IoHandler)或 getHandler()方法添加或获取服务被实例化后所关联的IoHandle。
3.2.3.5 管理过滤器链
如果你想管理过滤器链,你必须调用getFilterChain()方法,下面是一个示例:
// 添加一个日志过滤器
DefaultIoFilterChainBuilder chain = acceptor.getFilterChain();
chain.addLast("logger",new LoggingFilter());
你也可以在将过滤器添加到服务前创建它
// Add a logger filter
DefaultIoFilterChainBuilder chain =new DefaultIoFilterChainBuilder();
chain.addLast("logger",new LoggingFilter());
// And inject the created chain builder in the service
acceptor.setFilterChainBuilder(chain);
3.2.4 Connector
对于一个客户端应用而言,你需要实现IoConnector接口。
具体的实现类和类图请参见3.2.2