2019独角兽企业重金招聘Python工程师标准>>>

介绍Mina的TCP的主要接口:
通过上面的两个示例,你应该对Mina 如何编写TCP/IP 协议栈的网络通信有了一些感性的认
识。
(1.)IoService:
这个接口是服务端IoAcceptor、客户端IoConnector 的抽象,提供IO 服务和管理IoSession
的功能,它有如下几个常用的方法:
A. TransportMetadata getTransportMetadata():
这个方法获取传输方式的元数据描述信息,也就是底层到底基于什么的实现,譬如:nio、
apr 等。
B. void addListener(IoServiceListener listener):
这个方法可以为IoService 增加一个监听器,用于监听IoService 的创建、活动、失效、空
闲、销毁,具体可以参考IoServiceListener 接口中的方法,这为你参与IoService 的生命
周期提供了机会。
C. void removeListener(IoServiceListener listener):
这个方法用于移除上面的方法添加的监听器。
D. void setHandler(IoHandler handler):
这个方法用于向IoService 注册IoHandler,同时有getHandler()方法获取Handler。
E. Map<Long,IoSession> getManagedSessions():
这个方法获取IoService 上管理的所有IoSession,Map 的key 是IoSession 的id。
F. IoSessionConfig getSessionConfig():
这个方法用于获取IoSession 的配置对象,通过IoSessionConfig 对象可以设置Socket 连
接的一些选项。
_______________________________________________________________________________
(2.)IoAcceptor:
这个接口是TCPServer 的接口,主要增加了void bind()监听端口、void unbind()解除对
套接字的监听等方法。这里与传统的JAVA 中的ServerSocket 不同的是IoAcceptor 可以多
次调用bind()方法(或者在一个方法中传入多个SocketAddress 参数)同时监听多个端口。
_______________________________________________________________________________
(3.)IoConnector:
这个接口是TCPClient 的接口, 主要增加了ConnectFuture connect(SocketAddress
remoteAddress,SocketAddress localAddress)方法,用于与Server 端建立连接,第二个参
数如果不传递则使用本地的一个随机端口访问Server 端。这个方法是异步执行的,同样的,
也可以同时连接多个服务端。

_______________________________________________________________________________
(4.)IoSession:
这个接口用于表示Server 端与Client 端的连接,IoAcceptor.accept()的时候返回实例。
这个接口有如下常用的方法:
A. WriteFuture write(Object message):
这个方法用于写数据,该操作是异步的。
B. CloseFuture close(boolean immediately):
这个方法用于关闭IoSession,该操作也是异步的,参数指定true 表示立即关闭,否则就
在所有的写操作都flush 之后再关闭。
C. Object setAttribute(Object key,Object value):
这个方法用于给我们向会话中添加一些属性,这样可以在会话过程中都可以使用,类似于
HttpSession 的setAttrbute()方法。IoSession 内部使用同步的HashMap 存储你添加的自
定义属性。
D. SocketAddress getRemoteAddress():
这个方法获取远端连接的套接字地址。
E. void suspendWrite():
这个方法用于挂起写操作,那么有void resumeWrite()方法与之配对。对于read()方法同
样适用。
F. ReadFuture read():
这个方法用于读取数据, 但默认是不能使用的, 你需要调用IoSessionConfig 的
setUseReadOperation(true)才可以使用这个异步读取的方法。一般我们不会用到这个方法,
因为这个方法的内部实现是将数据保存到一个BlockingQueue,假如是Server 端,因为大
量的Client 端发送的数据在Server 端都这么读取,那么可能会导致内存泄漏,但对于
Client,可能有的时候会比较便利。
G. IoService getService():
这个方法返回与当前会话对象关联的IoService 实例。
关于TCP连接的关闭:
无论在客户端还是服务端,IoSession 都用于表示底层的一个TCP 连接,那么你会发现无论
是Server 端还是Client 端的IoSession 调用close()方法之后,TCP 连接虽然显示关闭, 但
主线程仍然在运行,也就是JVM 并未退出,这是因为IoSession 的close()仅仅是关闭了TCP
的连接通道,并没有关闭Server 端、Client 端的程序。你需要调用IoService 的dispose()
方法停止Server 端、Client 端。
_______________________________________________________________________________
(5.)IoSessionConfig:
这个方法用于指定此次会话的配置,它有如下常用的方法:
A. void setReadBufferSize(int size):

