【Apache Mina2.0开发之二】自定义实现Server/Client端的编解码工厂（自定义编码与解码器）！

最新推荐文章于 2018-05-16 14:51:51 发布
最新推荐文章于 2018-05-16 14:51:51 发布
阅读量576 收藏
点赞数
分类专栏： 框架技术

本站文章均为 李华明Himi 原创,转载务必在明显处注明：
转载自【黑米GameDev街区】 原文链接: http://www.himigame.com/apache-mina/839.html

　　　　　　　　　　☞ 点击订阅 ☜ 本博客最新动态!及时将最新博文通知您！

在上一篇博文中已经简单介绍过“过滤器”的概念，那么在Mina 中的协议编解码器通过过滤器 ProtocolCodecFilter 构造,这个过滤器的构造方法需 要一个 ProtocolCodecFactory,这从前面注册 TextLineCodecFactory 的代码就可以看出来。 ProtocolCodecFactory 中有如下两个方法:

public interface ProtocolCodecFactory {

ProtocolEncoder getEncoder(IoSession session) throws Exception;

ProtocolDecoder getDecoder(IoSession session) throws Exception;

}

因此,构建一个 ProtocolCodecFactory 需要 ProtocolEncoder、ProtocolDecoder 两个实例。你可能要问 JAVA 对象和二进制数据之间如何转换呢?这个要依据具体的通信协议,也就是 Server 端要和 Client 端约定网络传输的数据是什么样的格式,譬如:第一个字节表示数据 长度,第二个字节是数据类型,后面的就是真正的数据(有可能是文字、有可能是图片等等), 然后你可以依据长度从第三个字节向后读,直到读取到指定第一个字节指定长度的数据。

简单的说,HTTP 协议就是一种浏览器与 Web 服务器之间约定好的通信协议,双方按照指定 的协议编解码数据。我们再直观一点儿说,前面一直使用的 TextLine 编解码器就是在读取 网络上传递过来的数据时,只要发现哪个字节里存放的是 ASCII 的 10、13 字符(\r、\n), 就认为之前的字节就是一个字符串(默认使用 UTF-8 编码)。

以上所说的就是各种协议实际上就是网络七层结构中的应用层协议,它位于网络层(IP)、 传输层(TCP)之上,Mina 的协议编解码器就是让你实现一套自己的应用层协议栈。

首先我们创建一个传递的对象类：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
package com.entity;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
 
import org.hibernate.annotations.Index;
 
/**
  * @author Himi
  */
@Entity
@Table (name = "playerAccount" )
public class PlayerAccount_Entity {
 
     private int id;
     private String name;
     private String emailAdress;
     private int sex; // 0=man 1=woman
 
     @Id
     @Column (name = "playerAccountID" )
     @GeneratedValue (strategy = GenerationType.AUTO)
     public int getId() {
         return id;
     }
 
     public void setId( int id) {
         this .id = id;
     }
 
     @Index (name= "nameIndex" )
     public String getName() {
         return name;
     }
 
     public void setName(String name) {
         this .name = name;
     }
 
     public String getEmailAdress() {
         return emailAdress;
     }
 
     public void setEmailAdress(String emailAdress) {
         this .emailAdress = emailAdress;
     }
 
     public int getSex() {
         return sex;
     }
 
     public void setSex( int sex) {
         this .sex = sex;
     }
 
}

2. 创建一个编码类：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
package com.protocol;
/**
  * @author Himi
  */
 
import java.nio.charset.Charset;
import java.nio.charset.CharsetEncoder;
 
import org.apache.mina.core.buffer.IoBuffer;
import org.apache.mina.core.session.IoSession;
import org.apache.mina.filter.codec.ProtocolEncoderAdapter;
import org.apache.mina.filter.codec.ProtocolEncoderOutput;
 
import com.entity.PlayerAccount_Entity;
 
public class HEncoder extends ProtocolEncoderAdapter {
 
     private final Charset charset;
 
     public HEncoder(Charset charset) {
         this .charset = charset;
 
     }
 
