Android APT技术解析与实战

Android APT技术解析与实战

Java提供了插入式注解处理器，用以在编译期间对代码进行检查或者生成相关的代码。而APT，是一种在代码编译期间处理注解，按照一定的规范，生成相应的Java文件的技术。现在很多流行的第三方库，如Dagger2、ButterKnife等，都是采用APT技术实现的。

APT

APT(Annotation Processing Tool)是一种注解处理工具，它对源文件代码进行检测，找出其中的注解，并对此进行额外的处理，如检查代码书写规范，生成额外的源文件等(具体内容由注解处理器的实现所决定)；此处我们关注的是APT技术，注解相关的内容请自行补脑。

APT技术实践

一、创建Annotation Module

首先，我们需要创建一个Java Library，名称可为annotation，主要放一些项目中需要用到的自定义注解及相关代码，下面是一个简单的例子：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface WXEntryGenerator {
    //声明该注解所要生成的包名规则
    String getPackageName();
    //声明该注解所要生成的java类需要继承哪个父类
    Class getSupperName();
}

二、创建Compiler Module

然后，需要再创建一个Java Library，名称可为compiler，主要是应用apt技术处理注解，生成相关代码或者相关源文件，是核心所在。

build.gradle文件配置

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])

    api 'com.squareup:javapoet:1.11.1'
    api 'com.google.auto.service:auto-service:1.0-rc3'
    api 'com.google.auto:auto-common:0.9'
    api project(':annotations')
}

sourceCompatibility = "1.7"  //需要指定为java7版本
targetCompatibility = "1.7"

auto-service的作用是向系统注册processor(自定义注解处理器)，执行编译时使用processor进行处理。
javapoet提供了一套生成java代码的api，利用这些api处理注解，生成新的代码或源文件。
annotations是上文创建的注解module。

processor实现

@AutoService(Processor.class)
public class XiaoyuProcessor extends AbstractProcessor {
    /**
     * 注册自定义的注解名称
     *
     * @return
     */
    @Override
    public Set getSupportedAnnotationTypes() {
        Set annotationNames = new LinkedHashSet<>();
        Set<Classextends Annotation>> annotations = getsupportAnnotations();
        for (Classextends Annotation> anno : annotations) {
            annotationNames.add(anno.getCanonicalName());
        }
        return annotationNames;
    }

    /**
     * 构建支持的注解集合
     *
     * @return
     */
    private Set<Classextends Annotation>> getsupportAnnotations() {
        Set<Classextends Annotation>> annotations = new LinkedHashSet<>();
        annotations.add(WXEntryGenerator.class);
        annotations.add(WXShareGenerator.class);
        return annotations;
    }

    @Override
    public boolean process(Setextends TypeElement> annotations, RoundEnvironment roundEnvironment) {
        generateEntry(roundEnvironment);
        generateShare(roundEnvironment);
        return true;
    }

    private void generateShare(RoundEnvironment roundEnvironment) {
        //定义一个注解属性解析器
        ShareVisitor shareVisitor = new ShareVisitor();
        shareVisitor.setmFiler(processingEnv.getFiler());
        scan(roundEnvironment,WXShareGenerator.class,shareVisitor);
    }

    private void generateEntry(RoundEnvironment roundEnvironment) {
        EntryVisotor entryVisotor = new EntryVisotor();
        entryVisotor.setmFiler(processingEnv.getFiler());
        scan(roundEnvironment, WXEntryGenerator.class, entryVisotor);
    }

    private void scan(RoundEnvironment environment, Classextends Annotation> clazz, AnnotationValueVisitor visotor) {
        //遍历使用了clazz注解的所有元素
        for (Element element : environment.getElementsAnnotatedWith(clazz)) {
            //获取注解内部属性集合
            List extends AnnotationMirror> annotationMirrors = element.getAnnotationMirrors();
            for (AnnotationMirror mirror : annotationMirrors) {
                //获取注解内部属性值
                Map extends ExecutableElement, ? extends AnnotationValue> elementValues = mirror.getElementValues();
                for (Map.Entry extends ExecutableElement, ? extends AnnotationValue> entryValue : elementValues.entrySet()) {
                    //将注解内部属性值交给注解属性解析器处理(EntryVisotor、ShareVisitor)
                    entryValue.getValue().accept(visotor, null);
                }
            }
        }
    }
}

实现这个注解处理器需要继承AbstractProcessor抽象类，并且通过@AutoService注解向系统注册。核心内容在process(Set annotations, RoundEnvironment roundEnvironment)方法中，第一个参数annotations表示这个注解处理器所要处理的注解集合，第二个参数roundEnvironment可以访问到这个RoundEnvironment下的每一个Element(可以理解为语法树节点)。
ShareVisitor和EntryVisotor是自定义的两个注解属性解析器，实现如下

/**
 * 注解内部属性解析器
 */
public class EntryVisotor extends SimpleAnnotationValueVisitor7<Void, Void> {

    /**
     * 需要遍历的
     */
    private Filer mFiler;

    /**
     * 包名
     */
    private String mPackageName;

    public void setmFiler(Filer mFiler) {
        this.mFiler = mFiler;
    }

    @Override
    public Void visitString(String s, Void aVoid) {
        //解析得到的包名
        mPackageName = s;
        return aVoid;
    }

    @Override
    public Void visitType(TypeMirror typeMirror, Void aVoid) {
        generatorJavaCode(typeMirror);
        return aVoid;
    }

    private void generatorJavaCode(TypeMirror typeMirror) {
        TypeSpec wxEntry = TypeSpec.classBuilder("WXEntryActivity")
                .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
                .superclass(TypeName.get(typeMirror))
                .build();
        JavaFile javaFile = JavaFile.builder(mPackageName + ".wxapi", wxEntry)
                .addFileComment("微信登录入口文件")
                .build();
        try {
            javaFile.writeTo(mFiler);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

属性解析器(EntryVisotor)会解析注解内部属性值，并据此生成java代码。

三、使用注解

实现了注解处理器，下面就是使用的流程了，这个过程注定非常简单，不然那些使用该技术实现的第三方库又怎能如此广受青睐呢。使用方式如下

@WXEntryGenerator(getPackageName = "com.xiaoyu.market",
        getSupperName = WXEntryTemplateActivity.class)
public interface WeChatEntry {

}

在你的项目中自定义一个接口或者类，名称不限，然后使用我们上文定义的注解注解该类(接口)，编译项目，你会发现WXEntryActivity出现在了项目中，如下图所示

这里使用的是微信特有类来说明一下apt的使用及其原理，其他流行的库如Butterknife、Dagger2的实现也是基于这个原理，只不过会更复杂一些。