AOP统一处理web请求日志

AOP统一处理web请求日志

1. 引入依赖

<!--配置spring-boot-starter-parent父工程,下面的依赖可以不用再指定版本-->
<!--而是可以通过parent包中的版本仲裁，控制整体的版本-->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.2.RELEASE</version>
</parent>
<!--引入web依赖，web依赖中，包括了以下依赖,所以不用再单独引入spring和springMVC-->
<!--spring-boot-starter-->
<!--spring-boot-tomcat-->
<!--spring-web (beans,core) -->
<!--spring-webmvc (aop,context,expression)-->
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <!--排除spring-boot自带的log日志-->
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <!--引入log4j2依赖-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-log4j2</artifactId>
    </dependency>
    <!--引入AOP依赖-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    <!--引入Gson,格式化打印-->
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
    </dependency>
</dependencies>

2. 编写全局AOP切面日志类

@Aspect
@Component
public class LogAspect {
//如果使用Lombok依赖，可以使用@Slf4j注解
 private static  final  Logger log=  LoggerFactory.getLogger(LogAspect.class);

 ThreadLocal<Long> startTime = new ThreadLocal<>();

//申明一个切点 里面是 execution表达式，指定扫描的是XXX包下的controller
@Pointcut("execution(public * com.springboot.controller.*.*(..))")
public void webLog(){}

//请求method前打印内容
@Before("webLog()")
public  void doBefore(JoinPoint joinPoint){
    ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    startTime.set(System.currentTimeMillis());
    HttpServletRequest request = attributes.getRequest();
    log.info("===============请求内容===============");
    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()));
    log.info("===============请求内容===============");
}
@AfterReturning(returning = "res",pointcut = "webLog()")
public void doAfter(Object res) throws JsonProcessingException {
    log.info("===============返回内容===============");
    log.info("RESPONSE : " + new ObjectMapper().writeValueAsString(res));
    log.info("请求处理时间为:"+(System.currentTimeMillis() - startTime.get()));
    log.info("===============返回内容===============");
}
}

@Aspect
@Component
public class LogAspect {
//如果使用Lombok依赖，可以使用@Slf4j注解
private static  final  Logger log=  LoggerFactory.getLogger(LogAspect.class);	
private Gson gson = new Gson();
//使用环形增强的方式
@Around("within(com.springboot.controller.*)")
public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
    // 目标类的名称
    String className = joinPoint.getTarget().getClass().getName();
    // 方法名称
    String methodName = joinPoint.getSignature().getName();
    // 参数列表
    Parameter[] parameters = ((MethodSignature) joinPoint.getSignature()).getMethod().getParameters();
    Object[] args = joinPoint.getArgs();

    StringBuilder params = new StringBuilder("[");
    for (int i = 0; i < parameters.length; i++) {
        params.append(parameters[i].getName()).append(":").append(args[i]).append("; ");
    }
    if (parameters.length > 0) {
        int length = params.length();
        params.delete(length - 2, length);
    }
    params.append("]");
    log.info(">>>> Target class name={} | method name={} | params={} <<<<",className,methodName,params);
    Object result = null;
    try {
        // 执行方法
        result = joinPoint.proceed();
    } catch (Exception e) {
        // 记录异常日志
        log.error(">>>> Target class name={} | method name={}\n{}\n\t at {} <<<<",className, methodName, e.toString(), e.getStackTrace()[0]);
        throw e;
    }
    // 记录方法结果
    log.info(">>>> Target class name={} | method name={} | results={} <<<<",className, methodName, gson.toJson(result));
    return result;
}
}

3. 测试运行

@RestController
public class HelloWord {

    @GetMapping("/hello")
    public  String hello(@RequestParam String name){
        return  "Hello World" + name;
    }
}

使用postman测试，查看控制台打印信息

[14:53:35:680] [INFO] - com.springboot.filter.LogAspect.doBefore(LogAspect.java:45) - ===============请求内容===============
[14:53:35:681] [INFO] - com.springboot.filter.LogAspect.doBefore(LogAspect.java:46) - URL : http://localhost:8989/hello
[14:53:35:681] [INFO] - com.springboot.filter.LogAspect.doBefore(LogAspect.java:47) - HTTP_METHOD : GET
[14:53:35:682] [INFO] - com.springboot.filter.LogAspect.doBefore(LogAspect.java:48) - IP : 0:0:0:0:0:0:0:1
[14:53:35:684] [INFO] - com.springboot.filter.LogAspect.doBefore(LogAspect.java:49) - CLASS_METHOD : com.springboot.controller.HelloWord.hello
[14:53:35:684] [INFO] - com.springboot.filter.LogAspect.doBefore(LogAspect.java:50) - ARGS : [3333]
[14:53:35:684] [INFO] - com.springboot.filter.LogAspect.doBefore(LogAspect.java:51) - ===============请求内容===============
[14:53:35:694] [INFO] - com.springboot.filter.LogAspect.doAfter(LogAspect.java:55) - ===============返回内容===============
[14:53:35:704] [INFO] - com.springboot.filter.LogAspect.doAfter(LogAspect.java:56) - RESPONSE : "Hello World3333"
[14:53:35:704] [INFO] - com.springboot.filter.LogAspect.doAfter(LogAspect.java:57) - 请求处理时间为:25
[14:53:35:704] [INFO] - com.springboot.filter.LogAspect.doAfter(LogAspect.java:58) - ===============返回内容===============

4. AOP知识扩展

类注解:

@Aspect将一个类定义为一个切面类
**@order(i)**标记切面类的处理优先级,i值越小,优先级别越高.PS:可以注解类,也能注解到方法上

方法注解:

@Pointcut定义一个方法为切点里面的内容为一个表达式
@Before 在切点前执行方法,内容为指定的切点
@After 在切点后,return前执行,
@AfterReturning在切入点,return后执行,如果想对某些方法的返回参数进行处理,可以在这操作
@Around 环绕切点,在进入切点前,跟切点后执行
@AfterThrowing 在切点后抛出异常进行处理
@order(i) 标记切点的优先级,i越小,优先级越高