Apache Mina 入门

2007 年 12 月 24 日

本文将通过一个简单的问候程序 HelloServer 来介绍 MINA 的基础架构的同时演示如何使用 MINA 开发网络应用程序。

<!-- START RESERVED FOR FUTURE USE INCLUDE FILES--><!-- include java script once we verify teams wants to use this and it will work on dbcs and cyrillic characters --> <!-- END RESERVED FOR FUTURE USE INCLUDE FILES-->

Apache MINA(Multipurpose Infrastructure for Network Applications) 是 Apache 组织一个较新的项目，它为开发高性能和高可用性的网络应用程序提供了非常便利的框架。当前发行的 MINA 版本支持基于 Java NIO 技术的 TCP/UDP 应用程序开发、串口通讯程序（只在最新的预览版中提供），MINA 所支持的功能也在进一步的扩展中。

目 前正在使用 MINA 的软件包括有：Apache Directory Project、AsyncWeb、AMQP（Advanced Message Queuing Protocol）、RED5 Server（Macromedia Flash Media RTMP）、ObjectRADIUS、Openfire 等等。

本文将通过一个简单的问候程序 HelloServer 来介绍 MINA 的基础架构的同时演示如何使用MINA 开发网络应用程序。

环境准备

1. 首先到官方网站下载最新的 MINA 版本，地址是：http://mina.apache.org/downloads.html 。 下载之前先介绍一下 MINA 的两个版本：1.0.x 适合运行环境为 JDK1.4，1.1.x 适合 JDK1.5 的版本，两者的编译环境都需要 JDK1.5。JDK1.5 已经是非常普遍了，本文中使用 1.1.5 版本的 MINA，编译和运行所需的文件是 mina-core-1.1.5.jar。
2. 下载 MINA 的依赖包 slf4j。MINA 使用此项目作为日志信息的输出，而 MINA 本身并不附带此项目包，请到http://www.slf4j.org/download.html 地址下载 slf4j 包，slf4j 项目解压后有很多的文件，本例中只需要其中的 slf4j-api-1.4.3.jar 和 slf4j-simple-1.4.3.jar 这两个 jar 文件。如果没有这两个文件就会导致启动例子程序的时候报 org/slf4j/LoggerFactory 类没找到的错误。
3. 当然要求机器上必须装有 1.5 或者更新版本的 JDK。
4. 最好你应该选择一个顺手的 Java 开发环境例如 Eclipse 或者 NetBeans 之类的，可以更方便的编码和调试，虽然我们的最低要求只是一个简单的文本编辑器而已。

 

回页首

编写代码并执行

1. 编写代码 HelloServer.java 如下

package demo.mina.echo;

import java.io.IOException;
import java.net.InetSocketAddress;

import org.apache.mina.common.*;
import org.apache.mina.transport.socket.nio.*;
import org.apache.mina.filter.codec.ProtocolCodecFilter;
import org.apache.mina.filter.codec.textline.TextLineCodecFactory;

/**
 * HelloServer演示程序
 * @author liudong (
                    http://www.dlog.cn/javayou

                
)
 */
public class HelloServer {

    private static final int PORT
 = 8080;
/**
 * @param args
 * @throws IOException 
 */
public static void main(String[] args) throws IOException {
        IoAcceptor acceptor = new SocketAcceptor();        
        IoAcceptorConfig config = new SocketAcceptorConfig();
        DefaultIoFilterChainBuilder chain = config.getFilterChain();
        //使用字符串编码
        chain.addLast("codec", 
new ProtocolCodecFilter(new TextLineCodecFactory()));
        //启动HelloServer
        acceptor.bind(new InetSocketAddress(PORT
), new HelloHandler(), config);
        System.out
.println("HelloServer started on port " + PORT
);
	}
}

/**
 * HelloServer的处理逻辑
 * @author liudong
 */
class HelloHandler extends IoHandlerAdapter {
/**
 * 当有异常发生时触发
 */
@Override
    public void exceptionCaught(IoSession ssn, Throwable cause) {
        cause.printStackTrace();
        ssn.close();
    }

/**
 * 有新连接时触发
 */
@Override
public void sessionOpened(IoSession ssn) throws Exception {
    System.out
.println("session open for " + ssn.getRemoteAddress());
	}

/**
 * 连接被关闭时触发
 */
@Override
public void sessionClosed(IoSession ssn) throws Exception {
    System.out
.println("session closed from " + ssn.getRemoteAddress());
	}

/**
 * 收到来自客户端的消息
 */
public void messageReceived(IoSession ssn, Object msg) throws Exception {    
    String ip = ssn.getRemoteAddress().toString();
System.out
.println("===> Message From " + ip +" : " + msg);    
    ssn.write("Hello " + msg);
    }
}

 

1. 编译执行

先不用试着去读懂每一行代码的具体意思，用你顺手的编译器编译 HelloServer.java，如果报错请确认是否已将前面提到的三个 jar 文件添加至类路径中。如果一切顺利接着就可以启动HelloServer 程序，启动后提示：HelloServer started on port 8080 表示启动成功，如果启动失败，问题无外乎是类没找到或者端口占用。如果端口被占用的话，换一个罗，修改 PORT 常量值后再次编译并启动。

1. 测试服务器

打开命令行窗口，输入 telnet localhost 8080 后，输入您的英文名或者其他一些乱七八糟的字符后回车再去看看刚启动的服务程序有何反应。我的反应如下：

HelloServer started on port 8080
session open for /127.0.0.1:3023
===> Message From /127.0.0.1:3023 :hello
===> Message From /127.0.0.1:3023 :hello
===> Message From /127.0.0.1:3023 :liudong
===> Message From /127.0.0.1:3023 :Winter Lau

 

