(十四)SpringBoot使用AOP统一处理Web请求日志添加MDC

AOP是Spring框架中的一个重要内容，它通过对既有程序定义一个切入点，然后在其前后切入不同的执行内容，基于AOP不会破坏原来程序逻辑，因此它可以很好的对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。

之前看到公司有的人,在业务逻辑内打印方法的请求参数,添加MDC,请求返回时再打印返回的结果,这种事可以统一写好,所有地方都用再写了,并且也能保证代码的干净整洁。

SpringAOP.java

package com.ruubypay.miss.usercenter.config;

import com.ruubypay.miss.global.utils.ErrorCodeHelper;
import com.ruubypay.miss.usercenter.interfaces.models.base.ModelsReturn;
import javassist.*;
import javassist.bytecode.CodeAttribute;
import javassist.bytecode.LocalVariableAttribute;
import javassist.bytecode.MethodInfo;
import org.apache.commons.lang3.ArrayUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.UUID;

/**
 * @author: wangsaichao
 * @date: 2017/10/25
 * @description: 配置切面,配置日志 和请求参数打印
 */
@Aspect
//@Order(-99) // 控制多个Aspect的执行顺序，越小越先执行,为了要在Spring的事务之后执行,所以给他设置99
@Configuration
public class SpringAOP {

    private static final Logger logger = LoggerFactory.getLogger(SpringAOP.class);

    /**
     * 定义切点Pointcut
     * 第一个*号：表示返回类型， *号表示所有的类型
     * 第二个*号：表示类名，*号表示所有的类
     * 第三个*号：表示方法名，*号表示所有的方法
     * 后面括弧里面表示方法的参数，两个句点表示任何参数
     */
    @Pointcut("execution(* com.ruubypay.miss.usercenter.interfaces.controller..*.*(..))")
    public void executionService() {

    }


    /**
     * 方法调用之前调用
     * @param joinPoint
     */
    @Before(value = "executionService()")
    public void doBefore(JoinPoint joinPoint){

        //添加日志打印
        String requestId = String.valueOf(UUID.randomUUID());
        MDC.put("requestId",requestId);
        logger.info("=====>@Before：请求参数为：{}",Arrays.toString(joinPoint.getArgs()));

    }

    /**
     * 方法之后调用
     * @param joinPoint
     * @param returnValue 方法返回值
     */
    @AfterReturning(pointcut = "executionService()",returning="returnValue")
    public void  doAfterReturning(JoinPoint joinPoint,Object returnValue){

        logger.info("=====>@AfterReturning：响应参数为：{}",returnValue);
        // 处理完请求，返回内容
        MDC.clear();
    }

    /**
     * 统计方法执行耗时Around环绕通知
     * @param joinPoint
     * @return
     */
    @Around("executionService()")
    public Object timeAround(ProceedingJoinPoint joinPoint) {

        //获取开始执行的时间
        long startTime = System.currentTimeMillis();

        // 定义返回对象、得到方法需要的参数
        Object obj = null;
        //Object[] args = joinPoint.getArgs();

        try {
            obj = joinPoint.proceed();
        } catch (Throwable e) {
            logger.error("=====>统计某方法执行耗时环绕通知出错", e);
        }

        // 获取执行结束的时间
        long endTime = System.currentTimeMillis();
        //MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        //String methodName = signature.getDeclaringTypeName() + "." + signature.getName();
        // 打印耗时的信息
        logger.info("=====>处理本次请求共耗时：{} ms",endTime-startTime);
        return obj;
    }


}

一些解释,在代码中已经解释的很清楚了,这里介绍一下MDC.put("requestId",requestId);

假如你的系统已经上线,有一个客户的操作有误,导致出现了一些错误,我们可以到日志中去看一下用户的这次请求到底是发生了什么错误。我们可以根据根据用户的手机号或者账号来定位到日志的位置,但是下面的处理流程呢。我们知道系统不可能只有一个人在访问,假如很多人在访问的话,日志打印的是很乱的,这时候如果没有MDC我猜此时此刻你应该处于雪崩状态。MDC恰到好处的让你能够实现在日志上突如其来的一些需求。

requestId我使用的uuid来作为value值.方便 唯一。在我们根据手机号定位到用户的请求时,在使用requestId来定位这次的请求流程,具体如下：

可以看到,可以直接定位出这次请求的所有日志,就算并发很大,只要保证requestId的唯一,就可以定位这次请求的处理过程。

MDC.put("requestId",requestId);之后 还要在日志中 使用requestId才可以,如下：

===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L [%X{requestId}] - %msg%n

最后使用完之后,使用 MDC.clear();来清除这次请求的requestId.