springboot使用aop进行日志打印和记录（一）

通常，在我们开发过程中，我们想知道所写的接口在被访问的时候能够清楚的看到请求方的请求参数以及响应方的响应参数，这样我们可以快速的查看接口请求过程中是否存在问题，参数是否符合要求。

要想查看到请求地址、请求参数和响应参数的方式有很多，比较了几种方式，总的来说，使用aop切面去做，十分的方便，效果也最好。下面就一起看下怎么进行操作。

1 添加依赖

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

2 创建WebLogAspect类，并添加@Aspect @Component注解。

@Aspect
@Component
public class WebLogAspect {

}

3 在WebLogAspect类中创建一个切点，注解@Pointcut以访问controller包下的请求为切点，即只要访问了controller包下的类和方法就会被。

// 以 controller 包下定义的所有请求为切入点
@Pointcut("execution(public * com.example.demo.controller..*.*(..))")
public void webLog() {}

4 创建一个在切点之前织入的方法，在这个方法中可通过JoinPoint对象获取到请求信息。

@Before("webLog()")
public void doBefore(JoinPoint joinPoint) throws Throwable {

 // 开始打印请求日志
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();


        // 打印请求相关参数
        logger.info("========================================== Start ==========================================");
        // 打印请求 url
        logger.info("请求地址        : {}", request.getRequestURL().toString());
        // 打印 Http method
        logger.info("请求方式        : {}", request.getMethod());
        // 打印调用 controller 的全路径以及执行方法
        logger.info("请求方法所在路径 : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());

        ParameterNameDiscoverer pnd = new DefaultParameterNameDiscoverer();
        String[] keys = pnd.getParameterNames(method);
        Object[] values = joinPoint.getArgs();
        Map<String, Object> paramsMap = new HashMap<>();
        for (int i = 0; i < keys.length; i++) {
            paramsMap.put(keys[i],values[i]);
        }
        // 打印请求入参
        logger.info("请求参数        : {}", new Gson().toJson(paramsMap));

}

5 创建一个Around环绕方法，可打印从请求前到请求后的结果。

@Around("webLog()")
public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();

        Object result = proceedingJoinPoint.proceed();
        // 打印出参
        logger.info("响应参数        : {}", new Gson().toJson(result));
        // 执行耗时
        logger.info("响应时间        : {} ms", System.currentTimeMillis() - startTime);
        return result;
}

6 创建请求之后的方法，没有实际作用，仅是提示结束。

@After("webLog()")
public void doAfter() throws Throwable {
        logger.info("=========================================== End ===========================================");
        // 每个请求之间空一行
        logger.info("");
}