安卓AOP三劍客: APT, AspectJ, Javassist

Android APT

APT(Annotation Processing Tool 的簡稱)，可以在程式碼編譯期解析註解，並且生成新的 Java 檔案，減少手動的程式碼輸入。現在有很多主流庫都用上了 APT，比如 Dagger2, ButterKnife, EventBus3 等

代表框架：

• DataBinding
• Dagger2
• ButterKnife
• EventBus3
• DBFlow
• AndroidAnnotation

專案參考

T-MVP

使用姿勢

1，在android工程中，建立一個java的Module，寫一個類繼承AbstractProcessor

    @AutoService(Processor.class) // javax.annotation.processing.IProcessor
    @SupportedSourceVersion(SourceVersion.RELEASE_7) //java
    @SupportedAnnotationTypes({ // 標註註解處理器支援的註解型別
        "com.annotation.SingleDelegate",
        "com.annotation.MultiDelegate"
    })
    public class AnnotationProcessor
 
 extends AbstractProcessor {

    public static final String PACKAGE = "com.poet.delegate";
    public static final String CLASS_DESC = "From poet compiler";

    public Filer filer; //檔案相關的輔助類
    public Elements elements; //元素相關的輔助類
    public Messager messager; //日誌相關的輔助類
    public Types types;

    @Override
 

    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        filer = processingEnv.getFiler();
        elements = processingEnv.getElementUtils();
        messager = processingEnv.getMessager();
        types = processingEnv.getTypeUtils();

        new SingleDelegateProcessor().process(set, roundEnvironment, this);
        new MultiDelegateProcessor().process(set, roundEnvironment, this);

        return true;
    }
    }

