介紹

APT(Annotation Processing Tool)即注解處理器才避，是一種處理注解的工具，確切的說它是javac的一個(gè)工具什燕，它用來在編譯時(shí)掃描和處理注解捺宗。注解處理器以Java代碼(或者編譯過的字節(jié)碼)作為輸入，生成.java文件作為輸出钩蚊。
簡(jiǎn)單來說就是在編譯期贡翘，通過注解生成.java文件。

作用

使用APT的優(yōu)點(diǎn)就是方便砰逻、簡(jiǎn)單鸣驱，可以少些很多重復(fù)的代碼。

用過ButterKnife蝠咆、Dagger踊东、EventBus等注解框架的同學(xué)就能感受到，利用這些框架可以少些很多代碼刚操，只要寫一些注解就可以了闸翅。
其實(shí)，他們不過是通過注解菊霜，生成了一些代碼坚冀。通過對(duì)APT的學(xué)習(xí)，你就會(huì)發(fā)現(xiàn)鉴逞，他們很強(qiáng)~~~

實(shí)現(xiàn)

說了這么多记某，動(dòng)手試試

目標(biāo)
通過APT實(shí)現(xiàn)一個(gè)功能，通過對(duì)View變量的注解构捡，實(shí)現(xiàn)View的綁定（類似于ButterKnife中的@BindView）

（參考自這里）

創(chuàng)建項(xiàng)目
創(chuàng)建Android Module命名為app
創(chuàng)建Java library Module命名為 apt-annotation
創(chuàng)建Java library Module命名為 apt-processor 依賴 apt-annotation
創(chuàng)建Android library Module 命名為apt-library依賴 apt-annotation液南、auto-service

結(jié)構(gòu)如下

功能主要分為三個(gè)部分

• apt-annotation：自定義注解，存放@BindView
• apt-processor：注解處理器勾徽，根據(jù)apt-annotation中的注解滑凉，在編譯期生成xxxActivity_ViewBinding.java代碼
• apt-library：工具類，調(diào)用xxxActivity_ViewBinding.java中的方法，實(shí)現(xiàn)View的綁定譬涡。

關(guān)系如下

app闪幽？app不是功能代碼啥辨，只是用來驗(yàn)證功能的~~~

1涡匀、apt-annotation（自定義注解）

創(chuàng)建注解類BindView

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface BindView {
    int value();
}

@Retention(RetentionPolicy.CLASS)：表示編譯時(shí)注解
@Target(ElementType.FIELD)：表示注解范圍為類成員（構(gòu)造方法、方法溉知、成員變量）

@Retention： 定義被保留的時(shí)間長(zhǎng)短
RetentionPoicy.SOURCE陨瘩、RetentionPoicy.CLASS、RetentionPoicy.RUNTIME
@Target： 定義所修飾的對(duì)象范圍
TYPE级乍、FIELD舌劳、METHOD、PARAMETER玫荣、CONSTRUCTOR甚淡、LOCAL_VARIABLE等
詳細(xì)內(nèi)容

這里定義了運(yùn)行時(shí)注解BindView，其中value()用于獲取對(duì)應(yīng)View的id捅厂。

2贯卦、apt-processor（注解處理器）

(重點(diǎn)部分)

在Module中添加依賴

dependencies {
    implementation 'com.google.auto.service:auto-service:1.0-rc2' 
    // Gradle 5.0后需要再加下面這行
    // annotationProcessor  'com.google.auto.service:auto-service:1.0-rc2' 
    implementation project(':apt-annotation')
}

Android Studio升級(jí)到3.0以后，Gradle也隨之升級(jí)到3.0焙贷。implementation替代了之前的compile

創(chuàng)建BindViewProcessor

@AutoService(Processor.class)
public class BindViewProcessor extends AbstractProcessor {

    private Messager mMessager;
    private Elements mElementUtils;
    private Map<String, ClassCreatorProxy> mProxyMap = new HashMap<>();

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        mMessager = processingEnv.getMessager();
        mElementUtils = processingEnv.getElementUtils();
    }

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        HashSet<String> supportTypes = new LinkedHashSet<>();
        supportTypes.add(BindView.class.getCanonicalName());
        return supportTypes;
    }

    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnv) {
        //根據(jù)注解生成Java文件
        return false;
    }
}

