讲师中心 微信公众号
AI工具推荐 视频效率加速

Java 中怎么通过 Filter 过滤器在 REST 接口最外层记录 Request 日志

酷辰大大_3844

酷辰大大_3844

发布时间:2026-09-22 15:06:36

|

106人浏览过

|

来源于php中文网

原创

在 Spring Boot 中可通过继承 OncePerRequestFilter 并使用 ContentCachingRequestWrapper/ResponseWrapper 包装请求响应,实现安全、可重复读取的全量请求/响应日志记录,需注意流复用、敏感信息脱敏、内容截断及响应体回写。

java 中怎么通过 filter 过滤器在 rest 接口最外层记录 request 日志

在 Java 的 Spring Boot 项目中,可以通过实现 Filter 接口,在请求进入 Controller 前、响应返回客户端后,统一记录完整的 Request(含 URL、Method、Headers、Body)和 Response 信息。关键在于正确读取并复用请求/响应流,避免因流被消费导致后续处理失败。

使用 OncePerRequestFilter 保证单次执行

OncePerRequestFilter 是 Spring 提供的包装类,能确保每个请求只被该 Filter 执行一次(尤其在异步或转发场景下),比直接实现 Filter 更安全可靠。

  • 继承 OncePerRequestFilter,重写 doFilterInternal
  • 将原始 HttpServletRequestHttpServletResponse 包装为可重复读取的自定义 wrapper(如 ContentCachingRequestWrapperContentCachingResponseWrapper
  • 调用 chain.doFilter() 后再读取缓存内容,避免 body 流已关闭

正确读取 Request Body 需要包装请求对象

原生 HttpServletRequest 的 input stream 只能读一次。不包装直接调用 getInputStream()getReader(),会导致 Controller 拿不到数据。

  • 使用 ContentCachingRequestWrapper:Spring 自带,自动缓存 body 到内存(注意不要用于超大文件上传)
  • 读取时用 byte[] content = wrapper.getContentAsByteArray(),再转成字符串(注意字符编码,默认 UTF-8)
  • 对 GET 请求,body 通常为空,应优先记录 query string;POST/PUT 等才需关注 body

记录日志内容建议包含的关键字段

一条完整请求日志应至少涵盖以下信息,便于问题排查和审计:

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载

立即学习Java免费学习笔记(深入)”;

  • 时间戳:精确到毫秒,例如 LocalDateTime.now().format(DateTimeFormatter.ISO_LOCAL_DATE_TIME)
  • 请求 ID:通过 UUID.randomUUID() 或 MDC 注入 traceId(配合 Sleuth 更佳)
  • 客户端 IP:用 request.getRemoteAddr(),若经 Nginx,应读 X-Forwarded-For
  • HTTP 方法 + 路径 + 查询参数:如 POST /api/users?size=10
  • Headers(敏感头如 Authorization、Cookie 建议脱敏)
  • Request Body(限长打印,如前 1024 字符,避免日志爆炸)
  • 响应状态码 + 响应耗时(ms)
  • Response Body(同理限长,且仅记录成功或 debug 级别)

示例代码片段(Spring Boot 2.x+)

注册一个全局日志 Filter:

@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class RequestLoggingFilter extends OncePerRequestFilter {
<pre class='brush:java;toolbar:false;'>private static final Logger log = LoggerFactory.getLogger(RequestLoggingFilter.class);

@Override
protected void doFilterInternal(HttpServletRequest request,
                                HttpServletResponse response,
                                FilterChain filterChain) throws ServletException, IOException {
    long startTime = System.currentTimeMillis();

    // 包装请求和响应
    ContentCachingRequestWrapper wrappedRequest =
        new ContentCachingRequestWrapper(request);
    ContentCachingResponseWrapper wrappedResponse =
        new ContentCachingResponseWrapper(response);

    try {
        filterChain.doFilter(wrappedRequest, wrappedResponse);
    } finally {
        long duration = System.currentTimeMillis() - startTime;
        logRequest(wrappedRequest, wrappedResponse, duration);
        // 必须调用 copyBodyToResponse,否则响应内容不会写回客户端
        wrappedResponse.copyBodyToResponse();
    }
}

private void logRequest(ContentCachingRequestWrapper request,
                        ContentCachingResponseWrapper response,
                        long duration) {
    String method = request.getMethod();
    String uri = request.getRequestURL().toString();
    String queryString = request.getQueryString();
    if (queryString != null) uri += "?" + queryString;

    String clientIp = getClientIpAddress(request);
    String requestBody = getRequestBody(request);
    String responseBody = getResponseBody(response);

    log.info("[{}] {} {} | {}ms | IP: {} | Body: {} | Resp: {}",
            LocalDateTime.now().format(DateTimeFormatter.ISO_LOCAL_DATE_TIME),
            method, uri, duration, clientIp,
            truncate(requestBody, 512), truncate(responseBody, 512));
}

private String getClientIpAddress(HttpServletRequest request) {
    String xff = request.getHeader("X-Forwarded-For");
    return xff != null && !xff.isEmpty() ? xff.split(",")[0].trim() : request.getRemoteAddr();
}

private String getRequestBody(ContentCachingRequestWrapper request) {
    byte[] content = request.getContentAsByteArray();
    if (content.length == 0) return "";
    try {
        return new String(content, StandardCharsets.UTF_8);
    } catch (Exception e) {
        return "[INVALID-UTF8]";
    }
}

private String getResponseBody(ContentCachingResponseWrapper response) {
    byte[] content = response.getContentAsByteArray();
    if (content.length == 0) return "";
    try {
        return new String(content, StandardCharsets.UTF_8);
    } catch (Exception e) {
        return "[INVALID-UTF8]";
    }
}

private String truncate(String s, int limit) {
    return s != null && s.length() > limit ? s.substring(0, limit) + "..." : s;
}

}

热门AI工具

更多
SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

8817

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

6022

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

5412

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

964

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

808

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1156

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2329

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

19671

2023.08.03

Conan私有仓库搭建教程
Conan私有仓库搭建教程

本专题系统的讲解Conan私有仓库的搭建流程,涵盖仓库服务部署、存储目录配置、用户认证、权限划分和远程地址添加,并介绍内部C++依赖包的上传、下载及版本维护方法。

0

2026.09.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn