Using custom annotations, statistical method execution time

The project needs to count the execution time of some methods,The easiest way is to record the timestamp before the method executesstartTime,在方法结束前,用时间戳endTime-startTimeIt is time consuming to derive this method.
But in order to avoid codeless intrusion and achieve general purpose,So define an annotation,Which method to count,Just write an annotation on the method,The parameters of the method can be obtained through annotations、方法名、返回值等等信息.

Below is a simple implementation of time statistics：

1.定义一个注解TimeConsume

This annotation has a defaultvalue属性,valueThe value is a method name or a custom description

@Target({
    ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface TimeConsume {
    

	String value() default "方法";
}

2.使用AspectDefines the aspect of this annotationTimeConsumeAspect

定义好注解后,The class used for this annotation needs to be monitored,利用Spring框架Aspect实现切面,定义环绕通知,获取到方法的参数、方法名等信息,To facilitate statistical needs.Exception catch for execution method,在finallyThe time statistics logic is implemented in the code block,Avoid method exceptions that cannot be counted.代码如下：

@Slf4j
@Component
@Aspect
public class TimeConsumeAspect {
    

 /** * Pointcuts are defined as [email protected](Annotation classpath) */
   @Pointcut("@annotation(com.weiller.demo.common.annotation.TimeConsume)")
    public void consume(){
    
    }

    @Around("consume()")
    public  <T> T around(ProceedingJoinPoint pjp) throws Throwable {
    
        Long startTime = System.currentTimeMillis();
   
        Object[] args = pjp.getArgs();
        T result;
        Method methodClass;
        try {
    

            result = (T)pjp.proceed(args);//执行方法

        }finally {
    
            long endTime = System.currentTimeMillis();
            Signature signature = pjp.getSignature();
            String methodName = signature.getName();
            Class<?> targetClass = pjp.getTarget().getClass();
            Class[] parameterTypes = ((MethodSignature) pjp.getSignature()).getParameterTypes();
            methodClass = targetClass.getMethod(methodName, parameterTypes);
            Annotation[] annotations = methodClass.getAnnotations();
            for (Annotation annotation : annotations){
    
                Class<? extends Annotation> aClass = annotation.annotationType();
                String simpleName = aClass.getSimpleName();
                if("TimeConsume".equals(simpleName)){
    
                    TimeConsume timeConsume = (TimeConsume) annotation;
                    String value = timeConsume.value();
                    log.info(value+"[{}] 执行耗时：{}ms",methodName,endTime-startTime);
                    break;
                }
            }

        }

        return result;
    }
}

3.used in the test target method

@RestController
@RequestMapping("/test")
public class testController {
    

    @TimeConsume("测试")
    @GetMapping("info")
    public Object testInfo(){
    
        Object parse = JSONObject.parse("{\n" +
                "\t\t\"requestId\":\"\",\n" +
                "\t\t\"appId\":\"\",\n" +
                "\t\t\"nonce\":\"\",\n" +
                "\t\t\"timestamp\":12345676543,\n" +
                "\t\t\"signature\":\"\",\n" +
                "\t\t\"sjgsd\":\"61000\",\n" +
                "\t\t\"starTime\":12345676543\n" +
                "\t}");
        try {
    
            Thread.sleep(new Random().nextInt(100));//Sleep at random time
        } catch (InterruptedException e) {
    
            e.printStackTrace();
        }
        return parse ;
    }
}