美文网首页SpringBoot
SpringBoot 使用AOP统一处理web请求日志

SpringBoot 使用AOP统一处理web请求日志

作者: 忧郁的小码仔 | 来源:发表于2017-06-23 15:59 被阅读382次

    通过AOP统一处理web请求日志,只需要添加两个依赖即可:

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

    一般不需要其他任何配置,即可使用。

    1.先定义一个注解,用来描述每个方法的用途等。

    @Target(ElementType.METHOD) //表示该注解标注在方法上
    @Retention(RetentionPolicy.RUNTIME) //表示该注解保留到runtime阶段,将被JVM保留,所以它能在运行时被JVM或其他使用反射机制的代码所读取和使用.
    @Documented //表示该注解会被 javadoc 之类的工具处理, 所以注解类型信息也会被包括在生成的文档中
    public @interface LoggerManage {
    
        public String description();
    }
    

    2.先写一个简单的请求

    @RestController
    public class IndexController {
    
        @RequestMapping(value = "/index", method = RequestMethod.GET)
        @LoggerManage(description = "获取用户名")
        public String getUserName(String userID, Integer age) {
            return "ArcherLj";
        }
    }
    

    3.实现web层日志切面

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

    使用ThreadLocal对象来记录请求处理的时间(直接在使用基本类型会有同步问题,所以我们可以引入ThreadLocal对象)

    package com.example.demo;
    
    import org.apache.commons.lang3.builder.ToStringBuilder;
    import org.apache.log4j.Logger;
    import org.aspectj.lang.JoinPoint;
    import org.aspectj.lang.annotation.AfterReturning;
    import org.aspectj.lang.annotation.AfterThrowing;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Before;
    import org.springframework.stereotype.Component;
    import org.springframework.stereotype.Service;
    
    
    /**
     * Created by archerlj on 2017/6/23.
     */
    @Aspect
    @Component
    public class LoggerAdvice {
    
        private Logger logger = Logger.getLogger(this.getClass());
        ThreadLocal<Long> startTime = new ThreadLocal<>();
    
        @Before("within(com.example.demo.*) && @annotation(loggerManage)")
        public void addBeforeLogger(JoinPoint joinPoint, LoggerManage loggerManage) {
            logger.info("执行--" + loggerManage.description() + "--开始");
            startTime.set(System.currentTimeMillis());
            logger.info(joinPoint.getSignature().toString());
            logger.info(parseParames(joinPoint.getArgs()));
        }
    
        @AfterReturning("within(com.example.demo.*) && @annotation(loggerManage)")
        public void addAfterReturningLogger(JoinPoint joinPoint, LoggerManage loggerManage) {
            logger.info("执行--" + loggerManage.description() + "--结束");
            logger.info("执行时间--" + (System.currentTimeMillis() - startTime.get()));
        }
    
        @AfterThrowing(pointcut = "within(com.example.demo.*) && @annotation(loggerManage)", throwing = "ex")
        public void addAfterThrowingLogger(JoinPoint joinPoint, LoggerManage loggerManage, Exception ex) {
            logger.error("执行--" + loggerManage.description() + "--异常", ex);
        }
    
        private String parseParames(Object[] parames) {
            if (null == parames || parames.length <= 0) {
                return "";
            }
            StringBuffer param = new StringBuffer("参数--");
            for (Object obj : parames) {
                String va = ToStringBuilder.reflectionToString(obj);
                param.append(va).append("  ");
            }
            return param.toString();
        }
    }
    
    

    Spring AOP支持在切入点表达式中使用如下的切入点指示符:

    execution - 匹配方法执行的连接点,这是你将会用到的Spring的最主要的切入点指示符。

    within - 限定匹配特定类型的连接点(在使用Spring AOP的时候,在匹配的类型中定义的方法的执行)。

    this - 限定匹配特定的连接点(使用Spring AOP的时候方法的执行),其中bean reference(Spring AOP 代理)是指定类型的实例。

    target - 限定匹配特定的连接点(使用Spring AOP的时候方法的执行),其中目标对象(被代理的应用对象)是指定类型的实例。

    args - 限定匹配特定的连接点(使用Spring AOP的时候方法的执行),其中参数是指定类型的实例。

    @target - 限定匹配特定的连接点(使用Spring AOP的时候方法的执行),其中正执行对象的类持有指定类型的注解。

    @args - 限定匹配特定的连接点(使用Spring AOP的时候方法的执行),其中实际传入参数的运行时类型持有指定类型的注解。

    @within - 限定匹配特定的连接点,其中连接点所在类型已指定注解(在使用Spring AOP的时候,所执行的方法所在类型已指定注解)。

    @annotation - 限定匹配特定的连接点(使用Spring AOP的时候方法的执行),其中连接点的主题持有指定的注解。

    4.设置log文件位置

    application.properties:

    logging.file=./demo.log
    logging.level.com.example.demo=INFO
    logging.level.org.springframework.web=INFO
    logging.level.org.hibernate=ERROR
    

    访问http://localhost:8080/index?userID=sadfieg3&age=129
    结果如下

    : 执行--获取用户名--开始
    : String com.example.demo.IndexController.getUserName(String,Integer)
    : 参数--java.lang.String@250928e9[value={s,a,d,f,i,e,g,3},hash=1708579352]  java.lang.Integer@ded028e[value=129]  
    : 执行--获取用户名--结束
    : 执行时间--20
    

    相关文章

      网友评论

        本文标题:SpringBoot 使用AOP统一处理web请求日志

        本文链接:https://www.haomeiwen.com/subject/ymyccxtx.html