这个方法设置读取缓冲的字节数,但一般不需要调用这个方法,因为IoProcessor 会自动调
整缓冲的大小。你可以调用setMinReadBufferSize()、setMaxReadBufferSize()方法,这
样无论IoProcessor 无论如何自动调整,都会在你指定的区间。
B. void setIdleTime(IdleStatus status,int idleTime):
这个方法设置关联在通道上的读、写或者是读写事件在指定时间内未发生,该通道就进入空
闲状态。一旦调用这个方法,则每隔idleTime 都会回调过滤器、IoHandler 中的sessionIdle()
方法。
C. void setWriteTimeout(int time):
这个方法设置写操作的超时时间。
D. void setUseReadOperation(boolean useReadOperation):
这个方法设置IoSession 的read()方法是否可用,默认是false。
_______________________________________________________________________________
(6.)IoHandler:
这个接口是你编写业务逻辑的地方,从上面的示例代码可以看出,读取数据、发送数据基本
都在这个接口总完成,这个实例是绑定到IoService 上的,有且只有一个实例(没有给一个
IoService 注入一个IoHandler 实例会抛出异常)。它有如下几个方法:
A. void sessionCreated(IoSession session):
这个方法当一个Session 对象被创建的时候被调用。对于TCP 连接来说,连接被接受的时候
调用,但要注意此时TCP 连接并未建立,此方法仅代表字面含义,也就是连接的对象
IoSession 被创建完毕的时候,回调这个方法。
对于UDP 来说,当有数据包收到的时候回调这个方法,因为UDP 是无连接的。
B. void sessionOpened(IoSession session):
这个方法在连接被打开时调用,它总是在sessionCreated()方法之后被调用。对于TCP 来
说,它是在连接被建立之后调用,你可以在这里执行一些认证操作、发送数据等。
对于UDP 来说,这个方法与sessionCreated()没什么区别,但是紧跟其后执行。如果你每
隔一段时间,发送一些数据,那么sessionCreated()方法只会在第一次调用,但是
sessionOpened()方法每次都会调用。
C. void sessionClosed(IoSession session) :
对于TCP 来说,连接被关闭时,调用这个方法。
对于UDP 来说,IoSession 的close()方法被调用时才会毁掉这个方法。
D. void sessionIdle(IoSession session, IdleStatus status) :
这个方法在IoSession 的通道进入空闲状态时调用,对于UDP 协议来说,这个方法始终不会
被调用。
E. void exceptionCaught(IoSession session, Throwable cause) :
这个方法在你的程序、Mina 自身出现异常时回调,一般这里是关闭IoSession。

