背景

在做性能分析时，API的执行时间是一个显著的指标，这里使用SpringBoot AOP的方式，通过对接口添加简单注解的方式来打印API的执行时间，进而对API性能加以评估。关于Spring AOP的配置，详见Spring Boot AOP 配置。

步骤

1. 声明注解 Time.java

/**
 * @author : rain
 * @date : 2018/8/9 7:24 AM
 *
 * 时间记录annotation
 * 标注需要记录时间消耗的方法
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Timer {
}

2. 声明切面 TimeAspect.java

/**
 * @author : rain
 * @date : 2018/8/9 6:38 AM
 * 时间记录切面，收集接口的运行时间
 */
@Aspect
@Component
public class TimeAspect {

    // 修正Timer注解的全局唯一限定符
    @Pointcut("@annotation(com.rainlf.aop.timer.Timer)")
    private void pointcut() {}

    @Around("pointcut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        // 获取目标Logger
        Logger logger = LoggerFactory.getLogger(joinPoint.getTarget().getClass());

        // 获取目标类名称
        String clazzName = joinPoint.getTarget().getClass().getName();

        // 获取目标类方法名称
        String methodName = joinPoint.getSignature().getName();

        long start = System.currentTimeMillis();
        logger.info( "{}: {}: start...", clazzName, methodName);

        // 调用目标方法
        Object result = joinPoint.proceed();

        long time = System.currentTimeMillis() - start;
        logger.info( "{}: {}: : end... cost time: {} ms", clazzName, methodName, time);

        return result;
    }
}

3. 使用时，在目标方式上加上@Timer即可。

@Timer
public void test() {
    // do something ...
}

备注

如果不使用AOP，可简单添加如下代码。

// 获取毫秒数
long startTime = System.currentTimeMillis();   //获取开始时间
System.out.println("Start...");
doSomeThing();  //测试的代码段
long endTime = System.currentTimeMillis();   //获取结束时间
System.out.println("End... Time cost: " + (endTime - startTime) + "ms");
 
// 获取纳秒数
long startTime = System.nanoTime();   //获取开始时间
System.out.println("Start...");
doSomeThing();  //测试的代码段
long endTime = System.nanoTime();   //获取结束时间
System.out.println("End... Time cost: " + (endTime - startTime) + "ns");