SpringBoot基于AOP的日志处理

在使用SpringBoot开发的时候，我们可以通过AOP来获取自己想要的日志信息并且在控制台进行打印。

一、导入AOP相关的启动器

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

二、编写面向切面记载日志的类

/**
 * 该类为使用AOP来完成日志拦截的类
 */
@Aspect
@Component
public class LogAspect {

    private final Logger logger= LoggerFactory.getLogger(this.getClass());

    //定义切面，切面监控访问cn.xsh.blog.controller目录的所有请求
    @Pointcut("execution(* cn.xsh.blog.controller.*.*(..))")
    public void log(){}

    //定义在进入切面前执行的方法
    @Before("log()")
    public void doBefore(JoinPoint joinPoint){
        //获取HttpServletRequest对象获取请求中的相关数据
        ServletRequestAttributes attributes= (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request=attributes.getRequest();  //获取request对象
        String url=request.getRequestURL().toString();   //获取请求的url
        String ip=request.getRemoteAddr();     //获取请求对象的ip地址
        String classMethod= joinPoint.getSignature().getDeclaringTypeName()+"."+joinPoint.getSignature().getName();
            //获取请求对象请求的方法名称
        Object [] args=joinPoint.getArgs();     //获取请求对象的请求参数
        RequestLog requestLog=new RequestLog(url,ip,classMethod,args);
        logger.info("Request : {}",requestLog);
    }
    //定义在切面访问完成执行的方法
    @After("log()")
    public void doAfter(){
        logger.info("------------doAfter-----------------------");
    }
    //定义方法获取访问的Controller返回的值并在日志中打印
    @AfterReturning(returning = "result",pointcut = "log()")
    public void doAfterReturning(Object result){
        logger.info("Result : {}",result);
    }

    //定义内部类来表示需要在请求之前获取到的相关的日志信息
    private class RequestLog{
        private String url;  //请求的 url
        private String ip;  //请求者的ip
        private String classMethod;  //请求者的目标请求方法
        private Object[] args;  //请求参数

        public RequestLog(String url, String ip, String classMethod, Object[] args) {
            this.url = url;
            this.ip = ip;
            this.classMethod = classMethod;
            this.args = args;
        }

        @Override
        public String toString() {
            return "{" +
                    "url='" + url + '\'' +
                    ", ip='" + ip + '\'' +
                    ", classMethod='" + classMethod + '\'' +
                    ", args=" + Arrays.toString(args) +
                    '}';
        }
    }
}

AOP相关的注解介绍：

@Aspect:作用是把当前类标识为一个切面供容器读取
@Pointcut：Pointcut是植入Advice的触发条件。每个Pointcut的定义包括2部分，一是表达式，二是方法签名。方法签名必须是 public及void型。可以将Pointcut中的方法看作是一个被Advice引用的助记符，因为表达式不直观，因此我们可以通过方法签名的方式为 此表达式命名。因此Pointcut中的方法只需要方法签名，而不需要在方法体内编写实际代码。
@Around：环绕增强，相当于MethodInterceptor
@AfterReturning：后置增强，相当于AfterReturningAdvice，方法正常退出时执行
@Before：标识一个前置增强方法，相当于BeforeAdvice的功能，相似功能的还有
@AfterThrowing：异常抛出增强，相当于ThrowsAdvice
@After: final增强，不管是抛出异常或者正常退出都会执行