F. void messageReceived(IoSession session, Object message) :
接收到消息时调用的方法,也就是用于接收消息的方法,一般情况下,message 是一个
IoBuffer 类,如果你使用了协议编解码器,那么可以强制转换为你需要的类型。通常我们
都是会使用协议编解码器的, 就像上面的例子, 因为协议编解码器是
TextLineCodecFactory,所以我们可以强制转message 为String 类型。
G. void messageSent(IoSession session, Object message) :
当发送消息成功时调用这个方法,注意这里的措辞,发送成功之后,也就是说发送消息是不
能用这个方法的。
发送消息的时机:
发送消息应该在sessionOpened()、messageReceived()方法中调用IoSession.write()方法
完成。因为在sessionOpened()方法中,TCP 连接已经真正打开,同样的在messageReceived()
方法TCP 连接也是打开状态,只不过两者的时机不同。sessionOpened()方法是在TCP 连接
建立之后,接收到数据之前发送;messageReceived()方法是在接收到数据之后发送,你可
以完成依据收到的内容是什么样子,决定发送什么样的数据。
因为这个接口中的方法太多,因此通常使用适配器模式的IoHandlerAdapter,覆盖你所感
兴趣的方法即可。
_______________________________________________________________________________
(7.)IoBuffer:
这个接口是对JAVA NIO 的ByteBuffer 的封装,这主要是因为ByteBuffer 只提供了对基本
数据类型的读写操作,没有提供对字符串等对象类型的读写方法,使用起来更为方便,另外,
ByteBuffer 是定长的,如果想要可变,将很麻烦。IoBuffer 的可变长度的实现类似于
StringBuffer。IoBuffer 与ByteBuffer 一样,都是非线程安全的。本节的一些内容如果不
清楚,可以参考java.nio.ByteBuffer 接口。
这个接口有如下常用的方法:
A. static IoBuffer allocate(int capacity,boolean useDirectBuffer):
这个方法内部通过SimpleBufferAllocator 创建一个实例,第一个参数指定初始化容量,第
二个参数指定使用直接缓冲区还是JAVA 内存堆的缓存区,默认为false。
B. void free():
释放缓冲区,以便被一些IoBufferAllocator 的实现重用,一般没有必要调用这个方法,除
非你想提升性能(但可能未必效果明显)。
C. IoBuffer setAutoExpand(boolean autoExpand):
这个方法设置IoBuffer 为自动扩展容量,也就是前面所说的长度可变,那么可以看出长度
可变这个特性默认是不开启的。
D. IoBuffer setAutoShrink(boolean autoShrink):
这个方法设置IoBuffer 为自动收缩,这样在compact()方法调用之后,可以裁减掉一些没
有使用的空间。如果这个方法没有被调用或者设置为false,你也可以通过调用shrink()
方法手动收缩空间。

E. IoBuffer order(ByteOrder bo):
这个方法设置是Big Endian 还是Little Endian,JAVA 中默认是Big Endian,C++和其他
语言一般是Little Endian。
F. IoBuffer asReadOnlyBuffer():
这个方法设置IoBuffer 为只读的。
G. Boolean prefixedDataAvailable(int prefixLength,int maxDataLength):
这个方法用于数据的最开始的1、2、4 个字节表示的是数据的长度的情况,prefixLentgh
表示这段数据的前几个字节(只能是1、2、4 的其中一个)的代表的是这段数据的长度,
maxDataLength 表示最多要读取的字节数。返回结果依赖于等式
remaining()-prefixLength>=maxDataLength,也就是总的数据-表示长度的字节,剩下的字
节数要比打算读取的字节数大或者相等。
H. String getPrefixedString(int prefixLength,CharsetDecoder decoder):
如果上面的方法返回true,那么这个方法将开始读取表示长度的字节之后的数据,注意要
保持这两个方法的prefixLength 的值是一样的。
G、H 两个方法在后面讲到的PrefixedStringDecoder 中的内部实现使用。
IoBuffer 剩余的方法与ByteBuffer 都是差不多的,额外增加了一些便利的操作方法,例如:
IoBuffer putString(String value,CharsetEncoder encoder)可以方便的以指定的编码方
式存储字符串、InputStream asInputStream()方法从IoBuffer 剩余的未读的数据中转为
输入流等。
_______________________________________________________________________________
(8.)IoFuture:
在Mina 的很多操作中,你会看到返回值是XXXFuture,实际上他们都是IoFuture 的子类,
看到这样的返回值,这个方法就说明是异步执行的,主要的子类有ConnectFuture、
CloseFuture 、ReadFuture 、WriteFuture 。这个接口的大部分操作都和
java.util.concurrent.Future 接口是类似的,譬如:await()、awaitUninterruptibly()
等,一般我们常用awaitUninterruptibly()方法可以等待异步执行的结果返回。
这个接口有如下常用的方法:
A. IoFuture addListener(IoFutureListener<?> listener):
这个方法用于添加一个监听器, 在异步执行的结果返回时监听器中的回调方法
operationComplete(IoFuture future),也就是说,这是替代awaitUninterruptibly()方
法另一种等待异步执行结果的方法,它的好处是不会产生阻塞。
B. IoFuture removeListener(IoFutureListener<?> listener):
这个方法用于移除指定的监听器。
C. IoSession getSession():
这个方法返回当前的IoSession。

举个例子,我们在客户端调用connect()方法访问Server 端的时候,实际上这就是一个异
步执行的方法,也就是调用connect()方法之后立即返回,执行下面的代码,而不管是否连
接成功。那么如果我想在连接成功之后执行一些事情(譬如:获取连接成功后的IoSession
对象),该怎么办呢?按照上面的说明,你有如下两种办法:
第一种:
ConnectFuture future = connector.connect(new InetSocketAddress(
HOSTNAME, PORT));
// 等待是否连接成功,相当于是转异步执行为同步执行。
future.awaitUninterruptibly();
// 连接成功后获取会话对象。如果没有上面的等待,由于connect()方法是异步的,session
可能会无法获取。
session = future.getSession();
第二种:
ConnectFuture future = connector.connect(new InetSocketAddress(
HOSTNAME, PORT));
future.addListener(new IoFutureListener<ConnectFuture>() {
@Override
public void operationComplete(ConnectFuture future) {
try {
Thread.sleep(5000);
} catch (InterruptedException e) {
e.printStackTrace();
}
IoSession session = future.getSession();
System.out.println("++++++++++++++++++++++++++++");
}
});
System.out.println("*************");
为了更好的看清楚使用监听器是异步的,而不是像awaitUninterruptibly()那样会阻塞主
线程的执行,我们在回调方法中暂停5 秒钟,然后输出+++,在最后输出***。我们执行代码
之后,你会发现首先输出***(这证明了监听器是异步执行的),然后IoSession 对象Created,
系统暂停5 秒,然后输出+++,最后IoSession 对象Opened,也就是TCP 连接建立。
_______________________________________________________________________________
4.日志配置:
前面的示例代码中提到了使用SLF4J 作为日志门面,这是因为Mina 内部使用的就是SLF4J,
你也使用SLF4J 可以与之保持一致性。
Mina 如果想启用日志跟踪Mina 的运行细节,你可以配置LoggingFilter 过滤器,这样你可
以看到Session 建立、打开、空闲等一系列细节在日志中输出,默认SJF4J 是按照DEBUG
级别输出跟踪信息的,如果你想给某一类别的Mina 运行信息输出指定日志输出级别,可以
调用LoggingFilter 的setXXXLogLevel(LogLevel.XXX)。

