SpringBoot 实战，自定义 Filter 优雅获取请求参数和响应结果

Subclasses may use isAsyncDispatch(HttpServletRequest) to determine when a filter is invoked as part of an async dispatch, and use isAsyncStarted(HttpServletRequest) to determine when the request has been placed in async mode and therefore the current dispatch won’t be the last one for the given request.

Yet another dispatch type that also occurs in its own thread is ERROR. Subclasses can override shouldNotFilterErrorDispatch() if they wish to declare statically if they should be invoked once during error dispatches.

也就是说，Spring 是为了兼容不同的 Web 容器，所以定义了只会执行一次的OncePerRequestFilter。

接下来开始定义我们的Filter类：

public class AccessLogFilter extends OncePerRequestFilter {

//… 这里有一些必要的属性

@Override

protected void doFilterInternal(final HttpServletRequest request,

final HttpServletResponse response,

final FilterChain filterChain)

throws ServletException, IOException {

// 如果是被排除的 uri，不记录 access_log

if (matchExclude(request.getRequestURI())) {

filterChain.doFilter(request, response);

return;

}

final String requestMethod = request.getMethod();

final boolean shouldWrapMethod = StringUtils.equalsIgnoreCase(requestMethod, HttpMethod.PUT.name())

|| StringUtils.equalsIgnoreCase(requestMethod, HttpMethod.POST.name());

final boolean isFirstRequest = !isAsyncDispatch(request);

final boolean shouldWrapRequest = isFirstRequest && !(request instanceof ContentCachingRequestWrapper) && shouldWrapMethod;

final HttpServletRequest requestToUse = shouldWrapRequest ? new ContentCachingRequestWrapper(request) : request;

final boolean shouldWrapResponse = !(response instanceof ContentCachingResponseWrapper) && shouldWrapMethod;

final HttpServletResponse responseToUse = shouldWrapResponse ? new ContentCachingResponseWrapper(response) : response;

final long startTime = System.currentTimeMillis();

Throwable t = null;

try {

filterChain.doFilter(requestToUse, responseToUse);

} catch (Exception e) {

t = e;

throw e;

} finally {

doSaveAccessLog(requestToUse, responseToUse, System.currentTimeMillis() - startTime, t);

}

}

// … 这里是一些必要的方法

这段代码就是整个逻辑的核心所在，其他的内容从源码中找到。

分析

–

这个代码中，整体的逻辑没有特别复杂的地方，只需要注意几个关键点就可以了。

1. 默认的HttpServletRequest和HttpServletResponse中的流被读取一次之后，再次读取会失败，所以要使用ContentCachingRequestWrapper和ContentCachingResponseWrapper进行包装，实现重复读取。

2. 既然我们可以自定义Filter，那我们依赖的组件中也可能会自定义Filter，更有可能已经对请求和响应对象进行过封装，所以，一定要先进行一步判断。也就是request instanceof ContentCachingRequestWrapper和response instanceof ContentCachingResponseWrapper。

只要注意了这两点，剩下的都是这个逻辑的细化实现。

运行

–

接下来我们就运行一遍，看看结果。先定义几种不同的请求：普通 get 请求、普通 post 请求、上传文件、下载文件，这四个接口几乎可以覆盖绝大部分场景。（因为都是比较简单的写法，源码就不赘述了，可以从文末的源码中找到）

先启动项目，然后借助 IDEA 的 http 请求工具：

###普通 get 请求

GET http://localhost:8080/index/get?name=howard

###普通 post 请求

POST http://localhost:8080/index/post

Content-Type: application/json

{“name”:“howard”}

###上传文件

POST http://localhost:8080/index/upload

Content-Type: multipart/form-data; boundary=WebAppBoundary

–WebAppBoundary

Content-Disposition: form-data; name=“file”; filename=“history.txt”

Content-Type: multipart/form-data