java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > springboot filter请求拦截

springboot filter实现请求响应全链路拦截

作者：浪浪山老周

这篇文章主要为大家详细介绍了SpringBoot如何结合Filter同时拦截请求和响应,从而实现​​日志采集自动化,感兴趣的小伙伴可以跟随小编一起学习一下

一、为什么你需要这个过滤器？​

日志痛点：

​​解决方案​​： 一个Filter同时拦截请求和响应，实现​​日志采集自动化​​！

​​二、核心实现：一个Filter搞定双向数据流​​

过滤器设计亮点​​

​​三、完整代码实现​​

​​1. 过滤器核心代码（可直接复制）​​

import org.springframework.web.filter.OncePerRequestFilter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class RequestResponseLogFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, 
                                    HttpServletResponse response, 
                                    FilterChain filterChain)
            throws ServletException, IOException {
        
        // 包装请求响应对象
        ContentCachingRequestWrapper wrappedRequest = 
            new ContentCachingRequestWrapper(request);
        ContentCachingResponseWrapper wrappedResponse = 
            new ContentCachingResponseWrapper(response);

        try {
            // 执行后续过滤器链
            filterChain.doFilter(wrappedRequest, wrappedResponse);
            
            // 记录日志（核心逻辑）
            logRequest(wrappedRequest);
            logResponse(wrappedResponse);
            
        } finally {
            // 必须执行响应回写
            wrappedResponse.copyBodyToResponse();
        }
    }

    // 请求日志方法
    private void logRequest(ContentCachingRequestWrapper request) {
        String method = request.getMethod();
        String url = request.getRequestURL().toString();
        String params = getRequestParams(request);
        
        System.out.printf("[请求] %s %s | 参数=%s%n", method, url, params);
    }

    // 响应日志方法
    private void logResponse(ContentCachingResponseWrapper response) throws IOException {
        int status = response.getStatus();
        String body = getResponseBody(response);
        
        System.out.printf("[响应] 状态码=%d | 内容=%s%n", status, body);
    }

    
    // 获取请求参数工具方法
    private String getRequestParams(ContentCachingRequestWrapper request) {
        try {
            if ("GET".equalsIgnoreCase(request.getMethod())) {
                return request.getQueryString();
            } else {
                byte[] body = request.getContentAsByteArray();
                return new String(body, request.getCharacterEncoding());
            }
        } catch (Exception e) {
            return "[参数解析失败]";
        }
    }

    // 获取响应内容工具方法
    private String getResponseBody(ContentCachingResponseWrapper response) throws IOException {
        byte[] content = response.getContentAsByteArray();
        return new String(content, response.getCharacterEncoding());
    }

    @Override
    public void init(FilterConfig filterConfig) {}

    @Override
    public void destroy() {}
}

四、过滤器添加三步走​​

​​1. 添加依赖（Maven配置）​​

<!-- 核心包装类 -->
<dependency>
    <groupId>org.apache.tomcat</groupId>
    <artifactId>tomcat-catalina</artifactId>
    <version>9.0.65</version>
</dependency>

​​2. web.xml配置​​（传统项目）

<filter>
    <filter-name>RequestResponseLogFilter</filter-name>
    <filter-class>com.example.RequestResponseLogFilter</filter-class>
</filter>

<filter-mapping>
    <filter-name>RequestResponseLogFilter</filter-name>
    <url-pattern>/*</url-pattern> <!-- 拦截所有请求 -->
    <dispatcher>REQUEST</dispatcher>
</filter-mapping>

​​​​3. Spring Boot集成​​（新项目推荐）

@Bean
public FilterRegistrationBean<RequestResponseLogFilter> logFilter(){
    FilterRegistrationBean<RequestResponseLogFilter> registrationBean = new FilterRegistrationBean<>();
    registrationBean.setFilter(new RequestResponseLogFilter());
    registrationBean.addUrlPatterns("/*");
    return registrationBean;
}

五、运行效果演示​​

[REQUEST] POST http://api/user/login | 参数=username=admin&password=123456 | 时间=Wed Oct 05 14:30:00 CST 2023
[RESPONSE] 状态码=200 | 响应内容={"code":0,"msg":"登录成功"} | 耗时=120ms

六、必须注意的6大事项​​

1.内存溢出风险​​

拦截大文件上传时（>1MB）会占用大量内存

解决方案：限制缓存大小

// 在构造方法中设置最大缓存
new ContentCachingRequestWrapper(request, 1024 * 1024); // 1MB

2.​​编码兼容性问题​​

请求参数乱码常因缺少编码设置导致

强制设置编码（在Filter头部添加）

request.setCharacterEncoding("UTF-8");
response.setCharacterEncoding("UTF-8");

3.​​响应流二次读取​​

原始响应流只能读取一次，必须使用包装类

错误写法：直接使用原始response.getWriter()

4.敏感信息泄露​​

密码等字段需过滤（正则替换示例）

params.replaceAll("password=\\w+", "password=​**​*");

5.性能损耗控制​​

高并发场景建议异步记录日志

CompletableFuture.runAsync(() -> log.info(logContent));

6.HTTPS支持​​

确保Tomcat配置正确：

<Connector port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol"
           SSLEnabled="true" scheme="https" secure="true"/>

七、进阶玩法​​

组合使用​​：

搭配Spring AOP实现方法级日志

结合Redis实现请求限流

数据分析​​：

-- 日志分析SQL示例
SELECT 
    request_uri, 
    COUNT(*) as total,
    AVG(response_time) as avg_time 
FROM access_log 
WHERE status >= 500 
GROUP BY request_uri;

总结​​

一个优秀的Filter就像「数字监控摄像头」，默默记录系统运行轨迹。通过本文的方案，你可以：

到此这篇关于springboot filter实现请求响应全链路拦截的文章就介绍到这了,更多相关springboot filter请求拦截内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文