SpringBoot基础教程2-1-6 日志规范-使用AOP统一处理Web日志

1. 概述

Web层作为服务的入口，对请求参数和响应结果的日志记录是必不可少的，本文结合AOP切面技术，统一处理Web日志。

2. 一般Web日志记录方法

大部分人，会直接在Controller打印日志，如下：

@Slf4j
@RestController
public class UserController {
    @PostMapping("/user")
    public R addUser(@RequestBody User user){
        log.info("user: {}", JSON.toJSONString(user));
        R r = R.isOk().data(user);
        log.info("result: {}", JSON.toJSONString(user));
        return r;
    }
}

这种写法，导致日志代码重复，并且耦合在Controller层，不够优雅，也不够偷懒。

JSON类是fastjson的工具类，推荐使用

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.39</version>
</dependency>

3. 优雅的记录web日志

pom文件，引入AOP依赖

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

简单创建Controller

@RestController
@RequestMapping("/log")
public class AopLogController {

    @PostMapping("/user")
    public R addUser(@RequestBody User user){

        return R.isOk().data(user);
    }
}

创建日志切面

@Slf4j
@Aspect
@Component
public class WebLogAspect {
    @Pointcut("execution(public * com.mkeeper.controller.logging..*.*(..))")
    public void webLog(){}

    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint){
        // 接收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        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()));

    }

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

@Aspect将一个java类定义为切面类 @Pointcut定义一个切入点，可以是一个规则表达式，比如下例中某个package下的所有函数，也可以是一个注解等。 @Before在切入点开始处切入内容 @After在切入点结尾处切入内容 @AfterReturning在切入点return内容之后切入内容（可以用来对处理返回值做一些加工处理） @Around在切入点前后切入内容，并自己控制何时执行切入点自身的内容 @AfterThrowing用来处理当切入内容部分抛出异常之后的处理逻辑