日志打印过滤器

背景

在我们项目开发过程中，为了方便上线后的问题排查，可能会有对每一个http接口打印日志的需求，打印的信息可能包括接口请求参数、接口响应参数、接口请求方式、响应时间、请求头信息等，为了便于快速在每一个项目中实现接入，我选择过滤器filter来实现这一目标。

重点问题及解决方案

uri过滤

使用过滤器实现日志打印，会对所有的http请求生效，但是服务中往往会有一些非业务接口不需要打印日志信息，比如健康检查接口、监控接口等，需要我们在过滤器中能够对这些接口uri进行过滤。为了便于配置需要过滤uri(可以使用通配符)，可以使用AntPathMatcher解析请求的uri进行过滤，参考代码如下：

private static final PathMatcher URI_PATH_MATCHER = new AntPathMatcher();

private boolean matchExclude(final String uri) {
        if (CollectionUtils.isEmpty(EXCLUDE_URIS)) {
            return false;
        }
        return EXCLUDE_URIS.stream()
                .anyMatch(excludeUri -> URI_PATH_MATCHER.match(excludeUri, uri));
    }

其中EXCLUDE_URIS是一个静态数组变量，保存需要过滤的uri信息，由业务方定义，在过滤器初始化时将该变量进行赋值。

inputstream只能读取一次的问题

在过滤器中打印请求参数信息，需要读取输入流，但是reqeust.getInputStream()请求body里面的内容只能被获取一次，如果先打印日志，那么业务中就无法再次获取请求信息；如果先处理业务，那么日志就无法打印请求信息。可以使用ContentCachingRequestWrapper和ContentCachingResponseWrapper对原有的request和response进行封装，这两个类会将request和response中得body进行缓存从而实现多次读取。

final HttpServletRequest requestToUse = new ContentCachingRequestWrapper(request);
final HttpServletResponse responseToUse = new ContentCachingResponseWrapper(response);

源代码已上传到gitee：log-filter