     @Override
     public void encode(IoSession arg0, Object arg1, ProtocolEncoderOutput arg2)
             throws Exception {
 
         CharsetEncoder ce = charset.newEncoder();
 
         PlayerAccount_Entity paEntity = (PlayerAccount_Entity) arg1;
         String name = paEntity.getName();
 
         IoBuffer buffer = IoBuffer.allocate( 100 ).setAutoExpand( true );
         buffer.putString(name, ce);
         buffer.flip();
         arg2.write(buffer);
 
     }
 
}

在 Mina 中编写编码器可以实现 ProtocolEncoder,其中有 encode()、dispose()两个方法需 要实现。这里的 dispose()方法用于在销毁编码器时释放关联的资源,由于这个方法一般我 们并不关心,所以通常我们直接继承适配器 ProtocolEncoderAdapter。

3.创建一个解码类：

[java] view plain copy
  1. package com.protocol;  
  2. /** 
  3.  * @author Himi 
  4.  */  
  5. import java.nio.charset.Charset;  
  6. import java.nio.charset.CharsetDecoder;  
  7.    
  8. import org.apache.mina.core.buffer.IoBuffer;  
  9. import org.apache.mina.core.session.IoSession;  
  10. import org.apache.mina.filter.codec.CumulativeProtocolDecoder;  
  11. import org.apache.mina.filter.codec.ProtocolDecoderOutput;  
  12.    
  13. import com.entity.PlayerAccount_Entity;  
  14.    
  15. public class HDecoder extends CumulativeProtocolDecoder {  
  16.    
  17.     private final Charset charset;  
  18.    
  19.     public HDecoder(Charset charset) {  
  20.         this.charset = charset;  
  21.    
  22.     }  
  23.    
  24.     @Override  
  25.     protected boolean doDecode(IoSession arg0, IoBuffer arg1,  
  26.             ProtocolDecoderOutput arg2) throws Exception {  
  27.         CharsetDecoder cd = charset.newDecoder();  
  28.    
  29.         String name = arg1.getString(cd);   
  30.    
  31.         PlayerAccount_Entity paEntity = new PlayerAccount_Entity();  
  32.         paEntity.setName(name);   
  33.    
  34.         arg2.write(paEntity);  
  35.         return true;  
  36.     }  
  37.    
  38. }  


在 Mina 中编写解码器,可以实现 ProtocolDecoder 接口,其中有 decode()、finishDecode()、 dispose()三个方法。这里的 finishDecode()方法可以用于处理在 IoSession 关闭时剩余的 读取数据,一般这个方法并不会被使用到,除非协议中未定义任何标识数据什么时候截止 的约定,譬如:Http 响应的 Content-Length 未设定,那么在你认为读取完数据后,关闭 TCP 连接(IoSession 的关闭)后,就可以调用这个方法处理剩余的数据,当然你也可以忽略调 剩余的数据。同样的,一般情况下,我们只需要继承适配器 ProtocolDecoderAdapter,关 注 decode()方法即可。

但前面说过解码器相对编码器来说,最麻烦的是数据发送过来的规模,以聊天室为例,一个 TCP 连接建立之后,那么隔一段时间就会有聊天内容发送过来,也就是 decode()方法会被往 复调用,这样处理起来就会非常麻烦。那么 Mina 中幸好提供了 CumulativeProtocolDecoder 类,从名字上可以看出累积性的协议解码器,也就是说只要有数据发送过来,这个类就会去 读取数据,然后累积到内部的 IoBuffer 缓冲区,但是具体的拆包(把累积到缓冲区的数据 解码为 JAVA 对象)交由子类的 doDecode()方法完成,实际上 CumulativeProtocolDecoder 就是在 decode()反复的调用暴漏给子类实现的 doDecode()方法。

具体执行过程如下所示:

