Java 日志记录中 Spring 中怎么记录响应日志

冬涛大大_5561

冬涛大大_5561

2026-11-20

438人浏览

原创

在 spring 中记录响应日志,最直接且标准的做法是使用 @restcontrolleradvice 结合 responsebodyadvice 接口。通过实现该接口,可以在控制器方法执行完毕后、返回值序列化之前拦截数据,从而获取到完整的响应体进行日志记录。这种方式非侵入式,无需在每个 controller 中手动添加日志代码,且能统一处理所有接口的响应信息。

Java 日志记录中 Spring 中怎么记录响应日志

如何配置全局响应拦截器

要实现全局响应日志,需要创建一个实现了 ResponseBodyAdvice 的组件类。在该类中,重写 supports 方法以指定适用的返回类型(通常排除文件流等二进制数据),并重写 beforeBodyWrite 方法。在 beforeBodyWrite 中,你可以访问到即将返回给客户端的对象 body,此时将其打印或记录到日志框架中即可。为了确保日志格式统一,建议将响应体封装在一个统一的 DTO 结构中,或者直接使用 JSON 工具类将其序列化为字符串后记录。

Java 日志记录中 Spring 中怎么记录响应日志

import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.fasterxml.jackson.databind.ObjectMapper;

@RestControllerAdvice
public class GlobalResponseLogAdvice implements ResponseBodyAdvice<object> {

    private static final Logger log = LoggerFactory.getLogger(GlobalResponseLogAdvice.class);
    private final ObjectMapper objectMapper = new ObjectMapper();

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        // 排除不需要记录日志的类型,如 ResponseEntity<inputstreamresource> 等
        return !returnType.getParameterType().isAssignableFrom(InputStreamResource.class);
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType,
                                  MediaType selectedContentType, Class selectedConverterType,
                                  ServerHttpRequest request, ServerHttpResponse response) {
        try {
            String jsonBody = objectMapper.writeValueAsString(body);
            log.info("Response Body: {}", jsonBody);
        } catch (Exception e) {
            log.error("Failed to serialize response body", e);
        }
        return body;
    }
}</inputstreamresource></object>

如何处理请求与响应的关联追踪

在实际生产环境中,单独记录响应日志往往难以排查问题,因为无法直接知道该响应对应的是哪个请求。因此,最佳实践是结合 HandlerInterceptor 或 Filter 记录请求日志,并通过 MDC(Mapped Diagnostic Context)注入唯一的 traceId。这样,响应日志和请求日志就会拥有相同的 traceId,便于在日志系统中串联查询。在 ResponseBodyAdvice 中记录响应时,只需确保当前的 MDC 上下文已包含 traceId,日志框架(如 Logback)会自动将该 ID 写入日志行中,从而实现请求-响应的完整链路追踪。

FilePond 灵活的 JavaScript 文件上传库
FilePond 灵活的 JavaScript 文件上传库

FilePond 是一个 JavaScript 文件上传库,支持通过拖拽、粘贴和 API 方式处理文件、目录、URL 和 Data URI。它包含内置的图像优化功能、异步分块上传功能,并提供了适用于 React、Vue、Angular 和 Svelte 的适配器。

下载

Java 日志记录中 Spring 中怎么记录响应日志

import org.springframework.web.servlet.HandlerInterceptor;
import org.slf4j.MDC;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;

public class TraceIdInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        // 生成唯一追踪ID并放入MDC
        String traceId = UUID.randomUUID().toString().replace("-", "");
        MDC.put("traceId", traceId);
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        // 请求结束后清理MDC,防止内存泄漏
        MDC.clear();
    }
}

当响应体为null或空对象时日志会记录什么

当控制器返回值为 null 或空对象时,beforeBodyWrite 方法中的 body 参数将为 null。如果直接调用 objectMapper.writeValueAsString(null),通常会抛出异常或返回特定字符串(取决于 Jackson 配置)。在上述代码示例中,我们使用了 try-catch 块来捕获可能的序列化异常。如果 body 为 null,writeValueAsString 可能会返回 "null" 字符串(默认行为)或抛出异常。为了稳健性,建议在序列化前增加判空逻辑:若 body == null,则直接记录 "Response Body: null",避免不必要的序列化开销或异常。这确保了即使在无数据返回的场景下,日志系统也能正常记录响应状态,保持日志链路的完整性。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

13017

6

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

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

2023.07.05

10082

9

java自学难吗
java自学难吗

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

2023.07.31

8552

8

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

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

2023.08.01

1364

3

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

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

2023.08.02

1068

3

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

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

2023.08.02

1636

5

java有什么用
java有什么用

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

2023.08.02

3409

5

java在线网站
java在线网站

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

2023.08.03

20631

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1475

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习