例:
LoggingFilter lf = new LoggingFilter();
lf.setSessionOpenedLogLevel(LogLevel.ERROR);
acceptor.getFilterChain().addLast("logger", lf);
这里IoSession 被打开的跟踪信息将以ERROR 级别输出到日志。
_______________________________________________________________________________
5.过滤器:
前面我们看到了LoggingFilter、ProtocolCodecFilter 两个过滤器,一个负责日志输出,
一个负责数据的编解码,通过最前面的Mina 执行流程图,在IoProcessor 与IoHandler 之
间可以有很多的过滤器,这种设计方式为你提供可插拔似的扩展功能提供了非常便利的方
式,目前的Apache CXF、Apache Struts2 中的拦截器也都是一样的设计思路。
Mina 中的IoFilter 是单例的,这与CXF、Apache Struts2 没什么区别。
IoService 实例上会绑定一个DefaultIoFilterChainBuilder 实例,
DefaultIoFilterChainBuilder 会把使用内部的EntryImpl 类把所有的过滤器按照顺序连在
一起,组成一个过滤器链。
DefaultIoFilterChainBuilder 类如下常用的方法:
A. void addFirst(String name,IoFilter filter):
这个方法把过滤器添加到过滤器链的头部,头部就是IoProcessor 之后的第一个过滤器。同
样的addLast()方法把过滤器添加到过滤器链的尾部。
B. void addBefore(String baseName,String name,IoFilter filter):
这个方法将过滤器添加到baseName 指定的过滤器的前面,同样的addAfter()方法把过滤器
添加到baseName 指定的过滤器的后面。这里要注意无论是那种添加方法,每个过滤器的名
字(参数name)必须是唯一的。
C. IoFilter remove(Stirng name):
这个方法移除指定名称的过滤器,你也可以调用另一个重载的remove()方法,指定要移除
的IoFilter 的类型。
D. List<Entry> getAll():
这个方法返回当前IoService 上注册的所有过滤器。
默认情况下,过滤器链中是空的,也就是getAll()方法返回长度为0 的List,但实际Mina
内部有两个隐藏的过滤器:HeadFilter、TailFilter,分别在List 的最开始和最末端,很
明显,TailFilter 在最末端是为了调用过滤器链之后,调用IoHandler。但这两个过滤器对
你来说是透明的,可以忽略它们的存在。
编写一个过滤器很简单,你需要实现IoFilter 接口,如果你只关注某几个方法,可以继承
IoFilterAdapter 适配器类。IoFilter 接口中主要包含两类方法,一类是与IoHandler 中的
方法名一致的方法,相当于拦截IoHandler 中的方法,另一类是IoFilter 的生命周期回调
方法,这些回调方法的执行顺序和解释如下所示:

(1.)init()在首次添加到链中的时候被调用,但你必须将这个IoFilter 用
ReferenceCountingFilter 包装起来,否则init()方法永远不会被调用。
(2.)onPreAdd()在调用添加到链中的方法时被调用,但此时还未真正的加入到链。
(3.)onPostAdd()在调用添加到链中的方法后被调,如果在这个方法中有异常抛出,则过滤
器会立即被移除,同时destroy()方法也会被调用(前提是使用ReferenceCountingFilter
包装)。
(4.)onPreRemove()在从链中移除之前调用。
(5.)onPostRemove()在从链中移除之后调用。
(6.)destory()在从链中移除时被调用,使用方法与init()要求相同。
无论是哪个方法,要注意必须在实现时调用参数nextFilter 的同名方法,否则,过滤器链
的执行将被中断,IoHandler 中的同名方法一样也不会被执行,这就相当于Servlet 中的
Filter 必须调用filterChain.doFilter(request,response)才能继续前进是一样的道理。

转载于:https://my.oschina.net/chenleijava/blog/134170

