用 Apache MINA 2 开发网络应用

jieforest

过滤器链

过滤器只有在添加到过滤器链中的时候才起作用。过滤器链是过滤器的容器。过滤器链与 I/O 会话是一一对应的关系。org.apache.mina.core.filterchain.IoFilterChain是 Apache MINA 中过滤器链的接口，其中提供了一系列方法对其中包含的过滤器进行操作，包括查询、添加、删除和替换等。如 表 5 所示。

表 5. IoFilterChain 接口的方法

jieforest

I/O 处理器

I/O 事件通过过滤器链之后会到达 I/O 处理器。I/O 处理器中与 I/O 事件对应的方法会被调用。Apache MINA 中 org.apache.mina.core.service.IoHandler是 I/O 处理器要实现的接口，一般情况下，只需要继承自 org.apache.mina.core.service.IoHandlerAdapter并覆写所需方法即可。IoHandler接口的方法如 表 6 所示。

表 6. IoHandler 接口的方法

jieforest

对于 表 6 中的方法，有几个需要重点的说明一下。首先是 sessionCreated 和 sessionOpened 的区别。sessionCreated方法是由 I/O 处理线程来调用的，而 sessionOpened 是由其它线程来调用的。因此从性能方面考虑，不要在 sessionCreated 方法中执行过多的操作。对于 sessionIdle，默认情况下，闲置时间设置是禁用的，也就是说 sessionIdle 并不会被调用。可以通过 IoSessionConfig.setIdleTime(IdleStatus, int) 来进行设置。

Apache MINA 中的基本概念已经介绍完了，下面介绍状态机的使用。

jieforest

使用状态机

在 I/O 处理器中实现业务逻辑的时候，对于简单的情况，一般只需要在 messageReceived 方法中对传入的消息进行处理。如果需要写回数据到对等体的话，用 IoSession.write 方法即可。在另外的一些情况下，客户端和服务器端的通信协议比较复杂，客户端其实是有状态变迁的。这个时候可以用 Apache MINA 提供的状态机实现，可以使得 I/O 处理器的实现更加简单。

状态机中两个重要的元素是状态以及状态之间的迁移。示例应用中客户端的状态以及迁移如 图 5 所示。

图 5. 联机游戏示例应用中客户端的状态以及迁移

jieforest

客户端初始化的时候，其状态为“未连接”，表示客户端还没有在服务器上面注册，此时还不能进行游戏；接着用户需要输入一个昵称来注册到服务器上面，完成之后状态迁移到“闲置”。此时客户端会接收到当前在线的所有其它用户的列表。当前用户可以邀请其它用户和他一块游戏，也可以接收来自其它用户的邀请。邀请发送出去之后，客户端的状态迁移到“邀请已发送”。如果接受了其它用户的邀请，客户端的状态迁移到“邀请已接收”。如果某个用户的邀请被另外一个用户接受的话，两个客户端的状态都会迁移到“游戏中”。

要实现这样较为复杂的状态机的话，只需要在 I/O 处理器中以声明式的方式定义状态和迁移条件就可以了。首先需要声明状态机中状态，如 清单 8 所示。

清单 8. 联机游戏示例应用中的状态声明@State public static final String ROOT = "Root";
@State(ROOT) public static final String NOT_CONNECTED = "NotConnected";
@State(ROOT) public static final String IDLE = "Idle";
@State(ROOT) public static final String INVITATION_SENT = "InvitationSent";
@State(ROOT) public static final String INVITATION_ACCEPTED = "InvitationAccepted";
@State(ROOT) public static final String PLAYING = "Playing";

jieforest

如 清单 8 所示，上面定义了一共六个状态。通过标注 @State就声明了一个状态。需要注意的是状态之间是可以继承的。如果状态机接收到一个事件的时候，在当前状态中找不到对应的迁移，就会在其父状态上继续查找。状态的继承在某些情况下是很有用的，比如希望为所有的状态都增加同样的迁移逻辑，就可以直接把迁移条件添加在父状态上面。一个典型的场景就是错误处理，一般来说，所有的状态都需要错误处理，而错误处理的逻辑一般都是相同的。把发生错误时候的迁移放在父状态中，可以简洁的描述这一场景。

定义了状态之后，下面应该声明状态之间的迁移。如 清单 9 所示。

清单 9. 联机游戏示例应用中的状态迁移声明@IoHandlerTransition(on = MESSAGE_RECEIVED, in = NOT_CONNECTED, next = IDLE)
public void login(TetrisServerContext context, IoSession session, LoginCommand cmd) {
    String nickName = cmd.getNickName();
    context.nickName = nickName;
    session.setAttribute("nickname", nickName);
    session.setAttribute("status", UserStatus.IDLE);
    sessions.add(session);
    users.add(nickName);
               
    RefreshPlayersListCommand command = createRefreshPlayersListCommand();
    broadcast(command);
}
  
