Spring Boot中统一记录请求、响应及异常日志的方法

Spring Boot中统一记录请求、响应及异常日志的方法

技术背景

在开发基于Spring Boot的REST API时，为了便于调试、监控和问题排查，需要对所有请求和响应进行详细的日志记录，包括请求的输入参数、请求路径、查询字符串、对应的类方法，以及响应结果（包括成功和错误情况）。

实现步骤

1. 使用Spring Boot Actuator

Actuator是Spring Boot的一个模块，它提供了HTTP请求日志记录功能。

• 添加依赖：在pom.xml中添加spring-boot-starter-actuator依赖。

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-actuatorartifactId>
dependency>

• 配置端点：在application.properties中配置要暴露的端点。

management.endpoints.web.exposure.include=*

• 查看日志：启动应用后，可以通过访问/actuator/httptrace查看最近的100个HTTP请求。

2. 使用CommonsRequestLoggingFilter

Spring提供了CommonsRequestLoggingFilter来记录请求日志。

• 配置过滤器：在配置类中添加过滤器Bean。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.filter.CommonsRequestLoggingFilter;

@Configuration
public class LoggingConfig {
   

    @Bean
    public CommonsRequestLoggingFilter requestLoggingFilter() {
   
        CommonsRequestLoggingFilter loggingFilter = new CommonsRequestLoggingFilter();
        loggingFilter.setIncludeClientInfo(true);
        loggingFilter.setIncludeQueryString(true);
        loggingFilter.setIncludePayload(true);
        loggingFilter.setMaxPayloadLength(64000);
        return loggingFilter;
    }
}

• 设置日志级别：在application.properties中设置过滤器的日志级别为DEBUG。

logging.level.org.springframework.web.filter.CommonsRequestLoggingFilter=DEBUG

3. 自定义DispatcherServlet

通过自定义DispatcherServlet可以同时记录请求和响应日志。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.