第五章 - 过滤器

IoFilter是MINA的重要组件之一， 它可以过滤在IoService和IoHandler的所有IO事件和请求。 如果你有Web应用程序开发经验， 你会发现它和Servlet的过滤器十分相似。MINA提供了很多可以直接使用的过滤器，这大大简化了网络应用程序的开发，例如：

    LoggingFilter：记录所有事件和请求
    ProtocolCodecFilter：把接收到的ByteBuffer里的数据转换成Java对象，会反之。      CompressionFilter：压缩数据
    SSLFilter： 添加SSL - TLS - StartTLS 支持.
    还有很多！

在本章中我们通过一个现实世界的例子来学习如何实现一个过滤器。实现一个通用的过滤器很容易，但最好还是了解一下其中的原理。所以我们还会介绍其内部的属性。

既存的过滤器

有选择的重写事件

你可以继承IoAdapter而不是直接实现IoFilter接口。除非你重写了某个方法，对应的事件会被直接指派到下一个过滤器。

public class MyFilter extends IoFilterAdapter {
    @Override
    public void sessionOpened(NextFilter nextFilter, IoSession session) throws Exception {
        // Some logic here...
        nextFilter.sessionOpened(session);
        // Some other logic here...
    }
}

转换写请求

如果你想通过IoSession.write()对请求进行转换，这需要点小技巧。例如你想在IoSession.write()传递HighLevelMessage时把HighLevelMessage转换成LowLevelMessage。你可以把转换代码放在过滤器的filterWrite()，认为这就OK了，其实你还需要重写messageSent事件处理，因为IoHandler和你的过滤器后面的其他任何过滤器会希望messageSent被调用时传递的是HighLevelMessage。这是因为如果调用者传递的是HighLevelMessage但是实际发送的是LowLevelMessage是不合理的。所以你在处理转换时必须同时重写filterWrite()和messageSent()方法。

还需要注意的是即使你的输入和输出类型是一致的情况下你也需要实现同样的机制（例如CompressionFilter）。因为IoSession.write()的调用者需要它的messageSent()方法被调用时得到的类型是完全一致的。

假设你有一个过滤器可以把字符串转换为char数组。你的过滤器的filterWrite()方法是这样：

public void filterWrite(NextFilter nextFilter, IoSession session, WriteRequest request) {
    nextFilter.filterWrite(
        session, new DefaultWriteRequest(
                ((String) request.getMessage()).toCharArray(), request.getFuture(), request.getDestination()));
}

 

那么你的messageSent()就应该是反过来的：

public void messageSent(NextFilter nextFilter, IoSession session, Object message) {
    nextFilter.messageSent(session, new String((char[]) message));
}

 

那么把字符串转换为ByteBuffer时呢？这种情况下会更有效率一些，因为我们不需要重建原始消息（String）。但是看上去要比前面的例子复杂一些。

public void filterWrite(NextFilter nextFilter, IoSession session, WriteRequest request) {
    String m = (String) request.getMessage();
    ByteBuffer newBuffer = new MyByteBuffer(m, ByteBuffer.wrap(m.getBytes());

    nextFilter.filterWrite(
            session, new WriteRequest(newBuffer, request.getFuture(), request.getDestination()));
}

public void messageSent(NextFilter nextFilter, IoSession session, Object message) {
    if (message instanceof MyByteBuffer) {
        nextFilter.messageSent(session, ((MyByteBuffer) message).originalValue);
    } else {
        nextFilter.messageSent(session, message);
    }
}

private static class MyByteBuffer extends ByteBufferProxy {
    private final Object originalValue;
    private MyByteBuffer(Object originalValue, ByteBuffer encodedValue) {
        super(encodedValue);
        this.originalValue = originalValue;
    }
}

当处理sessionCreated事件时要小心

建立会话是一个特殊的事件，必须在I/O processor的线程里进行。千万不要把sessionCreated的处理放到其他的线程里。

public void sessionCreated(NextFilter nextFilter, IoSession session) throws Exception {
    // ...
    nextFilter.sessionCreated(session);
}

// DON'T DO THIS!
public void sessionCreated(final NextFilter nextFilter, final IoSession session) throws Exception {
    Executor executor = ...;
    executor.execute(new Runnable() {
        nextFilter.sessionCreated(session);
        });
    }

小心空的缓冲区

MINA在内部使用空的Buffer来标识几种情况。 但空Buffer有些时候会造成一些问题，比如IndexOutOfBoundsException。 下面介绍如何避免这些情况。

ProtocolCodecFilter利用空Buffer(buf.hasRemaining() = 0)来表示消息的结束。 如果你的过滤器被放到ProtocolCodecFilter之前，并且在Buffer是空的时候会抛出异常。 请保证把这个空Buffer指派到下一个过滤器。

public void messageSent(NextFilter nextFilter, IoSession session, Object message) {
    if (message instanceof ByteBuffer && !((ByteBuffer) message).hasRemaining()) {
        nextFilter.messageSent(nextFilter, session, message);
        return;
    }
    ...
}

public void filterWrite(NextFilter nextFilter, IoSession session, WriteRequest request) {
    Object message = request.getMessage();
    if (message instanceof ByteBuffer && !((ByteBuffer) message).hasRemaining()) {
        nextFilter.filterWrite(nextFilter, session, request);
        return;
    }
    ...
}

 

我们需要在每一个过滤器里又加入上面的if语句吗？ 幸运的是我们不必。这里有一个针对于空Buffer的黄金法则：

    如果即时Buffer为空，你的过滤器也能正常工作就不用添加上面的if语句。
    如果你的过滤器在ProtocolCodecFilter之后被添加， 就不用添加上面的if语句。
    其他情况需要添加。

即使你需要上面这样的if语句，也不用和上面一模一样， 你可以自己定义如何检查空Buffer，只要你能保证你的Filter不会抛出非期望的异常。