深入解析Apache Mina源码(1)——Mina的过滤器机制实现

一、责任链模式的本来面目

Mina 中有一个重要的设计模式-责任链模式，它将此模式成功的应用在了它的过滤器链（IoFilterChain）中。开发过J2EE的童鞋们应该对这个模式比较清楚，在Servlet中我们就可以加入Filter的实现，还有Hibernate中也实现了FilterChain。学习怎么实现责任链模式对于我们对开源软件的学习和以后的工作都会有莫大的帮助。

我们知道计算机系统就是接收信息，进行信息处理，信息输出的过程，那么在这个过程中我们加入过滤器有很多好处，消息经过特定功能的多个过滤器进行逐步处理得到所需要的最终信息，让处理过程透明，责任明晰，方便扩展。

责任链模式的定义我也就不说了，网上一大堆，我的理解是可以把它理解成一个有向链表，消息在这个链表中的某个过滤器进行处理然后再传向下个过滤器，在每个过滤器中都可以处理这些消息，也可以不处理。如图：

责任链模式的类图如下：

其实这里面最核心的就是Handler了，它可是是一个接口或者是一个抽象类，它有对自己的一个引用successor，然后有个处理方法HandleRequest()。因为有了对自己的引用successor所以当本对象不能处理的时候可以转向successor.HandleRequest()方法，这样一个“链”就形成了。

你应该挺羡慕富士.康里面生产苹果手机的工人吧，你平时最喜欢的苹果手机就是他们生产出来的，他们一个人就能把苹果手机生产出来吗？不是的，他们是流水线做业的，OK，流水线就可以看做是责任链模式的体现，工人就是链条上的一员，有的工人组装屏幕，有的工人检查手机，有的工人进行手机的包装等，下面我们就以代码的方式实现：

苹果手机类：

Java代码

1. 1. 
      
2. package com.lifanghu.chain;
3. 
   
4. /**
5. * @author lifh
6. * @mail [e-mail]
7. * @since 2012-6-12 下午11:20:18
8. * @name com.lifanghu.chain.Iphone.java
9. * @version 1.0
10. */
11. 
    
12. public class Iphone {
13. 
    
14. private String state = "我是一台苹果机器；";
15. 
    
16. public String getState() {
17. return state;
18. }
19. 
    
20. public void setState(String state) {
21. this.state = state;
22. }
23. 
    
24. }
    1. 
       

抽象处理接口类：

Java代码

1. 1. 
      
2. package com.lifanghu.chain;
3. 
   
4. 
   
5. 
   
6. /**
7. * @author lifh
8. * @mail [e-mail]
9. * @since 2012-6-12 下午11:23:36
10. * @name com.lifanghu.chain.IWorker.java
11. * @version 1.0
12. */
13. 
    
14. public interface IWorker {
15. 
    
16. /**
17. * 处理方法
18. * @param iphone
19. * @author lifh
20. */
21. void handleIphone(Iphone iphone);
22. /**
23. * 设置下一个处理者
24. * @param worker
25. * @author lifh
26. */
27. void setNext(IWorker worker);
28. }
    1. 
       

具体处理者：

Java代码

1. 1. 
      
2. package com.lifanghu.chain;
3. 
   
4. /**
5. * @author lifh
6. * @mail [e-mail]
7. * @since 2012-6-12 下午11:29:46
8. * @name com.lifanghu.chain.Worker1.java
9. * @version 1.0
10. */
11. 
    
12. public class Worker1 implements IWorker {
13. 
    
14. private IWorker next;
15. 
    
16. public void handleIphone(Iphone iphone) {
17. iphone.setState(iphone.getState() + "我被装了一个黑色的后盖；");
18. if (next != null)
19. next.handleIphone(iphone);
20. }
21. 
    
22. public void setNext(IWorker worker) {
23. this.next = worker;
24. 
    
25. }
26. 
    
27. }
28. package com.lifanghu.chain;
29. 
    
30. /**
31. * @author lifh
32. * @mail [e-mail]
33. * @since 2012-6-12 下午11:34:32
34. * @name com.lifanghu.chain.Worker2.java
35. * @version 1.0
36. */
37. 
    
38. public class Worker2 implements IWorker {
39. 
    
40. private IWorker next;
41. 
    
42. public void handleIphone(Iphone iphone) {
43. iphone.setState(iphone.getState() + "我被装了一块电池；");
44. if (next != null)
45. next.handleIphone(iphone);
46. }
47. 
    
48. public void setNext(IWorker worker) {
49. this.next = worker;
50. }
51. }
52. package com.lifanghu.chain;
53. 
    
54. /**
55. * @author lifh
56. * @mail [e-mail]
57. * @since 2012-6-12 下午11:34:32
58. * @name com.lifanghu.chain.Worker3.java
59. * @version 1.0
60. */
61. 
    
62. public class Worker3 implements IWorker {
63. 
    
64. private IWorker next;
65. 
    
66. public void handleIphone(Iphone iphone) {
67. iphone.setState(iphone.getState() + "我现在是一台完整的Iphone了。");
68. if (next != null)
69. next.handleIphone(iphone);
70. }
71. 
    
72. public void setNext(IWorker worker) {
73. this.next = worker;
74. }
75. }
    1. 
       

客户端调用者：

Java代码

1. 1. 
      
2. package com.lifanghu.chain;
3. 
   
4. /**
5. * @author lifh
6. * @mail [e-mail]
7. * @since 2012-6-12 下午11:37:27
8. * @name com.lifanghu.chain.Client.java
9. * @version 1.0
10. */
11. 
    