@IoHandlerTransition(on = EXCEPTION_CAUGHT, in = ROOT, weight = 10)
public void exceptionCaught(IoSession session, Exception e) {
    LOGGER.warn("Unexpected error.", e);
    session.close(true);
}

@IoHandlerTransition(in = ROOT, weight = 100)
public void unhandledEvent() {
    LOGGER.warn("Unhandled event.");
}

jieforest

清单 9 中，使用标注 @IoHandlerTransition声明了一个状态迁移。每个状态迁移可以有四个属性：on、in、next和 weight，其中属性 in是必须的，其余是可选的。属性 on表示触发此状态迁移的事件名称，如果省略该属性的话，则默认为匹配所有事件的通配符。该属性的值可以是表中给出的 I/O 处理器中能处理的七种事件类型。属性 in表示状态迁移的起始状态。属性 next表示状态迁移的结束状态，如果省略该属性的话，则默认为表示当前状态 的 _self_。属性 weight用来指明状态迁移的权重。一个状态的所有迁移是按照其权重升序排列的。对于当前状态，如果有多个可能的迁移，排序靠前的迁移将会发生。代码中的第一个标注声明了如果当前状态是“未连接”，并且接收到了 MESSAGE_RECEIVED事件，而且消息的内容是一个 LoginCommand对象的话，login方法会被调用，调用完成之后，当前状态迁移到“闲置”。第二个标注声明了对于任何的状态，如果接收到了 EXCEPTION_CAUGHT事件，exceptionCaught方法会被调用。最后一个标注声明了一个状态迁移，其起始状态是 ROOT，表示该迁移对所有的事件都起作用。不过它的 weight是 100，优先级比较低。该状态迁移的作用是处理其它没有对应状态迁移的事件。

使用了 Apache MINA 提供的状态机之后，创建 I/O 处理器的方式也发生了变化。I/O 处理器的实例由状态机来创建，如 清单 10 所示。

jieforest

清单 10. 在状态机中创建 I/O 处理器private static IoHandler createIoHandler() {
    StateMachine sm = StateMachineFactory.getInstance(
        IoHandlerTransition.class).create(ServerHandler.NOT_CONNECTED,
        new ServerHandler());
    return new StateMachineProxyBuilder().setStateContextLookup(
        new IoSessionStateContextLookup(new StateContextFactory() {
            public StateContext create() {
                return new ServerHandler.TetrisServerContext();
            }
    })).create(IoHandler.class, sm);
}



在 清单 10 中，TetrisServerContext是提供给状态机的上下文对象，用来在状态之间共享数据。当然用 IoSession也是可以实现的，不过上下文对象的好处是类型安全，不需要做额外的类型转换。

在介绍完状态机后，下面介绍一些高级话题，包括异步操作以及 Apache MINA 与 JMX 和 Spring 的集成。

jieforest

异步操作

Apache MINA 中的很多操作都是异步的，比如连接的建立、连接的关闭、还有数据的发送等。在编写网络应用的时候，需要考虑这一点。比如 IoConnector的 connect方法，其返回值是 org.apache.mina.core.future.ConnectFuture类的对象。通过此对象，可以查询连接操作的状态。清单 3 中已经使用了 ConnectFuture。另外一个常用的是发送数据时使用的 org.apache.mina.core.future.WriteFuture，如 清单 11 所示。

清单 11. WriteFuture 的使用IoSession session = ...; // 获取 I/O 会话对象
WriteFuture future = session.write("Hello World"); // 发送数据
future.awaitUninterruptibly(); // 等待发送数据操作完成
if(future.isWritten())
{
    // 数据已经被成功发送
}
else
{
    // 数据发送失败
}



由于这样的需求很常见，I/O 处理器中提供了 messageSent方法，当数据发送成功的时候，该方法会被调用。

jieforest

JMX 集成

Apache MINA 可以集成 JMX 来对网络应用进行管理和监测。下面通过对前面给出的计算器服务进行简单修改，来说明如何集成 JMX。所需的修改如 清单 12 所示。

清单 12. Apache MINA 与 JMX 的集成MBeanServer mBeanServer = ManagementFactory.getPlatformMBeanServer();
IoAcceptor acceptor = new NioSocketAcceptor();
IoServiceMBean acceptorMBean = new IoServiceMBean(acceptor);
ObjectName acceptorName = new ObjectName(acceptor.getClass()
    .getPackage().getName()
    + ":type=acceptor,name=" + acceptor.getClass().getSimpleName());
mBeanServer.registerMBean(acceptorMBean, acceptorName);



如 清单 12 所示，首先获取平台提供的受控 bean 的服务器，接着创建受控 bean（MBean）来包装想要管理和监测的对象，这里使用的是 I/O 连接器对象。最后把创建出来的受控 bean 注册到服务器即可。