NIO通讯框架之阿堂教程:Mina学习笔记-入门篇(一)

在 两三年前,阿堂在技术博客( http://blog.sina.com.cn/heyitang ) 上曾经写过"JAVA新I/O学习系列笔记(1)"和"JAVA新I/O学习系列笔记(2)"两篇学习笔记和网友们分享过。事实上，阿堂现在和网友们分享 这篇学习笔记中Mina(还有Netty、Grizzly等)实际上都是将NIO作为底层框架后再封装的一个开发高性能和高可用性的网络应用程序的框架。 Apache mina也称为 NIO框架  或   客户端/服务端框架（典型的C/S架构） 或   网络套接字（networking socket）类库 。关于它更多的介绍，在网上有很多，阿堂就不再说明了，想了解其更多介绍的网友可以在网上去查阅。
           
                   阿堂下面要分享的是mina 2.0在tcp/ip 协议下的应用开发的 一个入门demo ,希望能借此抛砖引玉，希望对想了解mina的朋友有所帮助。
        
             第一步 下载使用的Jar包
a. 登录http://mina.apache.org/downloads.html 下载 mina2.0.7.zip，解压获得mina-core-2.0.7-M1.jar
b. 登录 http://www.slf4j.org/download.html 下载slf4j1.7.2.zip，解压获得slf4j-api-1.7.2.jar 与 slf4j-log4j12-1.7.2.jar
c. 添加Log4j的jar包，注意如果使用slf4j-log4j12-XXX.jar，就需要添加log4j1.2.X。我这里使用的是log4j-1.2.15.jar （Logger配置详情参见 http://mina.apache.org/first-steps.html ）
如图所示(阿堂本地的截图)
 



     第二步 创建工程及log4j.properties文件
 
 log4j.rootLogger=DEBUG,MINA,file
log4j.appender.MINA=org.apache.log4j.ConsoleAppender
log4j.appender.MINA.layout=org.apache.log4j.PatternLayout
log4j.appender.MINA.layout.ConversionPattern=%d{yyyy-MM-dd HH\:mm\:ss,SSS} %-5p %c{1} %x - %m%n
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=D:/logs/minademos.log
log4j.appender.file.MaxFileSize=5120KB
log4j.appender.file.MaxBackupIndex=10
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[VAMS][%d] %p | %m | [%t] %C.%M(%L)%n


     第三步 创建服务端程序

public class MinaServer {
    // 记录日志
    private static Logger logger = Logger.getLogger(MinaServer.class);
    private static int PORT = 3005;

   
    public static void main(String[] args) {
        IoAcceptor acceptor = null;
        try {
            // 创建一个非阻塞的server端的Socket
            acceptor = new NioSocketAcceptor();
            // 设置过滤器（使用Mina提供的文本换行符编解码器）
            acceptor.getFilterChain().addLast(
                    "codec",
                    new ProtocolCodecFilter(new TextLineCodecFactory(Charset
                            .forName("UTF-8"),
                            LineDelimiter.WINDOWS.getValue(),
                            LineDelimiter.WINDOWS.getValue())));
            // 设置读取数据的缓冲区大小
            acceptor.getSessionConfig().setReadBufferSize(2048);
            // 读写通道10秒内无操作进入空闲状态
            acceptor.getSessionConfig().setIdleTime(IdleStatus.BOTH_IDLE, 10);
            // 绑定逻辑处理器
             acceptor.setHandler(new MinaServerHandler());
            // 绑定端口
            acceptor.bind(new InetSocketAddress(PORT));
            logger.info("服务端启动成功... 端口号为：" + PORT);

        } catch (Exception e) {
            logger.error("服务端启动异常", e);
            e.printStackTrace();
        }
    }
}

注意：创建服务端最主要的就是绑定服务端的消息编码解码过滤器和业务逻辑处理器

 解码:网络传输的数据都是二进制数据，而我们的程序不可能直接去操作二进制数据；这时候我们就需要来把接收到的字节数组转换为字符串，当然完全可以转换为任何一个java基本数据类型或对象。
 编码 :传输的字符串转换为字节。
 
        比 如上面使用的Mina自带的根据文本换行符编解码的TextLineCodec过滤器------ 指定参数为根据windows的换行符编解码，遇到客户端发送来的消息，看到windows换行符（\r\n）就认为是一个消息了，而发送给客户端的消 息，都会在消息末尾添加上\r\n文本换行符；

业务逻辑处理器是MinaServerHandler---看它的具体实现

 public class MinaServerHandler extends IoHandlerAdapter {
    public static Logger logger = Logger.getLogger(MinaServerHandler.class);

    @Override
    public void sessionCreated(IoSession session) throws Exception {
        logger.info("服务端与客户端创建连接...");
    }

    @Override
    public void sessionOpened(IoSession session) throws Exception {
        logger.info("服务端与客户端连接打开...");
    }

    @Override
    public void messageReceived(IoSession session, Object message)
            throws Exception {
        String msg = message.toString();
        logger.info("服务端接收到的数据为：" + msg);
        if ("bye".equals(msg)) { // 服务端断开连接的条件
            session.close();
        }
        Date date = new Date();
        session.write(date);
    }

    @Override
    public void messageSent(IoSession session, Object message) throws Exception {
//        session.close(); //发送成功后主动断开与客户端的连接
        logger.info("服务端发送信息成功...");
    }

    @Override
    public void sessionClosed(IoSession session) throws Exception {
    }

    @Override
    public void sessionIdle(IoSession session, IdleStatus status)
            throws Exception {
        logger.info("服务端进入空闲状态...");
    }

    @Override
    public void exceptionCaught(IoSession session, Throwable cause)
            throws Exception {
        logger.error("服务端发送异常...", cause);
    }
}

         自定义的业务逻辑处理器继承了IoHandlerAdapter类，它默认覆盖了父类的7个方法，其实我们最关心最常用的只有一个方法：messageReceived() ---- 服务端接收到一个消息后进行业务处理的方法；看代码
      public void messageReceived(IoSession session, Object message)
            throws Exception {
        String msg = message.toString();
        logger.info("服务端接收到的数据为：" + msg);
        if ("bye".equals(msg)) { // 服务端断开连接的条件
            session.close();
        }
        Date date = new Date();
        session.write(date);
    }

        接受到客户端信息，并返回给客户端一个日期；如果客户端传递的消息为“bye”，就是客户端告诉服务端，可以终止通话了，关闭与客户端的连接。 使用命令行的telnet来测试下服务端程序！

     先使用命令行的telnet来测试下服务端程序！
    1)启动服务端