好了，一切正常，恭喜你的第一个使用 MINA 开发的网络程序已经成功运行了。

 

回页首

MINA 基本类的描述

在介绍架构之前先认识几个接口：

IoAccepter 相当于网络应用程序中的服务器端

IoConnector 相当于客户端

IoSession 当前客户端到服务器端的一个连接实例

IoHandler 业务处理逻辑

IoFilter 过滤器用于悬接通讯层接口与业务层接口

 

回页首

MINA 的基础架构

下图是 MINA 的架构图，

图 1：MINA 的架构图

在 图中的模块链中，IoService 便是应用程序的入口，相当于我们前面代码中的 IoAccepter，IoAccepter 便是 IoService 的一个扩展接口。IoService 接口可以用来添加多个 IoFilter，这些 IoFilter 符合责任链模式并由 IoProcessor 线程负责调用。而 IoAccepter 在 ioService 接口的基础上还提供绑定某个通讯端口以及取消绑定的接口。在上面的例子中，我们是这样使用 IoAccepter 的：

IoAcceptor acceptor = new
 SocketAcceptor();

 

相当于我们使用了 Socket 通讯方式作为服务的接入，当前版本的 MINA 还提供了除 SocketAccepter 外的基于数据报文通讯的 DatagramAccepter 以及基于管道通讯的 VmPipeAccepter。另外还包括串口通讯接入方式，目前基于串口通讯的接入方式已经在最新测试版的 MINA 中提供。你也可以自行实现 IoService 接口来使用自己的通讯方式。

而在上图中最右端也就是 IoHandler，这便是业务处理模块。相当于前面例子中的 HelloHandler 类。在业务处理类中不需要去关心实际的通讯细节，只管处理客户端传输过来的信息即可。编写 Handler 类就是使用 MINA 开发网络应用程序的重心所在，相当于 MINA 已经帮你处理了所有的通讯方面的细节问题。为了简化 Handler 类，MINA 提供了 IoHandlerAdapter 类，此类仅仅是实现了 IoHandler 接口，但并不做任何处理。

一个 IoHandler 接口中具有如下一些方法（摘自 MINA 的 API 文档）：

void exceptionCaught (IoSession session, Throwable cause)
                   当接口中其他方法抛出异常未被捕获时触发此方法

void messageReceived (IoSession session, Object message)
                   当接收到客户端的请求信息后触发此方法.

void messageSent (IoSession session, Object message)
                   当信息已经传送给客户端后触发此方法.

void sessionClosed (IoSession session)
                   当连接被关闭时触发，例如客户端程序意外退出等等.

void sessionCreated (IoSession session)
                   当一个新客户端连接后触发此方法.

void sessionIdle (IoSession session, IdleStatus status)
                   当连接空闲时触发此方法.

void sessionOpened (IoSession session)
                   当连接后打开时触发此方法，一般此方法与 sessionCreated 会被同时触发

 

前面我们提到 IoService 是负责底层通讯接入，而 IoHandler 是负责业务处理的。那么 MINA 架构图中的 IoFilter 作何用途呢？答案是你想作何用途都可以。但是有一个用途却是必须的，那就是作为 IoService 和 IoHandler 之间的桥梁。IoHandler 接口中最重要的一个方法是 messageReceived，这个方法的第二个参数是一个 Object 型的消息，总所周知，Object 是所有 Java 对象的基础，那到底谁来决定这个消息到底是什么类型呢？答案也就在这个 IoFilter 中。在前面使用的例子中，我们添加了一个 IoFilter 是 new ProtocolCodecFilter(new TextLineCodecFactory())，这个过滤器的作用是将来自客户端输入的信息转换成一行行的文本后传递给 IoHandler，因此我们可以在 messageReceived 中直接将 msg 对象强制转换成 String 对象。

而 如果我们不提供任何过滤器的话，那么在 messageReceived 方法中的第二个参数类型就是一个 byte 的缓冲区，对应的类是 org.apache.mina.common.ByteBuffer。虽然你也可以将解析客户端信息放在 IoHandler 中来做，但这并不是推荐的做法，使原来清晰的模型又模糊起来，变得 IoHandler 不只是业务处理，还得充当协议解析的任务。

MINA自身带有一些常用的过滤器，例如LoggingFilter（日志记录）、BlackListFilter（黑名单过滤）、CompressionFilter（压缩）、SSLFilter（SSL加密）等。

 

回页首

其他

MINA 不仅仅是用来开发网络服务器端应用程序，它一样可以使用 IoConnector 来连接到各种各样的网络服务程序。

通 过本文中 HelloServer 这个例子，我们在惊叹 MINA 可以带来多么大便利的同时，还不得不为其卓越的性能而骄傲，据称使用MINA开发服务器程序的性能已经逼近使用 C/C++ 语言开发的网络服务。作为 MINA 的入门文章，性能问题不在本文讨论范围内。

另外在 MINA 压缩包中附带有不少比 HelloServer 要好得多的例子，通过这些例子可以进一步的了解并掌握 MINA。

参考资料

• http://mina.apache.org MINA 官方网站
  
  
• http://mina.apache.org/features.html 您可以在这里查看关于 MINA 的更多特性
  
  
• http://mina.apache.org/testimonials.html 看看别人是如何评价 MINA 的 http://asyncweb.safehaus.org/ 使用 MINA 开发的高性能 WEB 服务器

 

http://www.ibm.com/developerworks/cn/opensource/os-cn-apmina/