• init：初始化撵割。可以得到ProcessingEnviroment辙芍，ProcessingEnviroment提供很多有用的工具類Elements, Types 和 Filer
• getSupportedAnnotationTypes：指定這個(gè)注解處理器是注冊(cè)給哪個(gè)注解的啡彬，這里說明是注解BindView
• getSupportedSourceVersion：指定使用的Java版本，通常這里返回SourceVersion.latestSupported()
• process：可以在這里寫掃描故硅、評(píng)估和處理注解的代碼庶灿，生成Java文件（process中的代碼下面詳細(xì)說明）

@AutoService(Processor.class)
public class BindViewProcessor extends AbstractProcessor {

    private Messager mMessager;
    private Elements mElementUtils;
    private Map<String, ClassCreatorProxy> mProxyMap = new HashMap<>();

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        mMessager.printMessage(Diagnostic.Kind.NOTE, "processing...");
        mProxyMap.clear();
        //得到所有的注解
        Set<? extends Element> elements = roundEnvironment.getElementsAnnotatedWith(BindView.class);
        for (Element element : elements) {
            VariableElement variableElement = (VariableElement) element;
            TypeElement classElement = (TypeElement) variableElement.getEnclosingElement();
            String fullClassName = classElement.getQualifiedName().toString();
            ClassCreatorProxy proxy = mProxyMap.get(fullClassName);
            if (proxy == null) {
                proxy = new ClassCreatorProxy(mElementUtils, classElement);
                mProxyMap.put(fullClassName, proxy);
            }
            BindView bindAnnotation = variableElement.getAnnotation(BindView.class);
            int id = bindAnnotation.value();
            proxy.putElement(id, variableElement);
        }
        //通過遍歷mProxyMap，創(chuàng)建java文件
        for (String key : mProxyMap.keySet()) {
            ClassCreatorProxy proxyInfo = mProxyMap.get(key);
            try {
                mMessager.printMessage(Diagnostic.Kind.NOTE, " --> create " + proxyInfo.getProxyClassFullName());
                JavaFileObject jfo = processingEnv.getFiler().createSourceFile(proxyInfo.getProxyClassFullName(), proxyInfo.getTypeElement());
                Writer writer = jfo.openWriter();
                writer.write(proxyInfo.generateJavaCode());
                writer.flush();
                writer.close();
            } catch (IOException e) {
                mMessager.printMessage(Diagnostic.Kind.NOTE, " --> create " + proxyInfo.getProxyClassFullName() + "error");
            }
        }

        mMessager.printMessage(Diagnostic.Kind.NOTE, "process finish ...");
        return true;
    }
}

通過roundEnvironment.getElementsAnnotatedWith(BindView.class)得到所有注解elements吃衅，然后將elements的信息保存到mProxyMap中往踢，最后通過mProxyMap創(chuàng)建對(duì)應(yīng)的Java文件，其中mProxyMap是ClassCreatorProxy的Map集合捐晶。

ClassCreatorProxy是創(chuàng)建Java代碼的代理類菲语，如下：

public class ClassCreatorProxy {
    private String mBindingClassName;
    private String mPackageName;
    private TypeElement mTypeElement;
    private Map<Integer, VariableElement> mVariableElementMap = new HashMap<>();

    public ClassCreatorProxy(Elements elementUtils, TypeElement classElement) {
        this.mTypeElement = classElement;
        PackageElement packageElement = elementUtils.getPackageOf(mTypeElement);
        String packageName = packageElement.getQualifiedName().toString();
        String className = mTypeElement.getSimpleName().toString();
        this.mPackageName = packageName;
        this.mBindingClassName = className + "_ViewBinding";
    }

    public void putElement(int id, VariableElement element) {
        mVariableElementMap.put(id, element);
    }

    /**
     * 創(chuàng)建Java代碼
     * @return
     */
    public String generateJavaCode() {
        StringBuilder builder = new StringBuilder();
        builder.append("package ").append(mPackageName).append(";\n\n");
        builder.append("import com.example.gavin.apt_library.*;\n");
        builder.append('\n');
        builder.append("public class ").append(mBindingClassName);
        builder.append(" {\n");

        generateMethods(builder);
        builder.append('\n');
        builder.append("}\n");
        return builder.toString();
    }