A. 你的 doDecode()方法返回 true 时,CumulativeProtocolDecoder 的 decode()方法会首先判断你是否在 doDecode()方法中从内部的 IoBuffer 缓冲区读取了数据,如果没有,ce); buffer.putString(smsContent, ce);buffer.flip();则会抛出非法的状态异常,也就是你的 doDecode()方法返回 true 就表示你已经消费了 本次数据(相当于聊天室中一个完整的消息已经读取完毕),进一步说,也就是此时你 必须已经消费过内部的 IoBuffer 缓冲区的数据(哪怕是消费了一个字节的数据)。如果 验证过通过,那么 CumulativeProtocolDecoder 会检查缓冲区内是否还有数据未读取, 如果有就继续调用 doDecode()方法,没有就停止对 doDecode()方法的调用,直到有新 的数据被缓冲。

B. 当你的 doDecode()方法返回 false 时,CumulativeProtocolDecoder 会停止对 doDecode() 方法的调用,但此时如果本次数据还有未读取完的,就将含有剩余数据的 IoBuffer 缓 冲区保存到 IoSession 中,以便下一次数据到来时可以从 IoSession 中提取合并。如果 发现本次数据全都读取完毕,则清空 IoBuffer 缓冲区。简而言之,当你认为读取到的数据已经够解码了,那么就返回 true,否则就返回 false。这 个 CumulativeProtocolDecoder 其实最重要的工作就是帮你完成了数据的累积,因为这个工 作是很烦琐的。

4.创建一个编解码工厂类：

[java] view plain copy
  1. package com.protocol;  
  2.    
  3. import java.nio.charset.Charset;  
  4.    
  5. import org.apache.mina.core.session.IoSession;  
  6. import org.apache.mina.filter.codec.ProtocolCodecFactory;  
  7. import org.apache.mina.filter.codec.ProtocolDecoder;  
  8. import org.apache.mina.filter.codec.ProtocolEncoder;  
  9. /** 
  10.  * 
  11.  * @author Himi 
  12.  * 
  13.  */  
  14. public class HCoderFactory implements ProtocolCodecFactory {  
  15.    
  16.     private final HEncoder encoder;  
  17.     private final HDecoder decoder;  
  18.    
  19.     public HCoderFactory() {  
  20.         this(Charset.defaultCharset());  
  21.     }  
  22.    
  23.     public HCoderFactory(Charset charSet) {  
  24.         this.encoder = new HEncoder(charSet);  
  25.         this.decoder = new HDecoder(charSet);  
  26.     }  
  27.    
  28.     @Override  
  29.     public ProtocolDecoder getDecoder(IoSession arg0) throws Exception {  
  30.         // TODO Auto-generated method stub  
  31.         return decoder;  
  32.     }  
  33.    
  34.     @Override  
  35.     public ProtocolEncoder getEncoder(IoSession arg0) throws Exception {  
  36.         // TODO Auto-generated method stub  
  37.         return encoder;  
  38.     }  
  39.    
  40. }  


这个工厂类就是包装了编码器、解码器,通过接口中的 getEncoder()、getDecoder() 方法向 ProtocolCodecFilter 过滤器返回编解码器实例,以便在过滤器中对数据进行编解码 处理。

5. 以上3个编解码有关的类在Server与Client读需要有，那么同时我们创建好了自定义的编解码有关的类后，我们设置Server和Client的编码工厂为我们自定义的编码工厂类：

1
DefaultIoFilterChainBuilder chain = acceptor.getFilterChain();      chain.addLast( "mycoder" , new ProtocolCodecFilter( new HCoderFactory(             Charset.forName( "UTF-8" ))));

 

6.书写测试的消息处理器类Client和Server端；

Client端消息处理器： 

