Android 利用apt生成代码,实现butterKnife控件查找功能

·  阅读 303
Android 利用apt生成代码,实现butterKnife控件查找功能

了解了butterknife的实现原理后,研究了一下apt技术,接着自己查阅相关资料,撸了一遍apt的实现过程,因为看的资料比较老旧,实现过程颇为曲折,所以把自己的实现过程记录一下,方便新学习的小伙伴绕开这些坑。

ATP(Annotation processing tool)

Annotation processing tool也就是注解处理器了,原理是根据注解在代码编译的时候去生成相应的功能代码文件,打包的时候会跟着其他的源码一起打包成class文件,这样就避免了那些功能在运行时全部用反射去实现,从而提高了app的性能。

首先新建一个工程,然后新建一个java library module,取名binder_annotation,这里我们专门用来存放Annotation文件,接着自定义一个Annotation,取名BindView:

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface BindView {
    int value();
}
复制代码

接着新建另一个java library module,取名binder_compiler,我们在这里做注解处理的工作,和生成相应的java文件的操作, 在这个module的gradle文件里添加如下配置:

plugins {
    id 'java-library'
}

java {
    sourceCompatibility = JavaVersion.VERSION_1_7
    targetCompatibility = JavaVersion.VERSION_1_7
}
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    //AutoService 主要的作用是注解 processor 类,并对其生成 META-INF 的配置信息。
    implementation 'com.google.auto.service:auto-service:1.0-rc6'
   //解决gradle的版本bug,不添加会导致我们的process类不被调用
    annotationProcessor 'com.google.auto.service:auto-service:1.0-rc6'
    //JavaPoet 这个库的主要作用就是帮助我们通过类调用的形式来生成代码。
    implementation 'com.squareup:javapoet:1.10.0'
    implementation project(':binder_annotation')
}

复制代码

注意:Android Plugin for Gradle: >3.3.2的时候要添加 :

annotationProcessor 'com.google.auto.service:auto-service:1.0-rc6' 这行依赖,这是gradle的一个版本bug,高版本的gradle不会去调用我们编写好的process类,我在这里就陷进去好久。

app module下的gradle文件做如下配置:

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'androidx.appcompat:appcompat:1.3.0'
    implementation 'com.google.android.material:material:1.3.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
    testImplementation 'junit:junit:4.+'
    androidTestImplementation 'androidx.test.ext:junit:1.1.2'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'

    annotationProcessor project(':binder_compiler')
    implementation project(':binder_annotation')
}

复制代码

接着新建BinderProcessor类,让它继承AbstractProcessor,并加上@AutoService(Processor.class)注解,这样它才会在代码编译期被执行:

@AutoService(Processor.class)
public class BinderProcessor extends AbstractProcessor {
    private Elements mElementUtils; ///处理Element的工具类
    private HashMap<String,BinderClassCreator>  mCreatorMap = new HashMap<>();//构造器工具的缓存map
}

复制代码

重写相关方法:

 //初始化
  @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        //处理Element的工具类,用于获取程序的元素,例如包、类、方法。
        mElementUtils = processingEnvironment.getElementUtils();
    }
  //使用最新的版本
    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }
  //支持的注解类名集合,这里我们只做BindView的注解处理
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        HashSet<String> supportTypes = new LinkedHashSet<>();
        supportTypes.add(BindView.class.getCanonicalName());
        return supportTypes;
    }

复制代码

重点需要处理的方法是process(),相关注释在代码里,算是比较详细了,多看几遍应该看得懂:

@Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        //扫描整个工程里被BindView注解过的元素,会根据activity名来生成相应的工具类BinderClassCreator
        //BinderClassCreator里包含了生成相应的activity的_ViewBinding类,里面有做了findViewById的事情
        Set<? extends Element> elements = roundEnvironment.getElementsAnnotatedWith(BindView.class);
        for(Element element:elements){
            VariableElement variableElement = (VariableElement) element;//强转
            //返回此元素直接封装(非严格意义上)的元素。
            //类或接口被认为用于封装它直接声明的字段、方法、构造方法和成员类型
            //这里就是获取封装属性元素的类元素
            TypeElement classElement = (TypeElement) variableElement.getEnclosingElement();
            //获取简单类名
            String fullClassName = classElement.getQualifiedName().toString();
            //先在map缓存里取BinderClassCreator
            BinderClassCreator creator = mCreatorMap.get(fullClassName);
            if(creator == null){
                creator = new BinderClassCreator(mElementUtils.getPackageOf(classElement),classElement);
                //保存在map里
                mCreatorMap.put(fullClassName,creator);
            }
            //获取元素注解信息
            BindView bindAnnotation = variableElement.getAnnotation(BindView.class);
            int id = bindAnnotation.value();
            creator.putElement(id,variableElement);
        }
        //通过javaPoet构建生成java文件
        for(String key:mCreatorMap.keySet()){
            BinderClassCreator classCreator = mCreatorMap.get(key);
            JavaFile javaFile = JavaFile.builder(classCreator.getmPackageName(), classCreator.generateJavaCode()).build();
            try {
                javaFile.writeTo(processingEnv.getFiler());
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return false;
    }

复制代码

这里用到一个BinderClassCreator类,用来帮助构建相应activity__ViewBinding类的工具:

/**
 * @author: lookey
 * @date: 2021/5/25
 * 用来生成_BinderView类的工具类
 */
public class BinderClassCreator {
    public static final String ParamName = "view";
    private TypeElement mTypeElement;//类元素
    private String mPackageName;
    private String mBinderClassName;
    private HashMap<Integer, VariableElement> mVariableElement = new HashMap<>();
    public BinderClassCreator(PackageElement mPackageElement, TypeElement mTypeElement) {
        this.mTypeElement = mTypeElement;
        this.mPackageName = mPackageElement.getQualifiedName().toString();
        this.mBinderClassName = mTypeElement.getSimpleName().toString()+"_ViewBinding";
    }
    public void putElement(int id,VariableElement variableElement){
        mVariableElement.put(id,variableElement);
    }

    public String getmPackageName() {
        return mPackageName;
    }
    //生成java类,及相应的方法
    public TypeSpec generateJavaCode(){
        return TypeSpec.classBuilder(mBinderClassName)
                .addModifiers(Modifier.PUBLIC) //public修饰
                .addMethod(generateMethod()) //添加方法
                .build();
    }
    private MethodSpec generateMethod(){
        //获取类名
        ClassName className = ClassName.bestGuess(mTypeElement.getQualifiedName().toString());
        return MethodSpec.methodBuilder("bindView")
                .addModifiers(Modifier.PUBLIC)
                .returns(void.class)
                .addParameter(className,ParamName)
                .addCode(generateMethodCode())
                .build();
    }
    private String generateMethodCode() {
        StringBuilder code = new StringBuilder();
        for (int id : mVariableElement.keySet()) {
            VariableElement variableElement = mVariableElement.get(id);
            //使用注解的属性的名称
            String name = variableElement.getSimpleName().toString();
            //使用注解的属性的类型
            String type = variableElement.asType().toString();
            //view.name = (type)view.findViewById(id)
            String findViewCode = ParamName + "." + name + "=(" + type + ")" + ParamName +
                    ".findViewById(" + id + ");\n";
            code.append(findViewCode);

        }
        return code.toString();
    }
}

复制代码

再写一个工具类BinderViewTools 让我们的activity调用,类似ButterKnife.bind(),通篇下来也就在这里用到了反射:

/**
 * @author: lookey
 * @date: 2021/5/25
 */
public class BinderViewTools {
    public static void bind(Activity activity){
        Class aClass = activity.getClass();
        try {
            Class<?> bindClass = Class.forName(aClass.getCanonicalName() + "_ViewBinding");//找到生成的相应的bind类
            Method method = bindClass.getMethod("bindView", aClass);
            method.invoke(bindClass.newInstance(),activity);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

复制代码

最后在activity使用一下,使用步骤类似butterknife:

package com.trendlab.aptex;

import androidx.appcompat.app.AppCompatActivity;

import android.os.Bundle;
import android.widget.TextView;

import com.trendlab.binder_annotation.BindView;

public class MainActivity extends AppCompatActivity {

    @BindView(R.id.tv111)
    public TextView tv111;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        BinderViewTools.bind(this); //运行时会去找到MainActivity_ViewBinding类,然后实例化一个对象,再调用findview()方法
        tv111.setText("hello binder");
    }
}

复制代码

运行编译一下,一切正常的话会在app module下生成这个文件:

模拟器运行成功:

整体做完还是比较清晰的,重点是对javaPoet的熟练使用,和生成java文件的process()方法的构思,调试过程中遇到不能生成java文件,或者提示写入重复报错的情况可以尝试invalidate caches/restart 重启studio。

结尾

有一起学习的小伙伴可以关注下我的公众号——❤️程序猿养成计划❤️ 每周会定期做技术分享。快加入和我一起学习吧!

分类:
Android