AOP统一处理Web请求日志

最新推荐文章于 2024-10-25 10:24:11 发布

原创最新推荐文章于 2024-10-25 10:24:11 发布 · 827 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#eureka #java #postman

Fishの笔记同时被 2 个专栏收录

39 篇文章

订阅专栏

Fishのjava

21 篇文章

订阅专栏

本文介绍了如何通过AOP（面向切面编程）在Spring Boot中实现请求日志的拦截和打印，以增强系统调试和问题排查能力。首先在pom.xml引入了spring-boot-starter-aop依赖，然后创建了一个名为WebLogAspect的过滤器类，定义了切入点和通知方法，分别在请求前记录请求信息，在请求后记录响应内容。这样，每次请求的URL、HTTP方法、IP地址、方法及参数等都会被记录在日志中，有助于后续的故障排查。

这是为了系统健壮性的一种保证，用filter把每一个请求都打印出来，可以提高调试开发的效率

以下是我配置AOP的方法

在pom.xml里面配置依赖

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

然后建一个过滤器，对我们的请求进行拦截和打印

创建一个文件夹filter类WebLogAspect

package com.fish.springboot.mall.filter;


import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Arrays;
import javax.servlet.http.HttpServletRequest;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

/**
 * 描述：     打印请求和响应信息
 */
@Aspect
@Component
public class WebLogAspect {

    private final Logger log = LoggerFactory.getLogger(WebLogAspect.class);

    @Pointcut("execution(public * com.fish.springboot.mall.controller.*.*(..)))")
    public void webLog() {

    }

    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) {
        //收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder
                .getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        log.info("URL : " + request.getRequestURL().toString());
        log.info("HTTP_METHOD :" + request.getMethod());
        log.info("IP : " + request.getRemoteAddr());
        log.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "."
                + joinPoint.getSignature().getName());
        log.info("ARGS : " + Arrays.toString(joinPoint.getArgs()));
    }

    @AfterReturning(returning = "res", pointcut = "webLog()")
    public void doAfterReturning(Object res) throws JsonProcessingException {
        //处理完请求，返回内容
        log.info("RESPONSE : " + new ObjectMapper().writeValueAsString(res));
    }
}

能打印出来一些日志，例：