2) telnet 127.0.0.1 3005




注意： 不要输入中文字符，windows不会把中文字符用utf-8编码再发送给服务端的。
 
 第四步 创建客户端程序
 Mina能做服务端程序，自然也可以做客户端程度啦。最重要的是，客户端程序和服务端程序写法基本一致，很简单的。
客户端代码：
 public class MinaClient {
    private static Logger logger = Logger.getLogger(MinaClient.class);
    private static String HOST = "127.0.0.1";
    private static int PORT = 3005;

    public static void main(String[] args) {
        // 创建一个非阻塞的客户端程序
        IoConnector connector = new NioSocketConnector();
        // 设置链接超时时间
        connector.setConnectTimeout(30000);
        // 添加过滤器
        connector.getFilterChain().addLast(
                "codec",
                new ProtocolCodecFilter(new TextLineCodecFactory(Charset
                        .forName("UTF-8"), LineDelimiter.WINDOWS.getValue(),
                        LineDelimiter.WINDOWS.getValue())));
        // 添加业务逻辑处理器类
        connector.setHandler(new MinaClientHandler());
        IoSession session = null;
        try {
            ConnectFuture future = connector.connect(new InetSocketAddress(
                    HOST, PORT));// 创建连接
            future.awaitUninterruptibly();// 等待连接创建完成
            session = future.getSession();// 获得session
            session.write("网络时空 爱你 mina");// 发送消息
        } catch (Exception e) {
            logger.error("客户端链接异常...", e);
        }
        session.getCloseFuture().awaitUninterruptibly();// 等待连接断开
        connector.dispose();
    }
}

       和服务端代码极其相似，不同的是服务端是创建NioSocketAcceptor对象，而客户端是创建NioSocketConnector对象；同样需要添加编码解码过滤器和业务逻辑过滤器；
      业务逻辑过滤器代码
 public class MinaClientHandler extends IoHandlerAdapter {
    private static Logger logger = Logger.getLogger(MinaClientHandler.class);

    @Override
    public void messageReceived(IoSession session, Object message)
            throws Exception {
        String msg = message.toString();
        logger.info("客户端接收到的信息为：" + msg);
    }

    @Override
    public void exceptionCaught(IoSession session, Throwable cause)
            throws Exception {
        logger.error("客户端发生异常...", cause);
    }
}
         它和服务端的业务逻辑处理类一样，继承了IoHandlerAdapter类，因此同样可以覆盖父类的7个方法，同样最关心messageReceived方法，这里的处理是接收打印了服务端返回的信息；另一个覆盖的方法是异常信息捕获的方法；
测试服务端与客户端程序！
a. 启动服务端，然后再启动客户端（客户端发送的消息是“网络时空 爱你 mina”）
b. 服务端接收消息并处理成功；

测试结果详见log4j.properties文件中 minademos.log文件




 

到此为止，我们已经可以运行一个完整的基于TCP/IP协议的应用程序啦！

总结： 服务端程序或客户端程序创建过程： 创建连接---.添加消息过滤器(编码解码等)——>添加业务处理