Spring AOP 注解打印 方法执行时间

问题

工作上经常遇到一些响应很慢的接口,例如我在做营销引擎时,遇到多个规则在一个定时器里,这个定时器的运行时间突然暴增。所以我想定位一下是哪条规则执行了这么长时间?

简单解决方法

  1. 最基础的用法,通过系统时间
long start = System.currentTimeMillis();
// doSomthing
long spentTime = System.currentTimeMillis() -start;

2、使用spring封装的类

StopWatch stopWatch = new StopWatch();
stopWatch.start();
// doSomthing        
stopWatch.stop();
stopWatch.getTotalTimeMillis();

分析

以上的解决方法是最常用的,也是我一开始使用的,但当我遇到多个规则要打印时间,会发现有很多重复的代码,很不美观,费力不讨好。这时候我想到了面向切面编程(AOP),通过注解的方式打印时间。

切面使用场景

我们知道有面向对象编程(OOP),面想接口编程(IOP),它们其实都是相辅相成的,面向切面编程让程序员能专注于核心业务开发,像一些辅助功能:性能检测,权限问题,日志打印,运行时间,事务等等,这些不涉及业务开发,但又不想遍地都是一样的代码,可以用AOP实现

例子

好的,有了以上的了解,现在让我们看看AOP怎么实现注解打印方法执行时间吧

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ExecuteTime {
    String name() default "";
}

想通过注解方式打印,首先先得写个注解

@Aspect
@Component
public class ExecuteTimeAspect {

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

    @Pointcut("@annotation(executeTime)")
    public void serviceExecutionTimeLog(ExecuteTime executeTime) {
    }


    @Around(value = "serviceExecutionTimeLog(executeTime)", argNames = "proceedingJoinPoint,executeTime")
    public Object doAfter(ProceedingJoinPoint proceedingJoinPoint, ExecuteTime executeTime) throws Throwable {
        StopWatch stopWatch = new StopWatch();
        stopWatch.start();
        Object proceed = proceedingJoinPoint.proceed();
        stopWatch.stop();

        logger.info("execute-time-name : [{}], execution-time : [{}], class-method : [{}]", executeTime.name(),
                stopWatch.getTotalTimeMillis(),
                proceedingJoinPoint.getTarget().getClass().getName() + "." + proceedingJoinPoint.getSignature().getName());


        return proceed;
    }
}
  1. 先定义一个切面 apsect
  2. 定义切点 pointcut ,描述哪些join point(方法的连接点)需要被执行,这里是通过注解的方式才被执行,你也可以有其它的描述方式定义你的切点范围
  3. 定义执行方法前后要执行的相关操作 around 。 其中,Object proceed = proceedingJoinPoint.proceed(); 表示函数执行,它的前后我用开始时间和结束时间围住,
  4. 最后打印 执行自定义名字(自己起个名字,便于线上快速批量打印你想看的数据),执行方法名字和执行的时间
@Override
@ExecuteTime(name = "user-defined")
public void calculate(){
// TODO
}

在实现的接口上去注解就能使用了

衍生问题

  1. 我想看看spring 事务注解 源码如何实现?

参考

  1. https://segmentfault.com/a/1190000007469982#articleHeader2
  2. https://www.jianshu.com/p/7b072f31bd1d

如果你有不同的想法,欢迎留言讨论

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容