    /**
     * 加入Method
     * @param builder
     */
    private void generateMethods(StringBuilder builder) {
        builder.append("public void bind(" + mTypeElement.getQualifiedName() + " host ) {\n");
        for (int id : mVariableElementMap.keySet()) {
            VariableElement element = mVariableElementMap.get(id);
            String name = element.getSimpleName().toString();
            String type = element.asType().toString();
            builder.append("host." + name).append(" = ");
            builder.append("(" + type + ")(((android.app.Activity)host).findViewById( " + id + "));\n");
        }
        builder.append("  }\n");
    }

    public String getProxyClassFullName()
    {
        return mPackageName + "." + mBindingClassName;
    }

    public TypeElement getTypeElement()
    {
        return mTypeElement;
    }
}

上面的代碼主要就是從Elements、TypeElement得到想要的一些信息惑灵，如package name山上、Activity名、變量類型英支、id等佩憾，通過StringBuilder一點(diǎn)一點(diǎn)拼出Java代碼，每個(gè)對(duì)象分別代表一個(gè)對(duì)應(yīng)的.java文件。

沒想到吧妄帘！Java代碼還可以這樣寫~~
提前看下生成的代碼（不大整齊楞黄，被我格式化了）

public class MainActivity_ViewBinding {
    public void bind(com.example.gavin.apttest.MainActivity host) {
        host.mButton = (android.widget.Button) (((android.app.Activity) host).findViewById(2131165218));
        host.mTextView = (android.widget.TextView) (((android.app.Activity) host).findViewById(2131165321));
    }
}

缺陷
通過StringBuilder的方式一點(diǎn)一點(diǎn)來拼寫Java代碼，不但繁瑣還容易寫錯(cuò)~~

更好的方案
通過javapoet可以更加簡(jiǎn)單得生成這樣的Java代碼抡驼。(后面會(huì)說到）

介紹下依賴庫auto-service
在使用注解處理器需要先聲明鬼廓，步驟：
1、需要在 processors 庫的 main 目錄下新建 resources 資源文件夾致盟；
2碎税、在 resources文件夾下建立 META-INF/services 目錄文件夾；
3馏锡、在 META-INF/services 目錄文件夾下創(chuàng)建 javax.annotation.processing.Processor 文件雷蹂；
4、在 javax.annotation.processing.Processor 文件寫入注解處理器的全稱杯道，包括包路徑匪煌；）
這樣聲明下來也太麻煩了？這就是用引入auto-service的原因党巾。
通過auto-service中的@AutoService可以自動(dòng)生成AutoService注解處理器是Google開發(fā)的萎庭，用來生成 META-INF/services/javax.annotation.processing.Processor 文件的

3、apt-library 工具類

完成了Processor的部分昧港，基本快大功告成了擎椰。

在BindViewProcessor中創(chuàng)建了對(duì)應(yīng)的xxxActivity_ViewBinding.java，我們改怎么調(diào)用创肥？當(dāng)然是反射啦４锸妗！叹侄！

在Module的build.gradle中添加依賴

dependencies {
    implementation project(':apt-annotation')
}

創(chuàng)建注解工具類BindViewTools

public class BindViewTools {

    public static void bind(Activity activity) {

        Class clazz = activity.getClass();
        try {
            Class bindViewClass = Class.forName(clazz.getName() + "_ViewBinding");
            Method method = bindViewClass.getMethod("bind", activity.getClass());
            method.invoke(bindViewClass.newInstance(), activity);
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InstantiationException e) {
            e.printStackTrace();
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        }
    }
}

apt-library的部分就比較簡(jiǎn)單了巩搏，通過反射找到對(duì)應(yīng)的ViewBinding類，然后調(diào)用其中的bind()方法完成View的綁定趾代。

到目前為止贯底，所有相關(guān)的代碼都寫完了，終于可以拿出來溜溜了

4撒强、app

依賴
在Module的 build.gradle中（Gradle>=2.2）

dependencies {
    implementation project(':apt-annotation')
    implementation project(':apt-library')
    annotationProcessor project(':apt-processor')
}

Android Gradle 插件 2.2 版本的發(fā)布禽捆，Android Gradle 插件提供了名為 annotationProcessor的功能來完全代替 android-apt

（若Gradle<2.2）
在Project的 build.gradle中：

buildscript {
    dependencies {
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'  
    }
}

在Module的buile.gradle中：

apply plugin: 'com.android.application'
apply plugin: 'com.neenbedankt.android-apt'
dependencies {
    apt project(':apt-processor')
}

使用
在MainActivity中，在View的前面加上BindView注解飘哨，把id傳入即可

public class MainActivity extends AppCompatActivity {

    @BindView(R.id.tv)
    TextView mTextView;
    @BindView(R.id.btn)
    Button mButton;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        BindViewTools.bind(this);
        mTextView.setText("bind TextView success");
        mButton.setText("bind Button success");
    }
}

