Spring实现自己的注解-AOP型（二）

接着上文，我们分析了@Async注解的实现原理，这一片文章我们来一步步实现一个自定义的注解。注解实现的功能很简单，记录一个方法的执行时间消耗，并且写入到日志中。在完全仿照@Async之前，我们先看看利用SpringBoot提供的Aspect去实现，同时输出一个可以提供给别的项目使用的spring-boot-starter工程。

定义注解

第一步很简单，我们依样画葫芦，定义一个我们自己的注解，命名为@TimeConsumeLogger。为了方便，我们先将这个注解限定在只能修饰方法上。

import java.lang.annotation.*;
import java.util.concurrent.TimeUnit;

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface TimeConsumeLogger {
    String   logTopic() default "";
    TimeUnit timeUnit() default TimeUnit.MILLISECONDS;
}

这个注解很简单，我们在打印时间消耗的日志的时候，对于一些我们已经预估到了的，非常耗时的方法，我们希望用秒级，或者分钟级来进行统计；同时对于一些可以预估到的应该非常快就处理完的方法，我们就应该用毫秒来统计。为了满足对时间颗粒度的控制，我们添加一个timeUnit注解参数。
在设计这个注解的时候我们还要考虑这个注解可能会使用不同的Logger去记录，因此，我们添加一个logTopic参数，用来控制使用哪一个Logger去打印日志。

使用SpringBootStarterAOP

新建一个工程，这个项目我们可以对外提供成为一个spring-boot-starter包，同时，我们需要引入SpringBootAOP，来实现切面变编程。

工程目录.png

整个工程的pom文件如下：

    4.0.0
    zsh.tools
    utils-helper-starter
    1.0.0-SNAPSHOT
    utils-helper
    
        mine.name.zsh
    
    
        
            [email protected]
        
    

    
        1.8
    

    
        
            org.springframework.boot
            spring-boot-configuration-processor
            true
            compile
        
        
            org.springframework.boot
            spring-boot-autoconfigure-processor
            compile
            true
        
        
            org.springframework.boot
            spring-boot-autoconfigure
            compile
        
        
            org.springframework.boot
            spring-boot-starter-aop
            compile
        
    

    
        
            
                org.springframework.boot
                spring-boot-dependencies
                2.1.6.RELEASE
                pom
                import
            
        
    

编写Aspect

接下来就应该定义我们的切面类了。我们既然自定义了注解，那么我们的切点就应该是所有被我们注解所修饰的方法。我们对切点的表达式需要做一点小修改，如下：

private final String POINT_CUT = "@annotation(zsh.tools.aop.anno.TimeConsumeLogger)";

上述的切点表达式定义了这个切点为匹配@TimeConsumeLogger所修饰的所有类或方法，我们这里将注解限定在方法上。
定义好切点之后，我们就要开始定义我们的通知（Advice）了。因为我们的的目标简单明确，只是记录一个时间消耗的记录，不会多做任何事情，那么，@Around这个通知是最合适的。@Around这个通知可以在执行完切入点逻辑之后继续执行方法本体，执行完方法本体后又可以继续执行切入点逻辑。

@Around(value=POINT_CUT)
public void doAroundAdvice(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {

    Signature signature = proceedingJoinPoint.getSignature();
    Method method = ((MethodSignature)signature).getMethod();
    // 获取注解参数
    TimeConsumeLogger annotation = method.getAnnotation(TimeConsumeLogger.class);
    Map attributesMap = AnnotationUtils.getAnnotationAttributes(annotation);
    String logTopic = (String) attributesMap.get("logTopic");
    TimeUnit timeUnit = (TimeUnit) attributesMap.get("timeUnit");

    if (logTopic.equals("")) {
        logTopic = proceedingJoinPoint.getTarget().getClass().toString();
    }
    Logger log = LoggerFactory.getLogger(logTopic);

    long s = System.currentTimeMillis();
    proceedingJoinPoint.proceed();
    long e = System.currentTimeMillis() - s;

    log.info( "{} -> COST: [{}] {}", method.toGenericString(), timeUnit.convert(e, TimeUnit.MILLISECONDS), timeUnit.name());
}

这个方法的第一步，我们需要获取切点所匹配的方法。获取到方法之后，我们解析这个方法上修饰的@TimeConsumeLogger注解，读取到注解的参数值。第三步，我们根据参数logTopic来获取slf4j.Logger，用timeUnit参数来获取时间单位。最后我们记录执行本体方法前后的时间，计算时间差，打印到日志中。

编写Starter配置

Starter配置也非常简单，我们的切面是要注册进Spring的Bean管理容器才能生效，因此，我们在Starter配置中定义一个TimeConsumeAspect的Bean，这样子就能使@TimeConsumeLogger注解生效了。

@Configuration
public class ZshToolsStarterAutoConfigure {
    @Bean
    @ConditionalOnMissingBean(TimeConsumeAspect.class)
    @ConditionalOnClass({
        org.slf4j.Logger.class,
        org.slf4j.LoggerFactory.class
    })
    public TimeConsumeAspect timeConsumeAspectBean() {
        return new TimeConsumeAspect();
    }
}

因为我们在通知中用到了slf4j的日志，因此，为了避免项目依赖中不存在slfj4而导致空指针的情况，加入一个@Conditional条件，如果不存在slf4j，我们的@TimeConsumeLogger就不生效
编写完Starter配置之后我们需要在工程的resources文件夹下加入一个 META-INF/spring.factories文件，敲入如下配置：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=zsh.tools.autoconfigure.ZshToolsStarterAutoConfigure

大功告成，接下来使用mvn clean install构建工程，结果会在本机的.m2目录下生成jar包

使用注解

新建一个工程，引入我们编译好的maven依赖，然后执行测试

    zsh.tools
    utils-helper-starter
    1.0.0-SNAPSHOT

@Component
public class TestComponent {

    @TimeConsumeLogger
    public void Filter a() {
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

    @TimeConsumeLogger(logTopic = "ZSH.LOGGERS")
    public void b() {
        try {
            Thread.sleep(1500);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

    @TimeConsumeLogger(logTopic = "ZSH.LOGGERS", timeUnit = TimeUnit.SECONDS)
    public void c() {
        try {
            Thread.sleep(2000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

可以看到日志已经打出来了

2019-08-02 18:47:29.129  INFO 887472 --- [           main] class zsh.demos.TestComponent       : public  void zsh.demos.TestComponent.a() -> COST: [1009] MILLISECONDS