Android程序員必會技能---運行時動態生成類---之編譯期註解

時間 2019-11-09

標籤 android 程序員必會技能運行時動態生成編譯註解欄目 Android 简体版

原文原文鏈接

除了動態代理，還有哪些方法能夠方便的自動幫咱們生成類呢？

應該說，除了動態代理，還有註解和字節碼注入（主要是asm和aspectj）兩種方法能夠方便的幫咱們自動生成類。關於字節碼注入，咱們下一節再說，今天只說註解，尤爲是編譯期註解，運行時註解由於大量要在運行期用到反射因此不少人都不用了改用編譯期註解了。比方說eventbus這個框架 2.0到3.0 主要就是修改的這個。因此運行時z 註解就留給感興趣的人本身看看吧，比編譯期註解簡單多了java

編譯期註解能幫咱們解決什麼問題？

假設如今有個需求：輸入商品編碼，返回對應的服裝品牌並輸出他們的價格。顯然這是一個工廠模式就能解決的簡單問題。首先定義一個接口：android

package com.longfor.retentiontest;

public interface IClothes {
    void getPrice();
}

複製代碼

而後定義三個服裝品牌api

package com.longfor.retentiontest;

import android.util.Log;

import com.longfor.annotationprocessorjavalib.Factory;


public class BandNike implements IClothes {

    @Override
    public void getPrice() {
        Log.v("wuyue", "nike price is 500");
    }
}

複製代碼

package com.longfor.retentiontest;

import android.util.Log;

import com.longfor.annotationprocessorjavalib.Factory;

public class BandLevis implements IClothes {
    @Override
    public void getPrice() {
        Log.v("wuyue", "levis price is 5000");
    }
}
複製代碼

package com.longfor.retentiontest;

import android.util.Log;

import com.longfor.annotationprocessorjavalib.Factory;

public class BandGucci implements IClothes {
    @Override
    public void getPrice() {
        Log.v("wuyue", "gucci price is 5000");
    }
}

複製代碼

而後一個工廠解決咱們全部問題：bash

package com.longfor.retentiontest;

public class ClothesFactory {
    public static IClothes getBandClothesByNumber(int number) {
        if (number == 1) {
            return new BandNike();
        } else if (number == 2) {
            return new BandGucci();
        } else if (number == 3) {
            return new BandLevis();
        }
        return null;
    }
}

複製代碼

這段代碼其實還有優化空間的，好比說這品牌咱們暫時只有3個，若是新增到30個 300個怎麼處理？尤爲是這個方法要提供給別的模塊使用的時候？不能每新加一個就從新寫一遍工廠類從新打包吧。app

因此解決問題的方法就是：用編譯期註解的方法來動態的幫咱們生成工廠類，而後新增的品牌只要加上咱們的註解就ok。由於編譯期註解生成的工廠類會根據咱們的註解來寫好對應的語句。框架

如何在 androidstudio中編寫編譯期註解代碼

首先咱們new一個java libide

注意他的build文件的寫法：函數

apply plugin: 'java-library'
tasks.withType(JavaCompile) {
    options.encoding = "UTF-8"
}
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    //協助咱們生成meta-inf 等信息的
    implementation 'com.google.auto.service:auto-service:1.0-rc2'
    //square公司 協助生成java代碼的輔助庫
    implementation 'com.squareup:javapoet:1.7.0'

}

sourceCompatibility = "7"
targetCompatibility = "7"

複製代碼

而後看下咱們的app的build文件：工具

apply plugin: 'com.android.application'

android {
    compileSdkVersion 27
    defaultConfig {
        applicationId "com.longfor.retentiontest"
        minSdkVersion 21
        targetSdkVersion 27
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'com.android.support:appcompat-v7:27.1.1'
    implementation 'com.android.support.constraint:constraint-layout:1.1.0'
    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'com.android.support.test:runner:1.0.2'
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
    //主要就是下面的代碼
    compile project(":AnnotationProcessorJavaLib")
    //注意不要遺漏這個
    annotationProcessor project(":AnnotationProcessorJavaLib")

}

複製代碼

而後咱們能夠開始寫咱們的註解，先看一下基本結構：學習

而後看一下具體寫法：

package com.longfor.annotationprocessorjavalib;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.CLASS)
@Target({ElementType.TYPE})
public @interface Factory {
    //咱們生成的工程類 就根據這個id的值 來判斷到底要new 哪一個對象
    int id();
}

複製代碼

看下咱們最關鍵的註解處理器的寫法：

package com.longfor.annotationprocessorjavalib;

import com.google.auto.service.AutoService;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.TypeSpec;

import java.io.IOException;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.Filer;
import javax.annotation.processing.Messager;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
import javax.lang.model.util.Elements;
import javax.lang.model.util.Types;

/**
 * 自定義註解處理器
 */
@AutoService(Processor.class)
public class FactoryProcessor extends AbstractProcessor {
    Types mTypeUtils;
    /**
     * 用來處理Element的工具類，Element表明源代碼 好比類名 包名 方法名 等等
     */
    Elements mElementUtils;
    Filer filer;
    //日誌輸出用的，不須要能夠不用
    Messager messager;


