Android之使用apt編寫編譯時注解

參考鏈接： https://bitbucket.org/hvisser/android-apt

http://www.open-open.com/lib/view/open1423471786764.html

http://alighters.com/blog/2016/05/10/apt-code-generate/

定義注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface CocaAptTest {
    String value();
}

自定義虛處理器AbstractProcessor

注：若使用AndroidStudio，需要注意Android Library並不是普通的JavaSE，所以並沒有提供javax的一些功能，因此在新建Module的時候不能選Android Library而應該選Java Library。因為它只在編譯的時候使用到JavaSE的功能，所以並不用擔心在手機上出現異常。

@AutoService(Processor.class)
public class CocaAptProcessor extends AbstractProcessor {
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        return Collections.singleton(CocaAptTest.class.getCanonicalName());
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        Set<? extends Element> set = roundEnv.getElementsAnnotatedWith(CocaAptTest.class);
        for (Element element : set) {
            if (element.getKind() != ElementKind.CLASS) {
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "only support class");
            }
            /*生成方法*/
            MethodSpec creaedMethod = MethodSpec.methodBuilder("createApt")
                    .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
                    .returns(void.class)
                    .addParameter(String[].class, "parameters")
                    .addStatement("System.out.println($S)", "this`s java source is created by dynamic")
                    .build();


            TypeSpec createdClass = TypeSpec.classBuilder("AptGenerator").addModifiers(Modifier.PUBLIC, Modifier.FINAL).addMethod(creaedMethod).build();//指定生成的類
            JavaFile javaFile = JavaFile.builder("com.coca.apt", createdClass).build();

            try {
                javaFile.writeTo(processingEnv.getFiler());
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return false;
    }
}

注：這里引用兩個庫簡化操作：

apply plugin: 'java' //由於AbstractProcessor隸屬於javax,所以這里我們使用java Library的引用模式 

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    /**/
    compile 'com.google.auto.service:auto-service:1.0-rc2'
    compile 'com.squareup:javapoet:1.7.0'
}

AutoService主要的作用是注解processor類，並對其生成 META-INF 的配置信息,省去手動配置 META-INF的麻煩。

JavaPoet這個庫的主要作用就是幫助我們通過類調用的形式來生成代碼。

添加項目依賴

在項目根目錄 的build.gradle文件中的dependencies節點下面添加依賴如下：

import com.sun.org.apache.xalan.internal.xsltc.cmdline.Compile

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
       // replace with the current version of the Android plugin
        classpath 'com.android.tools.build:gradle:1.5.0'
        // the latest version of the android-apt plugin
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8' //添加該依賴
    }
}

allprojects {
    repositories {
        jcenter()
    }
}

app的build.gradle中添加如下依賴：

apply plugin: 'com.android.application'
apply plugin: 'com.neenbedankt.android-apt'  //（1）

android {
    compileSdkVersion 24
    buildToolsVersion "24.0.1"

    defaultConfig {
        applicationId "com.coca.androidaptdemo"
        minSdkVersion 15
        targetSdkVersion 24
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile fileTree(include: ['*.jar'], dir: 'libs')
    testCompile 'junit:junit:4.12'
    compile 'com.android.support:appcompat-v7:24.1.1'
    compile project(':cocaaptlib')  //（2） 添加對上面java library的依賴
}

基本使用

對類添加CocaAptTest注解並執行Rebuild操作，之后即可在app的build/generated/source/apt目錄下查看到生成的代碼。

@CocaAptTest("cocaValue")
public class MainActivity extends AppCompatActivity {
//...
}

來自為知筆記(Wiz)