運(yùn)行的結(jié)果想必大家都知道了胚想，不夠?yàn)榱俗C明這個(gè)BindView的功能完成了，我還是把圖貼出來

結(jié)果

生成的代碼

上面的功能一直在完成一件事情芽隆，那就是生成Java代碼浊服，那么生成的代碼在哪统屈？
在app/build/generated/source/apt中可以找到生成的Java文件

目錄

public class MainActivity_ViewBinding {
    public void bind(com.example.gavin.apttest.MainActivity host) {
        host.mButton = (android.widget.Button) (((android.app.Activity) host).findViewById(2131165218));
        host.mTextView = (android.widget.TextView) (((android.app.Activity) host).findViewById(2131165321));
    }
}

通過javapoet生成代碼

上面在ClassCreatorProxy中，通過StringBuilder來生成對(duì)應(yīng)的Java代碼牙躺。這種做法是比較麻煩的愁憔，還有一種更優(yōu)雅的方式，那就是javapoet孽拷。

先添加依賴

dependencies {
    implementation 'com.squareup:javapoet:1.10.0'
}

然后在ClassCreatorProxy中

public class ClassCreatorProxy {
    //省略部分代碼...

    /**
     * 創(chuàng)建Java代碼
     * @return
     */
    public TypeSpec generateJavaCode2() {
        TypeSpec bindingClass = TypeSpec.classBuilder(mBindingClassName)
                .addModifiers(Modifier.PUBLIC)
                .addMethod(generateMethods2())
                .build();
        return bindingClass;

    }

    /**
     * 加入Method
     */
    private MethodSpec generateMethods2() {
        ClassName host = ClassName.bestGuess(mTypeElement.getQualifiedName().toString());
        MethodSpec.Builder methodBuilder = MethodSpec.methodBuilder("bind")
                .addModifiers(Modifier.PUBLIC)
                .returns(void.class)
                .addParameter(host, "host");

        for (int id : mVariableElementMap.keySet()) {
            VariableElement element = mVariableElementMap.get(id);
            String name = element.getSimpleName().toString();
            String type = element.asType().toString();
            methodBuilder.addCode("host." + name + " = " + "(" + type + ")(((android.app.Activity)host).findViewById( " + id + "));");
        }
        return methodBuilder.build();
    }


    public String getPackageName() {
        return mPackageName;
    }
}

最后在 BindViewProcessor中

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        //省略部分代碼...
        //通過javapoet生成
        for (String key : mProxyMap.keySet()) {
            ClassCreatorProxy proxyInfo = mProxyMap.get(key);
            JavaFile javaFile = JavaFile.builder(proxyInfo.getPackageName(), proxyInfo.generateJavaCode2()).build();
            try {
                //　生成文件
                javaFile.writeTo(processingEnv.getFiler());
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        mMessager.printMessage(Diagnostic.Kind.NOTE, "process finish ...");
        return true;
    }

相比用StringBuilder拼Java代碼吨掌，明顯簡(jiǎn)潔和很多。最后生成的代碼跟之前是一樣的乓搬，就不貼出來了思犁。

javapoet詳細(xì)用法

Tips

1、如果是ElementType.METHOD類型的注解进肯，解析Element時(shí)使用ExecutableElement，而不是Symbol.MethodSymbol棉磨，否則編譯運(yùn)行的時(shí)候沒問題江掩，打包的時(shí)候會(huì)報(bào)錯(cuò)。別問我時(shí)為什么知道的...

2乘瓤、gradle升級(jí)到3.4.0以后环形，AutoService要這么用

implementation 'com.google.auto.service:auto-service:1.0-rc2'
annotationProcessor  'com.google.auto.service:auto-service:1.0-rc2' 

源碼

GitHub

參考

編譯期注解之APT
詳細(xì)介紹編譯時(shí)注解的使用方法
Android 編譯時(shí)注解-提升
Android APT及基于APT的簡(jiǎn)單應(yīng)用
Android 打造編譯時(shí)注解解析框架 這只是一個(gè)開始
你必須知道的APT、annotationProcessor衙傀、android-apt抬吟、Provided、自定義注解

以上有錯(cuò)誤之處统抬，感謝指出