Mina的TCP的主要接口相关推荐

  1. java: java mina ——基于TCP/IP、UDP/IP协议栈的通信框架

    Apache Mina Server 是一个网络通信应用框架,也就是说,它主要是对基于TCP/IP.UDP/IP协议栈的通信框架(当然,也可以提供JAVA 对象的序列化服务.虚拟机管道通信服务等),M ...

  2. java mina tcp_Mina TCP服务端客户端 示例

    服务端代码:package com.xd.nms.example; import java.io.IOException; import java.net.InetSocketAddress; imp ...

  3. TCP/IP:接口的一些总结

    1.接口的种类 透明接口(access.trunk).路由接口(子接口,普通物理口).Vlan口 2.透明接口 1.前提知识: 透明接口是属于二层接口,也就是说是不需要IP寻址的,所以这种接口自身也是 ...

  4. 图文详解mina框架

    Apache Mina Server 是一个网络通信应用框架,也就是说,它主要是对基于TCP/IP.UDP/IP协议栈的通信框架(当然,也可以提供JAVA 对象的序列化服务.虚拟机管道通信服务等),M ...

  5. java mina长连接短连接_MINA实现TCP长连接(四)——断开重连

    前言 今天涉及以下内容: mina官网及实现客户端需要的jar包 客户端实现重连接涉及到的几个类 重连接在Activity中的使用 效果图和项目结构图 重连接涉及到的类源码 先来波效果图 image. ...

  6. TCP发送接口(如send(),write()等)的返回值与成功发送到接收端的数据量无直接关系

    1. TCP发送接口:send() TCP发送数据的接口有send,write,sendmsg.在系统内核中这些函数有一个统一的入口,即sock_sendmsg().由于TCP是可靠传输,所以对TCP ...

  7. linux tcp socket 接收的字节数与发送的字节数不符,TCP发送接口(如send(),write()等)的返回值与成功发送到接收端的数据量无直接关系...

    1. TCP发送接口:send() TCP发送数据的接口有send,write,sendmsg.在系统内核中这些函数有一个统一的入口,即sock_sendmsg().由于TCP是可靠传输,所以对TCP ...

  8. Apache Mina开发手册

    作者:chszs,转载需注明.博客主页:http://blog.csdn.net/chszs 一.介绍 Apache Mina是一个网络应用框架,简化用户开发高性能.高可扩展性的网络应用程序的难度.M ...

  9. Mina网络通信框架

    认识 Mina Apache Mina Server 是一个网络通信应用框架,与 Netty 出自同一作者,Netty 借鉴了部分 Mina 的设计思路. Mina 主要是对基于 TCP/IP.UDP ...

最新文章

  1. linux调试C++错误: 程序中有游离的‘\240’‘\302’
  2. HDU4587(割点+最大连通分量)
  3. ServiceLoader跟DriverManager使用总结
  4. 配置ftp服务器亲测可用
  5. [转]处理程序“PageHandlerFactory-Integrated”在其模块列表中有一个错误模块“ManagedPipelineHandler”...
  6. JAVA进阶开发之(内部类概述)
  7. python实现决策树ID3算法
  8. 第五章 字符串字面量---一个特殊的数组
  9. 如何将符号保存到php数据库当中并且打印出来!
  10. 怎么看懂计算机代码,程序员如何看懂别人的代码(干货,实用)
  11. Rplidar A2M8屏蔽角度
  12. jsp超链接中怎么跳转页面跳转_JSP跳转页面汇总
  13. jxd android 4.1刷机包,金星JXD V3固件
  14. 蜜瓜文案:水果蜜瓜文案短句,水果店蜜瓜发朋友圈文案
  15. 动态渲染页面的爬取(项目案例:爬取今日头条热点新闻)
  16. MATLAB S-function(教程分享) 报错 flag = 3(output), at time 0.0. 输入参数的数目不足。
  17. 聊一聊世界杯里的数学知识
  18. 设计初学者必学之AI图形描边:宽度工具与画笔工具
  19. 音频小波去噪(sym8和db)后语谱图对比标注
  20. WebGoat 网安攻击模拟操训

热门文章

  1. 在线字符串长度计算,字符串统计工具
  2. 高性能爬虫原理与应用
  3. [WM C++]从资源文件中加载显示png/jpg图片
  4. 3Eclipse的下载、安装、配置
  5. WDS系列之四:自定义安装映像
  6. 剑指 Offer II 055. 二叉搜索树迭代器
  7. 面试题51. 数组中的逆序对
  8. 堆排序时间复杂度_leetcode刷题(二):排序算法(归并排序,堆排序,桶排序)...
  9. 加入域时出现以下错误 登陆失败 该目标账户名称不正确_Windows 10 20H1新加入的这些功能,你应该用得上...
  10. 游戏中的数学与物理学 第二版_在数学课堂中适度开展游戏活动,可以提高课堂教学效率...