一、概述

APT(Annotation Processing Tool)即注解處理器，他是javac的一個工具，用來在編譯期時掃描和處理注解，在開發(fā)中可以自定義注解，并通過APT搞一些事情，例如在Android中的ButterKnife，EventBus都使用了APT。

二、APT基本使用

來一個簡單的例子，我在Activity中加上自定義注解，通過APT查看哪些Activity使用了這個自定義注解。
事前準(zhǔn)備：兩個Java Libary，一個用來存放注解，另一個用來存放注解處理器。

1. apt_annotation：用來存放注解。
2. apt_processor：用來存放注解處理器。

2.1 創(chuàng)建注解

APT是注解處理器，所以我們需要創(chuàng)建一個自定義注解。先在Android Studio中創(chuàng)建一個Java Libary(apt_annotation)用來存放注解。并在其中自定義一個注解，名為TestAnnotation。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}

2.2 創(chuàng)建注解處理器

在Android Studio中再創(chuàng)建一個Java Libary，用來存放注解處理器。build.grale文件中添加如下依賴：

dependencies {
    //依賴上注解module
    implementation project(":apt_annotation")
    //谷歌提供的自動注冊服務(wù)
    implementation 'com.google.auto.service:auto-service:1.0-rc4'
    annotationProcessor 'com.google.auto.service:auto-service:1.0-rc4'
    //生成java代碼庫
    implementation 'com.squareup:javapoet:1.10.0'
}

然后再來創(chuàng)建我們的注解處理器代碼如下：

//必須添加
@AutoService(Processor.class)
//需要處理的注解 = getSupportedAnnotationTypes()方法
@SupportedAnnotationTypes({"com.example.apt_annotation.TestAnnotation"})
//編譯版本 = getSupportedSourceVersion()
@SupportedSourceVersion(SourceVersion.RELEASE_8)
//必須繼承AbstractProcessor
public class TestProcessor extends AbstractProcessor {
    //日志控制
    private Messager mMessager;

    //存儲Activity列表
    private List<String> activityList;

    //輸出
    private Filer filer;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        //初始化
        mMessager = processingEnv.getMessager();
        activityList = new ArrayList<>();
        filer = processingEnv.getFiler();
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        return false;
    }
}

這個類上有三個注解：

1. @AutoService(Processor.class) 常規(guī)操作，必須添加。
2. @SupportedAnnotationTypes({"com.example.apt_annotation.TestAnnotation"}) 支持處理的注解的全類名，也可以通過重寫getSupportedAnnotationTypes()方法來設(shè)置。
3. @SupportedSourceVersion(SourceVersion.RELEASE_8) 編譯版本，可以通過重寫getSupportedSourceVersion()方法來設(shè)置。

三個變量：

1. mMessager：Messager對象，用來控制日志輸出。
2. activityList：用來存儲標(biāo)記了注解的類。
3. filer：Filer對象，在動態(tài)生成類文件時會用到。

接下來的重點(diǎn)就是在process方法中，這里來寫注解的處理邏輯，代碼如下：

    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        if (annotations.isEmpty()){
            return false;
        }
        mMessager.printMessage(Diagnostic.Kind.NOTE,"Process...");
        activityList.clear();
        //獲取使用了TestAnnotation注解的類
        Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(TestAnnotation.class);
        for (Element element : elements) {
            //強(qiáng)轉(zhuǎn)成TypeElement
            TypeElement typeElement = (TypeElement) element;
            //獲取全類名
            String fullName = typeElement.getQualifiedName().toString();
            //打印一下全類名
            mMessager.printMessage(Diagnostic.Kind.NOTE,fullName);
            //把類名加到list
            activityList.add(fullName);
        }
        mMessager.printMessage(Diagnostic.Kind.NOTE,"Finish...");
        return true;
    }

到這里自定義和自定義注解都寫完了，
先在app模塊下依賴這兩個Libary：

implementation project(":apt_annotation")
annotationProcessor project(":apt_processor")

接著來驗(yàn)證一下，我在我的MainActivity上添加TestAnnotation注解，看看mMessager會不會把類名打印出來。

圖1.png

成功打印，大功告成。你以為這就完了？不不不，還差點(diǎn)。雖然我們拿到了標(biāo)記了TestAnnotation注解的類，但是我們怎么調(diào)用呢？繼續(xù)往下看。

2.3 使用JavaPoet動態(tài)生成類

javapoet是square提供的一個庫，就是用來生成java代碼的。沒有用過的朋友可以看一下官方文檔，這里就不著重介紹了。
前面我們通過注解處理器拿到了使用了注解的類，接下來通過JavaPoet來動態(tài)生成java文件，并在里面提供獲取標(biāo)記了注解的類名的方法，代碼如下：

        //動態(tài)生成文件 public MyUtils{}
        TypeSpec typeSpec = TypeSpec.classBuilder("MyUtils")
                .addModifiers(Modifier.PUBLIC)
                .addMethod(createGetListFun())//添加方法
                .build();
        //設(shè)置路徑
        JavaFile javaFile = JavaFile.builder("com.example.apt",typeSpec).build();
        try {
            javaFile.writeTo(filer);
        } catch (IOException e) {
            e.printStackTrace();
        }

        //創(chuàng)建方法
        private MethodSpec createGetListFun(){
            ClassName className = ClassName.get("java.util","ArrayList");
            //返回值類型
            TypeName typeName = ParameterizedTypeName.get(List.class,String.class);
            //生成方法 public static typeName getList (){ 方法體 }
            MethodSpec.Builder builder = MethodSpec.methodBuilder("getList")
                    .addModifiers(Modifier.PUBLIC,Modifier.STATIC)
                    .returns(typeName);
            //添加方法體
            builder.addStatement("$T result = new $T<>()",typeName,className);
            for (String s : activityList) {
                builder.addStatement("result.add(\"" + s + "\")");
            }
            builder.addStatement("return result");
            return builder.build();
    }

至此動態(tài)生成代碼已經(jīng)碼好，我們編譯一下看看有沒有生成對應(yīng)的類。

圖2.png

可以看到，在build目錄下成功生成了名為MyUtils的類以及對應(yīng)的方法，我們可以直接通過MyUtils.getList()來調(diào)用，也可以通過Java反射來調(diào)用。

通過反射來調(diào)用：

        try {
            Class<?> classz = Class.forName("com.example.apt.MyUtils");
            Method method = classz.getDeclaredMethod("getList");
            method.setAccessible(true);
            List<String> list =(List<String>) method.invoke(null);
            for (String s : list) {
                Log.e("====",s);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }

        輸出：com.example.codeduan.Activity.MainActivity

這里才算大功告成啦。

三、總結(jié)

本文介紹了APT注解處理器的簡單使用，通過自定義注解+APT+JavaPoet實(shí)現(xiàn)了處理注解和動態(tài)生成類，最后并使用反射調(diào)用類的方法。這基本上就是一個簡單的例子。為了鞏固一下，看完的你可以試著寫一個類似于黃油刀的View綁定的例子?？鞌]起袖子試試吧。有不懂的地方可以一起交流哦。