SpringBoot AOP统一处理Web请求日志

最新推荐文章于 2024-04-20 04:14:05 发布

原创最新推荐文章于 2024-04-20 04:14:05 发布 · 1.4k 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#前端 #spring boot #java

Spring 专栏收录该内容

14 篇文章

订阅专栏

该文章介绍了如何在SpringBoot应用中使用AOP（面向切面编程）来统一处理Web请求的日志。首先引入了`spring-boot-starter-aop`依赖，然后创建了一个名为`WebLogAspect`的切面类，使用`@Aspect`和`@Component`注解。在切面类中定义了一个环绕通知`@Around`方法，通过`ProceedingJoinPoint`获取请求信息，如URL、HTTP方法、IP地址、请求类及方法、请求参数，并在方法执行后记录响应结果。整个过程实现了对Web请求的全面日志记录。

SpringBoot AOP统一处理Web请求日志

引入依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

新建过滤器 WebLogAspect.java
- 使用 @Aspect 注解修饰：说明当前类是一个切面类。
- 使用 @Component注解修饰：标记切面类为组件，这样 IOC 容器会为其实例化和管理（< bean>）
定义切面方法：webLog() 方法名随意
- 使用环绕通知 @Around(“execution(public * com.daxiong.mall.Controller..(…))”) 注解修饰指定切面范围。

@Around("execution(public * com.daxiong.mall.controller.*.*(..))")
public Object webLog(ProceedingJoinPoint pjp) {}

记录请求 URL：

ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
log.info("URL : " + request.getRequestURL().toString());

请求类型：

log.info("HTTP_METHOD : " + request.getMethod());

IP 地址：
- 若是本地 localhost，则会返回 ipv6 0:0:0:0:0:0:0:1

log.info("IP : " + request.getRemoteAddr());

记录请求的类以及方法：
- 使用环绕通知的 ProceedingJoinPoint 参数。

log.info("CLASS_METHOD : " + pjp.getSignature().getDeclaringTypeName() + "." + pjp.getSignature().getName());

记录请求参数：

log.info("ARGS : " + Arrays.toString(pjp.getArgs()));

执行方法，处理请求

Object res = pjp.proceed(pjp.getArgs());

记录响应结果
- 使用 jackson 将帝乡转换为 json 格式。

log.info("RESPONSE : " + new ObjectMapper().writeValueAsString(res));

全部：

/**
 * 打印请求和响应信息
 */
@Aspect
@Component
public class WebLogAspect {
    private final Logger log = LoggerFactory.getLogger(WebLogAspect.class);

    @Around("execution(public * com.daxiong.mall.controller.*.*(..))")
    public Object webLog(ProceedingJoinPoint pjp) throws Throwable {
        log.info("========================新的请求========================");
        // 收到请求，记录请求内容
        ServletRequestAttributes attributes =
                (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        log.info("URL : " + request.getRequestURL().toString());
        log.info("HTTP_METHOD : " + request.getMethod());
        // 若是 localhost，则会返回 0:0:0:0:0:0:0:1
        log.info("IP : " + request.getRemoteAddr());

        log.info("CLASS_METHOD : " + pjp.getSignature().getDeclaringTypeName() + "." + pjp.getSignature().getName());
        log.info("ARGS : " + Arrays.toString(pjp.getArgs()));

        // 执行方法，处理请求
        Object res = pjp.proceed(pjp.getArgs());

        // 记录响应
        log.info("RESPONSE : " + new ObjectMapper().writeValueAsString(res));

        return res;
    }
}