    /**
     * 這個初始化的代碼不要忘記了
     *
     * @param processingEnvironment
     */
    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        mTypeUtils = processingEnvironment.getTypeUtils();
        mElementUtils = processingEnvironment.getElementUtils();
        filer = processingEnvironment.getFiler();
        messager = processingEnvironment.getMessager();
    }

    HashMap<Integer, String> idClassMap = new HashMap<>();
    private String mSupperClsQualifiedName; //被註解的類的父類的徹底限定名稱（即包名+類名）

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {

        //由於Element能夠是 類 方法 或者變量
        for (Element annotatedElement : roundEnvironment.getElementsAnnotatedWith(Factory.class)) {
            //因此這裏要判斷 只有是註解到類的才處理
            if (annotatedElement.getKind() == ElementKind.CLASS) {
                //TypeElement能夠獲取類的名字 可是獲取不到 類的信息
                TypeElement typeElement = (TypeElement) annotatedElement;
                Factory annotation = typeElement.getAnnotation(Factory.class);
                //把咱們的id 取出來
                int id = annotation.id();
                //把咱們的類名取出來
                String className = typeElement.getQualifiedName().toString();
                //而後放到map裏面 創建咱們的id--class的 對應關係
                idClassMap.put(id, className);

            }
        }

        //而後生成咱們的類
        generateCode();
        return false;
    }

    /**
     * 其實生成java代碼 就是寫一個字符串的事。。。你能夠本身拼字符串 拼成 java 源代碼的
     * <p>
     * 這裏示範 咱們用javapoet 來協助咱們生成java源代碼， 其實對於簡單的註解來說
     * <p>
     * 直接寫字符串可能更方便。javapoet適合構建比較複雜的java源碼
     */
    public void generateCode() {
        //整體來講 (TypeSpec)用於建立類或者接口，(FieldSpec)用來建立字段，(MethodSpec)用來建立方法和構造函數，(ParameterSpec)用來建立參數，(AnnotationSpec)用於建立註解

        //建立一個class對象 來告訴MethodSpec 咱們要生成的方法 返回值的類型是什麼
        ClassName iClothes = ClassName.get("com.longfor.retentiontest", "IClothes");

        MethodSpec.Builder method = MethodSpec.methodBuilder("getBandClothesByNumber")
                .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
                .returns(iClothes)
                .addParameter(Integer.class, "number");

        Iterator iterator = idClassMap.entrySet().iterator();
        //設置循環次數
        int times = 0;
        //這邊是生成方法體的語句，對於咱們來講 重要的是理解 $L $S $T $N 的區別
        while (iterator.hasNext()) {
            Map.Entry entry = (Map.Entry) iterator.next();
            Integer id = (Integer) entry.getKey();
            String className = (String) entry.getValue();
            times++;
            ClassName cls = ClassName.get("com.longfor.retentiontest", className);
            if (times == 1) {
                method.beginControlFlow("if (number==$L)", id)
                        .addStatement("return new $T()", cls).endControlFlow();
            } else {
                method.beginControlFlow("else if (number==$L)", id)
                        .addStatement("return new $T()", cls).endControlFlow();
            }
        }
        method.addStatement("return null");

        /**
         * TypeSpec用來建立類或者接口
         */
        TypeSpec annotationClothesFactory = TypeSpec.classBuilder("AnnotationClothesFactory")
                .addModifiers(Modifier.PUBLIC)
                .addMethod(method.build())
                .build();

        JavaFile javaFile = JavaFile.builder("com.longfor.retentiontest", annotationClothesFactory)
                .build();

        try {
            javaFile.writeTo(filer);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> annotations = new LinkedHashSet<>();
        //配置須要處理的註解 這裏只處理咱們本身的註解
        annotations.add(Factory.class.getCanonicalName());
        return annotations;
    }

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

複製代碼

註釋寫的很詳細了，我就很少囉嗦了，還有看不懂的能夠在下面留言問。

而後咱們再回到主app包下，把咱們的註解加上去：

package com.longfor.retentiontest;

import android.util.Log;

import com.longfor.annotationprocessorjavalib.Factory;


@Factory(id = 2)
public class BandGucci implements IClothes {
    @Override
    public void getPrice() {
        Log.v("wuyue", "gucci price is 5000");
    }
}

package com.longfor.retentiontest;

import android.util.Log;

import com.longfor.annotationprocessorjavalib.Factory;

@Factory(id = 3)
public class BandLevis implements IClothes {
    @Override
    public void getPrice() {
        Log.v("wuyue", "levis price is 5000");
    }
}

package com.longfor.retentiontest;

import android.util.Log;

import com.longfor.annotationprocessorjavalib.Factory;


@Factory(id = 1)
public class BandNike implements IClothes {

    @Override
    public void getPrice() {
        Log.v("wuyue", "nike price is 500");
    }
}

複製代碼

而後咱們rebuild一下工程，

你看，這個自動生成的類就寫好了，而後咱們看一下寫的符合不符合咱們要求：

package com.longfor.retentiontest;

import java.lang.Integer;

public class AnnotationClothesFactory {
  public static IClothes getBandClothesByNumber(Integer number) {
    if (number==1) {
      return new com.longfor.retentiontest.BandNike();
    }
    else if (number==2) {
      return new com.longfor.retentiontest.BandGucci();
    }
    else if (number==3) {
      return new com.longfor.retentiontest.BandLevis();
    }
    return null;
  }
}

複製代碼

嗯看樣子很完美，能夠正常使用。注意這裏其實不少信息均可以利用註解相關的類來自動獲取，我這裏爲了簡單方便不少地方是寫死值的，若是大家要寫的註解真的要作成sdk的話，這邊最好能用代碼獲取判斷各類異常狀況。

butterknife 是如何實現的？

有了上面的基礎，相信butterknife的原理你必定能搞清楚了。實際上butterknife就是利用編譯期註解生成一個名字爲 xxxActivity$$ViewBinder的類，在這個類的構造函數裏面自動幫咱們執行了findviewById等方法罷了。而後在ButterKnife.bind方法裏面利用反射的技術來手動的調用咱們這個生成的類的構造方法。至此就完成了綁定的操做了。