2，在繼承AbstractProcessor類中的process方法，處理我們自定義的註解，生成程式碼：

    public class SingleDelegateProcessor implements IProcessor {

    @Override
    public void process(Set<? extends TypeElement> set, RoundEnvironment roundEnv,
                    AnnotationProcessor abstractProcessor) {
    // 查詢註解是否存在
    Set<? extends Element> elementSet =
            roundEnv.getElementsAnnotatedWith(SingleDelegate.class);
    Set<TypeElement> typeElementSet = ElementFilter.typesIn(elementSet);
    if (typeElementSet == null || typeElementSet.isEmpty()) {
        return;
    }

    // 迴圈處理註解
    for (TypeElement typeElement : typeElementSet) {
        if (!(typeElement.getKind() == ElementKind.INTERFACE)) { // 只處理介面型別
            continue;
        }

        // 處理 SingleDelegate，只處理 annotation.classNameImpl() 不為空的註解
        SingleDelegate annotation = typeElement.getAnnotation(SingleDelegate.class);
        if ("".equals(annotation.classNameImpl())) {
            continue;
        }
        Delegate delegate = annotation.delegate();

        // 新增構造器
        MethodSpec.Builder constructorBuilder = MethodSpec.constructorBuilder()
                .addModifiers(Modifier.PUBLIC);

        // 建立類名相關 class builder
        TypeSpec.Builder builder =
                ProcessUtils.createTypeSpecBuilder(typeElement, annotation.classNameImpl());

        // 處理 delegate
        builder = ProcessUtils.processDelegate(typeElement, builder,
                constructorBuilder, delegate);

        // 檢查是否繼承其它介面
        builder = processSuperSingleDelegate(abstractProcessor, builder, constructorBuilder, typeElement);

        // 完成構造器
        builder.addMethod(constructorBuilder.build());

        // 建立 JavaFile
        JavaFile javaFile = JavaFile.builder(AnnotationProcessor.PACKAGE, builder.build()).build();
        try {
            javaFile.writeTo(abstractProcessor.filer);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    }

3，在專案Gradle中新增 annotationProcessor project 引用

    compile project(':apt-delegate-annotation')
    annotationProcessor project(':apt-delegate-compiler')

4，如果有自定義註解的話，建立一個java的Module，專門放入自定義註解。專案與apt Module都需引用自定義註解Module

4-1，主工程：

    compile project(':apt-delegate-annotation')
    annotationProcessor project(':apt-delegate-compiler')

4-2，apt Module：

    compile project(':apt-delegate-annotation')

    compile 'com.google.auto.service:auto-service:1.0-rc2'
    compile 'com.squareup:javapoet:1.4.0'

5，生成的原始碼在build/generated/source/apt下可以看到

難點

就apt本身來說沒有任何難點可言，難點一在於設計模式和解耦思想的靈活應用，二在與程式碼生成的繁瑣，你可以手動字串拼接，當然有更高階的玩法用squareup的javapoet，用建造者的模式構建出任何你想要的原始碼

優點

它的強大之處無需多言，看代表框架的原始碼，你可以學到很多新姿勢。總的一句話：它可以做任何你不想做的繁雜的工作，它可以幫你寫任何你不想重複程式碼。懶人福利，老司機必備神技，可以提高車速，讓你以任何姿勢漂移。它可以生成任何原始碼供你在任何地方使用，就像劍客的劍，快疾如風，無所不及

我想稍微研究一下,APT還可以在哪些地方使用，比如：Repository層?

APT在Repository層的嘗試

瞭解APT與簡單學習之後，搭建Repository層時，發現有一些簡單，重複模版的程式碼

每一次新增新介面都需要簡單地修改很多地方，能不能把一部分程式碼自動生成，減少改動的次數呢？

Repository層

• IRemoteDataSource， RemoteDataSourceImpl

  遠端資料來源，屬於網路請求相關

• ILocalDataSource， LocalDataSourceImpl

  本地資料來源，屬於本地資料持久化相關

• IRepository，RepositoryImpl

  倉庫代理類，代理遠端資料來源與本地資料來源

Repository層APT設計思路

發現在具體實現類中，大多都是以代理類的形式呼叫：方法中呼叫代理物件，方法名稱與引數，返回值型別都相同。顯然可以進行APT的嘗試

簡單的情況，具體實現類中只有一個代理物件

複雜的情況，有多個代理物件，方法內並有一些變化

期望結果：

• 把RemoteDataSourceImpl自動化生成
• 把LocalDataSourceImpl自動化生成
• 把RepositoryImpl自動化生成

自定義註解設計

要想具體實現類自動生成，首先要知道需要什麼：

• 方便自動生成java檔案的類庫
• 自動生成類名字是什麼
• 需要注入的代理物件
• 讓代理物件代理的方法集

自動生成類名字，代理物件，方法集需要通過自定義註解配置引數的形成，在AbstractProcessor中獲取

Delegate

    @Retention(RetentionPolicy.SOURCE)
    @Target(ElementType.TYPE)
    public @interface Delegate {

    /**
     * delegate class package
     */
    String delegatePackage();

    /**
     * delegate class name
     */
    String delegateClassName();

    /**
     * delegate simple name
     */
    String delegateSimpleName();
    }

SingleDelegate

    @Retention(RetentionPolicy.SOURCE)
    @Target(ElementType.TYPE)
    public @interface SingleDelegate {

    /**
     * impl class name
     */
    String classNameImpl();

    /**
     * delegate data
     */
    Delegate delegate();
    }

MultiDelegate

    @Retention(RetentionPolicy.SOURCE)
    @Target(ElementType.TYPE)
    public @interface MultiDelegate {

    /**
     * impl class name
     */
    String classNameImpl();

    /**
     * delegate list
     */
    Delegate[] Delegates();
    }

處理自定義的註解、生成程式碼

AnnotationProcessor

    @AutoService(Processor.class) // javax.annotation.processing.IProcessor
    @SupportedSourceVersion(SourceVersion.RELEASE_7) //java
    @SupportedAnnotationTypes({ // 標註註解處理器支援的註解型別
        "com.annotation.SingleDelegate",
        "com.annotation.MultiDelegate"
    })
    public class AnnotationProcessor extends AbstractProcessor {

    public static final String PACKAGE = "com.poet.delegate";
    public static final String CLASS_DESC = "From poet compiler";

    public Filer filer; //檔案相關的輔助類
    public Elements elements; //元素相關的輔助類
    public Messager messager; //日誌相關的輔助類
    public Types types;

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        filer = processingEnv.getFiler();
        elements = processingEnv.getElementUtils();
        messager = processingEnv.getMessager();
        types = processingEnv.getTypeUtils();

        new SingleDelegateProcessor().process(set, roundEnvironment, this);
        new MultiDelegateProcessor().process(set, roundEnvironment, this);

        return true;
    }
    }

資料參考

T-MVP