输入过滤器——InputFilter

一般情况下我们通过请求体读取器InputStreamInputBuffer获取的仅仅是源数据，即未经过任何处理发送方发来的字节。但有些时候在这个读取的过程中希望做一些额外的处理，并且这些额外处理可能是根据不同条件做不同的处理，考虑到程序解耦与扩展，于是引入过滤器（过滤器模式）——输入过滤器InputFilter。在读取数据过程中对于额外的操作只需要通过添加不同的过滤器即可实现，例如添加对http1.1协议分块传输的相关操作的过滤器。
如下图，在套接字输入缓冲装置中，从操作系统底层读取的字节会缓冲在buf中，请求行和请求头部被解析后缓冲区buf的指针指向请求体起始位置，通过请求体读取器InputStreamInputBuffer可进行读取操作，它会自动判定buf是否已经读完，读完则重新从操作系统底层读取字节到buf。当其他组件从套接字输入缓冲装置读取请求体时，装置将判定是否包含过滤器，假设有则通过一层层的过滤器完成过滤操作后才能到desBuf，这个过程就像被加入了一道道处理关卡，经过关卡都会被执行相应操作，最终完成源数据到目的数据的操作。
 
过滤器是一种设计模式，在Java的各种框架及容器都有频繁地使用以达到更好的扩展性和逻辑解耦。往下用一个例子看看过滤器如何工作。
① 输入缓冲接口InputBuffer，提供读取操作：
public interface InputBuffer {
   public int doRead(byte[] chunk) throws IOException;
}


② 输入过滤器接口InputFilter，继承InputBuffer类，额外提供setBuffer方法设置前一个缓冲：
public interface InputFilter extends InputBuffer {
public void setBuffer(InputBuffer buffer);
}


③ 输入缓冲装置，模拟通过请求体读取器InputStreamInputBuffer从操作底层获取请求体字节数组，并且里面包含了若干个过滤器，缓冲装置在执行读取操作时会自动判断是否有过滤器，如存在则将读取后的字节在经过层层过滤，得到最终的目的数据。
public class InternalInputBuffer implements InputBuffer {
boolean isEnd = false; 
byte[] buf = new byte[4]; 
protected int lastActiveFilter = -1; 
protected InputFilter[] activeFilters = new InputFilter[2]; 
InputBuffer inputStreamInputBuffer = (InputBuffer) new InputStreamInputBuffer();


public void addActiveFilter(InputFilter filter) {
if (lastActiveFilter == -1) {
filter.setBuffer(inputStreamInputBuffer);
} else {
for (int i = 0; i <= lastActiveFilter; i++) {
if (activeFilters[i] == filter)
return;
}
filter.setBuffer(activeFilters[lastActiveFilter]);
}
activeFilters[++lastActiveFilter] = filter; 
}


public int doRead(byte[] chunk) throws IOException {
if (lastActiveFilter == -1)
return inputStreamInputBuffer.doRead(chunk);
else
return activeFilters[lastActiveFilter].doRead(chunk);
}




protected class InputStreamInputBuffer implements InputBuffer {
public int doRead(byte[] chunk) throws IOException {
if (isEnd == false) {
buf[0] = 'a';
buf[1] = 'b';
buf[2] = 'a';
buf[3] = 'd';
System.arraycopy(buf, 0, chunk, 0, 4);
isEnd = true;
return chunk.length;
} else {
return -1;
}
}
}
}


④ 清理过滤器ClearFilter，负责将读取的字节数组中的字符a换成f：
public class ClearFilter implements InputFilter {
protected InputBuffer buffer;


public int doRead(byte[] chunk) throws IOException {
int i = buffer.doRead(chunk);
if (i == -1)
return -1;
for (int j = 0; j < chunk.length; j++)
if (chunk[j] == 'a')
chunk[j] = 'f';
return i;
}


public InputBuffer getBuffer() {
return buffer;
}


public void setBuffer(InputBuffer buffer) {
this.buffer = buffer;
}
}


⑤ 大写过滤器UpperFilter，负责将读取的字节数组全部变成大写：
public class UpperFilter implements InputFilter {
protected InputBuffer buffer;


public int doRead(byte[] chunk) throws IOException {
int i = buffer.doRead(chunk);
if (i == -1)
return -1;
for (int j = 0; j < chunk.length; j++)
chunk[j] = (byte) (chunk[j] - 'a' + 'A');
return i;
}


public InputBuffer getBuffer() {
return buffer;
}


public void setBuffer(InputBuffer buffer) {
this.buffer = buffer;
}
}


⑥ 测试类，创建输入缓冲装置，接着创建清理过滤器和大写过滤器，把它们添加到输入缓冲装置，执行读取操作，出来的就是经过两个过滤器处理后的数据了，结果为“FBFD”，如果有其他处理需求通过实现InputFilter接口编写过滤器并添加即可。
public class Test {
public static void main(String[] args) {
InternalInputBuffer internalInputBuffer = new InternalInputBuffer();
ClearFilter clearFilter = new ClearFilter();
UpperFilter upperFilter = new UpperFilter();
internalInputBuffer.addActiveFilter(clearFilter);
internalInputBuffer.addActiveFilter(upperFilter);
byte[] chunk = new byte[4];
try {
int i = 0;
while (i != -1) {
i = internalInputBuffer.doRead(chunk);
if (i == -1)
break;
}
} catch (IOException e) {
e.printStackTrace();
}
System.out.println(new String(chunk));
}
}


由于篇幅问题，上面过程已经尽量模拟描述tomcat输入缓冲的工作流程，但实际使用的过滤器并非上面所述，主要包含四个过滤器：IdentityInputFilter、VoidInputFilter、BufferedInputFilter、ChunkedInputFilter。IdentityInputFilter过滤器在http包含content-length头部并且指定的长度大于0时使用，它将根据指定的长度从底层读取响应长度的字节数组，当读取足够数据后将直接返回-1，避免再次执行底层操作；VoidInputFilter过滤器用于拦截读取底层数据操作，当http不包含content-length头部时说明没有请求体，没必要执行读取套接字底层操作，所以用这个过滤器拦截；BufferedInputFilter过滤器负责读取请求体并将其缓存起来，后面读取请求体时直接从此缓冲区读取；ChunkedInputFilter过滤器专门用于处理分块传输，分块传输是一种数据传输机制，当没有指定content-length时可通过分块传输完成通信。

以上就是tomcat的套接字缓冲装置的过滤器的机制及其实现方法，并且简单介绍了tomcat中不同的过滤器的功能，过滤器模式让tomcat在后期程序扩展升级变得更容易。

点击订购作者《Tomcat内核设计剖析》