一文吃透！Spring Boot 項(xiàng)目請(qǐng)求日志記錄，這幾招你絕對(duì)不能錯(cuò)過！
在互联网应用开发的高速赛道上，系统的稳定性、可维护性以及安全性是每一位开发者都必须关注的核心要素。而请求日志记录，就如同系统的 “黑匣子”，能够为我们提供排查故障、分析用户行为、优化系统性能等关键信息，在整个开发流程中占据着举足轻重的地位。对于广大 Spring Boot 开发者而言，如何快速、高效地实现请求日志记录，一直是日常开发工作中亟待解决的问题。
在过往的开发实践中，我们已经积累了一些常见的请求日志记录方式，它们各有特点，在不同的场景下发挥着重要作用。
一、传统的请求日志记录方式
1、使用拦截器
拦截器就像是一位忠诚的 “门卫”，在请求进入控制器之前和请求完成之后，都能执行特定的操作。
大致流程
-
创建一个自定义的拦截器类，让它实现 Spring 框架提供的 HandlerInterceptor 接口，从而具备拦截请求的能力。
-
重写 preHandle 方法，这个方法会在请求到达控制器之前被调用，我们可以在这个方法中记录请求的关键信息，比如请求的 URL、参数等，为后续的分析和排查提供依据。
-
重写 afterCompletion 方法，在请求处理完成之后，这个方法会被触发，我们可以在这里记录请求的处理结果、耗时等信息，全面了解请求的生命周期。
-
最后，将我们创建的拦截器注册到 Spring MVC 的配置中，这样拦截器就能在整个项目中发挥作用了。
2、使用过滤器
过滤器类似于一个 “关卡”，对所有经过的请求和响应进行统一的处理。
大致流程
-
创建一个自定义的过滤器类，实现 Filter 接口，使其能够对请求和响应进行过滤操作。
-
在 doFilter 方法中，编写记录请求和响应日志的逻辑，这个方法会在请求和响应的处理过程中被调用，我们可以在这里获取并记录请求的详细信息，包括请求头、请求体等。
-
将过滤器注册到 Servlet 容器中，确保它能够对所有的请求和响应生效。
3、使用AOP
AOP（面向切面编程）就像是一把 “手术刀”，能够精准地切入到方法的执行过程中，实现对日志记录的统一管理。
大致流程
-
定义一个切面类，使用 @Aspect 注解将其标记为切面，表明这个类将用于处理横切关注点。
-
使用 @Around 注解定义切点，切点就像是一个 “钩子”，可以在方法执行前、执行后或抛出异常后，执行我们定义的日志记录逻辑，灵活地记录不同阶段的信息。
-
将切面类注册到 Spring 容器中，使其能够在项目中发挥作用。
这些传统的方式虽然有效，但在实际应用中可能会面临一些配置繁琐、代码冗余等问题。那么，有没有更简单、高效的方法呢？答案是肯定的！Spring Boot 2 为我们提供了一些内置的超强请求记录方法，让我们一起来看看吧！
二、Spring Boot 2 内置的超便捷请求记录方法
方法一：通过 Spring Boot Actuator 的 httptrace 端点
步骤如下：
1、项目pom引入Actuator GAV
在项目的 pom 文件中添加以下依赖，引入 Spring Boot Actuator：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
2、开启httptrace端点
在配置文件中，我们可以通过以下配置开启所有端点，以便使用 httptrace 端点：
management:
endpoints:
web:
exposure:
include: '*'
3、测试
编写一个测试 controller，用于模拟请求：
@RequestMapping("echo")
@RestController
public class EchoController {
@RequestMapping("say/{sleep}")
public String echo(@PathVariable("sleep") long sleep, String msg) {
if(sleep == 0){
throw new IllegalArgumentException("sleep参数不能为0");
}
try {
TimeUnit.MILLISECONDS.sleep(sleep);
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
return "echo:" + msg;
}
}
浏览器先访问测试控制器http://localhost:8080/echo/say/100?msg=hello
再访问下httptrace端点http://localhost:8080/actuator/httptrace
这时，你会惊喜地发现，请求记录已经清晰地呈现在你面前。不过，需要注意的是，httptrace 信息默认存储在内存中，如果需要持久化存储，可以通过实现
org.springframework.boot.actuate.trace.http.HttpTraceRepository
，将其存储到其他存储介质上，如数据库、文件系统等。
方法二：通过监听 ServletRequestHandledEvent 事件
Spring 框架提供了丰富的事件机制，我们可以通过监听 ServletRequestHandledEvent 事件来记录请求日志。
示例代码如下：
@Slf4j
public class RequestLogEventListener {
@EventListener
public void listener(ServletRequestHandledEvent event){
log.info("request client ip :{},request method:{}",event.getClientAddress(),event.getMethod());
log.info("request url:{},cost time:{} ms",event.getRequestUrl(),event.getProcessingTimeMillis());
if(event.wasFailure()){
log.error("request fail,error msg:{}",event.getFailureCause());
}
}
}
访问测试控制器，然后观察控制台
你会发现请求日志已经被准确地记录下来。
ServletRequestHandledEvent 事件由
org.springframework.web.servlet.FrameworkServlet#processRequest
方法触发发送的，这为我们提供了一个非常方便的记录请求日志的时机。
开启 DispatcherServlet 日志，日志级别为debug
通过开启 DispatcherServlet 的日志，我们可以获取到详细的请求信息。
在配置文件中进行如下配置：
logging:
level:
org.springframework.web.servlet.DispatcherServlet: DEBUG
可以通过http://localhost:8080/actuator/loggers/org.springframework.web.servlet.DispatcherServlet 动态调整日志级别，不过需要注意的是，这种方式在项目重启后，日志级别会恢复默认。示例命令如下：
curl -X POST http://localhost:8080/actuator/loggers/org.springframework.web.servlet.DispatcherServlet \
-H "Content-Type: application/json" \
-d '{"configuredLevel": "DEBUG"}'
最后访问测试控制器，观察控制台
你会发现有请求信息输出。但细心的你可能会发现 parameters={masked}，这是因为 DispatcherServlet 默认会将请求参数进行掩码处理，以保护敏感信息不被泄露。不过，我们可以通过以下配置让请求参数显示出来：
spring:
http:
log-request-details: true
将请求参数也显示出来，再次访问测试控制器，观察控制台
会发现请求参数已经打印出来
三、总结
本文详细介绍了 Spring Boot 内置的三种记录请求日志的方式，这些方法不仅简单易用，而且功能强大，大大提高了我们的开发效率。如果想要将日志记录到存储介质，个人比较推荐使用 ServletRequestHandledEvent 这种方式，它的配置相对简单，并且能够满足大多数场景的需求。当然，如果有定制化的需求，比如需要记录响应体，那么开头介绍的那三种传统方式也是不错的选择，它们能够提供更灵活的扩展能力。但无论如何，利用好 Spring Boot 提供的这些内置功能，能够让我们的开发工作事半功倍。
四、demo链接
为了方便大家实践，文中所有代码的 demo 链接为：
赶紧动手实践一下吧，相信你一定会对 Spring Boot 的请求日志记录有更深入的理解！
希望这篇文章能够帮助你在 Spring Boot 开发中更好地记录请求日志，提升系统的可维护性和稳定性。如果在实践过程中有任何问题，欢迎随时交流探讨！
共同學(xué)習(xí)，寫下你的評(píng)論
評(píng)論加載中...
作者其他優(yōu)質(zhì)文章