[java] view plain copy
  1. /** 
  2.  * @author Himi 
  3.  */  
  4.    
  5. import org.apache.mina.core.service.IoHandlerAdapter;  
  6. import org.apache.mina.core.session.IoSession;  
  7.    
  8. import com.protocol.PlayerAccount_Entity;  
  9.    
  10. public class ClientMainHanlder extends IoHandlerAdapter {  
  11.     // 当一个客端端连结到服务器后  
  12.     @Override  
  13.     public void sessionOpened(IoSession session) throws Exception {  
  14.         PlayerAccount_Entity ho = new PlayerAccount_Entity();  
  15.         ho.setName("李华明 xiaominghimi@gmail.com");  
  16.         session.write(ho);  
  17.     }  
  18.    
  19.     // 当一个客户端关闭时  
  20.     @Override  
  21.     public void sessionClosed(IoSession session) {  
  22.         System.out.println("I'm Client &&  I closed!");  
  23.     }  
  24.    
  25.     // 当服务器端发送的消息到达时:  
  26.     @Override  
  27.     public void messageReceived(IoSession session, Object message)  
  28.             throws Exception {  
  29.         PlayerAccount_Entity ho = (PlayerAccount_Entity) message;  
  30.         System.out.println("Server Say:name:" + ho.getName());  
  31.     }  
  32. }  


Server端消息处理器：

[java] view plain copy
  1. /** 
  2.  * @author Himi 
  3.  */  
  4.    
  5. import org.apache.mina.core.service.IoHandlerAdapter;  
  6. import org.apache.mina.core.session.IdleStatus;  
  7. import org.apache.mina.core.session.IoSession;  
  8.    
  9. import com.entity.PlayerAccount_Entity;  
  10. import com.sessionUtilities.HibernateUtil;  
  11.    
  12. public class MainHanlder extends IoHandlerAdapter {  
  13.    
  14.     private int count = 0;  
  15.    
  16.     // 当一个新客户端连接后触发此方法.  
  17.     /* 
  18.      * 这个方法当一个 Session 对象被创建的时候被调用。对于 TCP 连接来说,连接被接受的时候 调用,但要注意此时 TCP 
  19.      * 连接并未建立,此方法仅代表字面含义,也就是连接的对象 IoSession 被创建完毕的时候,回调这个方法。 对于 UDP 
  20.      * 来说,当有数据包收到的时候回调这个方法,因为 UDP 是无连接的。 
  21.      */  
  22.     public void sessionCreated(IoSession session) {  
  23.         System.out.println("新客户端连接");  
  24.     }  
  25.    
  26.     // 当一个客端端连结进入时 @Override  
  27.     /* 
  28.      * 这个方法在连接被打开时调用,它总是在 sessionCreated()方法之后被调用。对于 TCP 来 
  29.      * 说,它是在连接被建立之后调用,你可以在这里执行一些认证操作、发送数据等。 对于 UDP 来说,这个方法与 
  30.      * sessionCreated()没什么区别,但是紧跟其后执行。如果你每 隔一段时间,发送一些数据,那么 
  31.      * sessionCreated()方法只会在第一次调用,但是 sessionOpened()方法每次都会调用。 
  32.      */  
  33.     public void sessionOpened(IoSession session) throws Exception {  
  34.         count++;  
  35.         System.out.println("第 " + count + " 个 client 登陆！address： : "  
  36.                 + session.getRemoteAddress());  
  37.    
  38.     }  
  39.    
  40.     // 当客户端发送的消息到达时:  
  41.     /* 
  42.      * 对于 TCP 来说,连接被关闭时,调用这个方法。 对于 UDP 来说,IoSession 的 close()方法被调用时才会毁掉这个方法。 
  43.      */  
  44.     @Override  
  45.     public void messageReceived(IoSession session, Object message)  
  46.             throws Exception {  
  47.         // // 我们己设定了服务器解析消息的规则是一行一行读取,这里就可转为String:  
  48.         // String s = (String) message;  
  49.         // // Write the received data back to remote peer  
  50.         // System.out.println("收到客户机发来的消息: " + s);  
  51.         // // 测试将消息回送给客户端 session.write(s+count); count++;  
  52.    
  53.         PlayerAccount_Entity ho = (PlayerAccount_Entity) message;  
  54.         System.out.println("Client Say:" + ho.getName());  
  55.    
  56.         ho.setName("Himi  317426208@qq.com");  
  57.         session.write(ho);  
  58.    
  59.     }  
  60.    
  61.     // 当信息已经传送给客户端后触发此方法.  
  62.     /* 
  63.      * 当发送消息成功时调用这个方法,注意这里的措辞,发送成功之后,也就是说发送消息是不 能用这个方法的。 
  64.      */  
  65.     @Override  
  66.     public void messageSent(IoSession session, Object message) {  
  67.         System.out.println("信息已经传送给客户端");  
  68.    
  69.     }  
  70.    
  71.     // 当一个客户端关闭时  
  72.     /* 
  73.      * 对于 TCP 来说,连接被关闭时,调用这个方法。 对于 UDP 来说,IoSession 的 close()方法被调用时才会毁掉这个方法。 
  74.      */  
  75.     @Override  
  76.     public void sessionClosed(IoSession session) {  
  77.         System.out.println("one Clinet Disconnect !");  
  78.     }  
  79.    
  80.     // 当连接空闲时触发此方法.  
  81.     /* 
  82.      * 这个方法在 IoSession 的通道进入空闲状态时调用,对于 UDP 协议来说,这个方法始终不会 被调用。 
  83.      */  
  84.     @Override  
  85.     public void sessionIdle(IoSession session, IdleStatus status) {  
  86. //      System.out.println("连接空闲");  
  87.     }  
  88.    
  89.     // 当接口中其他方法抛出异常未被捕获时触发此方法  
  90.     /* 
  91.      * 这个方法在你的程序、Mina 自身出现异常时回调,一般这里是关闭 IoSession。 
  92.      */  
  93.     @Override  
  94.     public void exceptionCaught(IoSession session, Throwable cause) {  
  95.         System.out.println("其他方法抛出异常");  
  96.     }  
  97.    
  98. }  