12. public class Client {
13. 
    
14. public static void main(String[] args) {
15. IWorker worker1 = new Worker1();
16. IWorker worker2 = new Worker2();
17. IWorker worker3 = new Worker3();
18. 
    
19. worker1.setNext(worker2);
20. worker2.setNext(worker3);
21. Iphone iphone = new Iphone();
22. worker1.handleIphone(iphone);
23. 
    
24. System.out.println(iphone.getState());
25. }
26. }
    1. 
       

输出结果：

写道 我是一台苹果机器；我被装了一个黑色的后盖；我被装了一块电池；我现在是一台完整的Iphone了。

好了，现在一台苹果就组装完成了，发现了没有，我们的代码比较整洁清新，没有大量的if/else语句，责任清晰明了，调用简单，想要扩展的话只需要再实现IWorker接口即可，这就是使用责任链模式的好处。

二、Mina是怎么实现责任链模式的

上面介绍了纯净的责任链模式，但是在真实的项目中写代码不可能完全照搬，所以多看看开源项目的代码写作方式也许才能真正提高我们的编程能力。就以Mina的过滤器链来看，对这种模式进行了自己的实现，但是道理是相通的，带着责任链模式的理解去看看Mina的实现是怎样的。

先看一下Mina过滤器的类图结构：

从图中我们可以看出Mina对于此模式的实现是相对比较复杂的，其实从它的代码上也可以看出来，当时也是花了好大力气才把它这块看明白，其实主要在于理清思路，抓住核心类，最主要的一个接口IoFilterChain和它的一个内部接口Entry，其中IoFilterChain代表了过滤器的容器，它本身就是一个对象引用形成的链表结构,默认的实现DefaultIoFilterChain其实有对链表头（head）的引用，找到头后就可以顺着头向下找，一直找到尾(tail),Entry是对IoFilter和NextFilter的封装整合接口，它属于链表IoFilterChain中的元素。指向当前和下一个过滤器。

EntryImpl 类中包含两个接口，filter和nextFilter，他们所用的接口是不一样的，至于为什么不用同一个接口，我想可能是因为接口职责单一的原则吧。

虽然有IoFilter和NextFilter两个接口，接口方法都差不多，但最后真正业务的执行者还是IoFilter的实现，IoFilterAdapter做为它的默认实现，完成了适配器的功能，以后的类可以直接继承它而不用实现IoFilter接口，想实现哪个方法只需要覆盖IoFilterAdapter的类的方法即可。NextFilter只起到转发的作用，如消息接收处理方法（messageReceived）：

NextFilter的实现：

Java代码

1. 1. 
      
2. //消息接收到以后NextFilter的实现会把消息传递给nextEntry去处理。
3. public void messageReceived(IoSession session, Object message) {
4. Entry nextEntry = EntryImpl.this.nextEntry;
5. callNextMessageReceived(nextEntry, session, message);
6. }
   1. 
      

DefaultIoFilterChain再将消息传递给本Filter的messageReceived方法进行实际的消息接收处理工作：

Java代码

1. 1. 
      
2. private void callNextMessageReceived(Entry entry, IoSession session,
3. Object message) {
4. try {
5. IoFilter filter = entry.getFilter();
6. NextFilter nextFilter = entry.getNextFilter();
7. //本过滤器进行数据处理，完成后再把消息传向下个过滤器
8. filter.messageReceived(nextFilter, session,
9. message);
10. } catch (Throwable e) {
11. fireExceptionCaught(e);
12. }
13. }
    1. 
       

当消息处理完成以后，消息就要进入到业务处理IoHandler的实现类中去完成业务的相关操作了。这可以在链尾看到相关业务传递：

Java代码

1. 1. 
      
2. @Override
3. public void messageReceived(NextFilter nextFilter, IoSession session, Object message) throws Exception {
4. AbstractIoSession s = (AbstractIoSession) session;
5. if (!(message instanceof IoBuffer)) {
6. s.increaseReadMessages(System.currentTimeMillis());
7. } else if (!((IoBuffer) message).hasRemaining()) {
8. s.increaseReadMessages(System.currentTimeMillis());
9. }
10. 
    
11. try {
12. // 最后一个filter会进入到handler进行消息处理。
13. session.getHandler().messageReceived(s, message);
14. } finally {
15. if (s.getConfig().isUseReadOperation()) {
16. s.offerReadFuture(message);
17. }
18. }
19. }
    1. 
       

至此，Mina的链表结构就基本讲完了，其实仔细看看它的代码还是比较容易理解的，可能里面有些细节还需要我们去琢磨。

链表建立了以后，外界是怎样调用的呢？

在org.apache.mina.core.filterchain包下我们可以看到类IoFilterEvent，可以看到它实现了基于事件的处理模型，当一个事件（比如接收到消息）发生后会触发相应的事件，进而调用过滤器链的消息处理功能进行消息的处理和转发，这块其实会有线程池的参与完成，会在以后的文章中说明这块。

Java代码

1. 1. 
      
2. public void fire() {
3. IoSession session = getSession();
4. NextFilter nextFilter = getNextFilter();
5. IoEventType type = getType();
6. 
   
7. if (DEBUG) {
8. LOGGER.debug( "Firing a {} event for session {}",type, session.getId() );
9. }
10. 
    
11. switch (type) {
12. case MESSAGE_RECEIVED:
13. //触发消息接收
14. Object parameter = getParameter();
15. nextFilter.messageReceived(session, parameter);
16. break;
    1. 
       

当然也可以直接调用：

Java代码

1. 1. 
      
2. //触发过滤器的接收消息处理
3. session.getFilterChain().fireMessageReceived(newBuf);

还有一个类DefaultIoFilterChainBuilder，它以用户更易用的角度完成了对过滤器链的封装操作，这里就不细讲了。