編寫最基本的APT Demo

時間 2019-11-21

標籤編寫基本 apt demo 简体版

原文原文鏈接

簡介

APT，就是Annotation Processing Tool 的簡稱，簡單來講就是經過編碼來動態獲得解析Annotation的工具。通常分爲兩類：
1.運行時註解：好比大名鼎鼎的retrofit就是用運行時註解，經過動態代理來生成網絡請求
2.編譯時註解：好比Dagger2, ButterKnife, EventBus3java

代碼實現

這裏咱們要實現一個怎樣的功能呢？第一個就是給咱們的activity添加一個@Flag，而後當咱們編譯的時候就會生成一個java main函數。第二個就是我簡易版的butterknife。2個註解都是寫在用一個插件中。好了下面直接開始。bash

Annotation module

首先咱們建立一個my_annotation的java module，這個項目只放咱們的註解文件，不涉及到註解處理等其餘邏輯，關於註解處理咱們會新建一個module來處理。項目結構以下：
網絡

其中build.gradle中基本不用修改，保持默認的配置就能夠，以下：

Flag註解

就是這麼簡單，關於註解中元註解的解釋請參考個人另外一篇文章：元註解簡介
關於註解module就到這了。

註解處理 module

首先咱們建立一個my_compiler的java module。項目結構以下：
ide

build.gradle的配置以下：

簡單解釋下幾個dependencies

auto-service:這是google推出的方便咱們編寫annotation插件，在沒有這個這個庫以前，咱們須要對咱們的插件作不少的配置才能使用，有了這個庫之後就方便多了，下文會看到怎麼用，這裏就不介紹了。
javapoet:這是方便咱們在編譯時動態生成class文件的，下文也會有具體怎麼使用，這裏不作過多解釋。函數

關於上面2個庫你們感興趣能夠去查找相關資料進行進一步瞭解。下面咱們看下真正的註解處理類：工具

/**
 * @author Jin
 */
//來自auto-service 只要添加這個註解之後就不須要作其餘配置，如今已經能夠在項目中直接使用了
@AutoService(Processor.class)
public class FlagAnnotationProcessor extends AbstractProcessor {


    /**
     * getSupportedSourceVersion()方法返回 Java 版本 默認爲Java6
     *
     * @return Java 版本
     */
    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }

    /**
     * 返回要處理的註解的結合 這裏只處理RouterAnnotion類型的註解
     *
     * @return
     */
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        LinkedHashSet<String> types = new LinkedHashSet<>();
        types.add(Flag.class.getCanonicalName());
        return types;
    }

    /**
     * 註解的具體處理類
     *
     * @param annotations
     * @param roundEnv
     * @return
     */
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        //來自javapoet  動態生成方法
        MethodSpec main = MethodSpec.methodBuilder("main")
                .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
                .returns(void.class)
                .addParameter(String[].class, "args")
                .addStatement("$T.out.println($S)", System.class, "Hello, JavaPoet!")
                .build();
        //來自javapoet  動態生成類
        TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
                .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
                .addMethod(main)
                .build();
        //來自javapoet  動態生成文件
        JavaFile javaFile = JavaFile.builder("com.jin.helloworld", helloWorld)
                .build();
        try {
            javaFile.writeTo(processingEnv.getFiler());
        } catch (IOException e) {
            e.printStackTrace();
        }
        return true;
    }
}複製代碼

註解處理類已經寫好了，下面咱們看下怎麼關聯到咱們的項目中。gradle

註解使用

AndroidStudio3.0使用annotationProcessor來處理註解。

添加咱們的@Flag註解。ok。大功告成，下面從新編譯（rebuild project）一下咱們的項目，就會在build目錄下看到自動生成的代碼了。

你可能會說，生成一個HelloWorld main函數並木有什麼卵用啊，是的，可是你起碼掌握了最基本的關於Annotation項目的建立、編譯、使用了是否是，麻雀雖小可是五臟俱全啊。

下面進入咱們的另外一個demo，簡易版butterknife。ui

簡易版butterknife

下面我直接添上註解和處理代碼(相關解釋會在註釋中)：this

DIAnnotationProcessor

@AutoService(Processor.class)
public class DIAnnotationProcessor extends AbstractProcessor {
    private Filer mFiler;
    private Elements elementUtils;

    /**
     * init()方法能夠初始化拿到一些使用的工具，
     * 好比文件相關的輔助類 Filer;元素相關的輔助類Elements;日誌相關的輔助類Messager;
     *
     * @param processingEnv
     */
    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        mFiler = processingEnv.getFiler();
        elementUtils = processingEnv.getElementUtils();
    }

    /**
     * getSupportedSourceVersion()方法返回 Java 版本 默認爲Java6
     *
     * @return Java 版本
     */
    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }

    /**
     * 返回要處理的註解的結合 這裏只處理RouterAnnotion類型的註解
     *
     * @return
     */
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        LinkedHashSet<String> types = new LinkedHashSet<>();
        types.add(BindActivity.class.getCanonicalName());
        return types;
    }

    /**
     * 註解的具體處理類
     *
     * @param annotations
     * @param roundEnv
     * @return
     */
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        System.out.println("DIAnnotationProcessor");
        //獲得全部被Bind添加註解的類
        Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(BindActivity.class);
        for (Element element : elements) {
            //強制轉換成TypeElement 判斷是不是Class
            TypeElement typeElement = (TypeElement) element;
            //獲得typeElement類中全部成員變量和成員方法
            List<? extends Element> members = elementUtils.getAllMembers(typeElement);
            MethodSpec.Builder bindViewMethodSpecBuilder = MethodSpec.methodBuilder("bindView")
                    .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
                    .returns(TypeName.VOID)
                    .addParameter(ClassName.get(typeElement.asType()), "activity");
            for (Element item : members) {
                BindMyView bindView = item.getAnnotation(BindMyView.class);
                if (bindView == null) {
                    continue;
                }
                bindViewMethodSpecBuilder.addStatement(String.format("activity.%s = (%s) activity.findViewById(%s)", item.getSimpleName(), ClassName.get(item.asType()).toString(), bindView.value()));
            }

            TypeSpec typeSpec = TypeSpec.classBuilder("DI" + element.getSimpleName())
                    .superclass(TypeName.get(typeElement.asType()))
                    .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
                    .addMethod(bindViewMethodSpecBuilder.build())
                    .build();
            JavaFile javaFile = JavaFile.builder(getPackageName(typeElement), typeSpec).build();
            try {
                javaFile.writeTo(processingEnv.getFiler());
            } catch (IOException e) {
                e.printStackTrace();
            }

        }
        return true;
    }

    private String getPackageName(TypeElement type) {
        return elementUtils.getPackageOf(type).getQualifiedName().toString();
    }
}複製代碼

DI Annotation使用

注意此時必定要先rebuild project生成以下文件

而後在咱們的代碼中寫上

這裏ButterKnife.bind(this)是用來對比，請你們注意， DIMainActivity.bindView(this)纔是咱們直接生成的文件。

#調試（AndroidStudio3.0）已解決
若是過你也像我同樣按照網上的教程操做，可是始終報錯：Unable to open debugger port (localhost:5006): java.net.ConnectException "Connection refused: connect"
配置以下：
google

上面的配置代碼記得在全局的gradle.properties中添加該文件通常位於C:\Users\Jin.gradle下若是沒有親手動建立

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。