OK，首先启动Server端，然后运行Client端，观察控制台：

可口可乐的围脖
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Apache-Mina-Server-2.0中文参考手册V1.0.docx
09-19
Apache Mina Server 2.0 是一个用于构建高性能网络通信应用的框架，它专注于TCP/IP和UDP/IP协议栈，同时也支持JAVA对象的序列化和Java虚拟机内部通信。Mina的核心优势在于其事件驱动和异步操作的编程模型，这得益于...
Mina2.0自定义实现Server/Client端的编解码工厂
毅个混蛋的专栏
10-26 1979
在上一篇博文中已经简单介绍过“过滤器”的概念，那么在Mina 中的协议编解码器通过过滤器 ProtocolCodecFilter 构造,这个过滤器的构造方法需 要一个 ProtocolCodecFactory,这从前面注册 TextLineCodecFactory 的代码就可以看出来。 ProtocolCodecFactory 中有如下两个方法: public interface Proto
自定义Mina编解码器
Lee的博客
03-29 3471
协议编解码器是在使用Mina 的时候最需要关注的对象，因为网络传输的数据都是二进制数据（byte），而在程序中面向的是JAVA 对象，这就需要在发送数据时将JAVA 对象编码二进制数据，接收数据时将二进制数据解码为JAVA 对象。 编解码器同样是以过滤器的形式安插在过滤器链上，如下所示： // 设置过滤器（使用Mina提供的文本换行符编解码器） acceptor.getFilterChain
转：模拟Mina2的TextLineCodecFactory中的TextLineDecoder解码器
redsky200905的专栏
06-21 442
转自：http://hi.baidu.com/huahua035/blog/item/f41f104ff73b0b19b3de05a4.html 模拟Mina2的TextLineCodecFactory中的TextLineDecoder解码器 Mina2中已经提供了TextLine解码的方式----根据文本的换行符进行解码； 注意这里的文本换行符是和操作系统相关的，比如windows...
MINA源码分析---协议编码解码器工厂ProtocolCodecFactory接口
佳颖的专栏
12-07 4213
1、具体的解码器，编码器需要自己根据协议实现 2、实现协议编码解码器工厂ProtocolCodecFactory接口，在里面主要的工作就是创建解码器，编码器实例，并且返回实例 下面贴出三个接口的源码,读者只需要实现这三个接口即可 package org.apache.mina.filter.codec; import org.apache.mina.core.session.IoSess
mina+webSocket 搭建兼容各版本浏览器无刷新评论实例
k_769915435的专栏
08-13 8235
webSocket是html5的东西，目前还有好多浏览器是不兼容的，
Apache Mina Server 2.0 中文参考手册(带目录)
02-09
Mina的网络通信分为Server端和Client端，两者在通信结构中的位置是相同的，都利用了Mina的API进行封装，简化了通信编程。无论服务端还是客户端，Mina的执行流程都可以归纳为以下步骤： - 创建IoService实例，对于...
mina：Apache MINA的镜像
02-03
开发者可以创建自定义过滤器来处理输入和输出数据，执行如编码、解码、压缩、加密等操作。过滤器之间通过调用`doFilter()`方法进行通信，形成一个处理流水线。 3. **会话管理**：MINA提供了会话对象，代表了与...
Apache_Mina_Server中文参考手册.pdf
01-06
此外，Mina还提供了一种高度灵活的扩展方式，允许开发者自定义过滤器来实现特定的网络通信功能，比如数据加密、协议特定的编解码等。 在使用Mina进行网络通信开发时，开发者必须具备Java编程基础，特别是需要熟悉...
mina自定义编解码器详解
01-27
许多刚接触mina的朋友，对于mina的编解码器的编写很迷惑.希望这个文档可以帮助朋友们少走弯路。 资源中是一个比较典型的编解码器写法。生成了可执行文件。并对编解码器的代码有详细注释。
mina自定义编码解码器
04-05
NULL 博文链接：https://thb143.iteye.com/blog/1538083
mina编解码示例
12-28
这个代码，在mina框架中，实现了编码解码，包含了服务器端发送数据的代码和作为客户端接收数据的代码。
java使用mina和websocket通信
weixin_34381666的博客
08-29 1897
2019独角兽企业重金招聘Python工程师标准>>> ...
Mina Codec Filter对应协议实现编解码处理
纸上得来终觉浅，绝知此事要躬行
06-07 5407
原文地址：Mina Filter(Apache Mina user guide Chapter 9 Codec Filter) 本教程试图解释为什么以及如何使用ProtocolCodecFilter. 1.1.1. 为什么使用ProtocolCodecFilter TCP 保证交付的所有数据包以正确的顺序。但是不能保证服务端发送方的写操作会导致一个接收端读取事件。参见：http://en.w
基于mina的websocket初步实现
u014279471的专栏
03-22 4042
package com.codecronch.util.net.websocket; 　　import java.security.MessageDigest; 　　import java.util.regex.Matcher; 　　import java.util.regex.Pattern; 　　import org.apache.mina.core.buffer.IoBuffer;
Apache MINA实战之 对象传输
new is I
04-28 146
本文链接：http://blog.csdn.net/kongxx/article/details/7520599 利用Apache MINA来传递对象，这对了MINA来说非常容易，并且这也是Java网络编程中很常用的应用。其实对于MINA传递对象来说，如果看过前一篇文章的话，只要在其中做少许改动就可以实现对象传递，但这里考虑到例子的完整性，还是给出了全部代码示例。 首先看两个用来传递的Java对...
Mina的WebSocket问题排查
weixin_34205076的博客
05-16 428
转载请注明文章出处： tlanyan.me/resolve-min… 项目的客户端需要重构，探讨后决定客户端与服务器的交互使用WebSocket协议。后端的网络层框架是Mina，在现有基础上增加对WebSocket的解析即可完成无缝迁移。正好Apache讨论组上有人提供Mina的WebSocket过滤器代码。下载后添加到项目，扔到服务器上一切正常。 今天前端同事反馈说请求某个接口会导致客户端立...
Apache Mina 2.0开发指南：服务器与客户端详解
Apache Mina Server 2.0 是一个强大的网络通信应用框架，专为Java开发者设计，用于构建高性能、高扩展性的网络应用程序。该框架主要关注TCP/IP和UDP/IP协议栈的底层通信，同时也支持JAVA对象序列化和虚拟机管道通信...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值