Android APT不能自动生成文件

最近学习(Annotation Processing Tool)即注解处理器,在写一个小Demo的时候。写完代码,无论怎么Build都不能自动生成所需要的文件,于是各种检查寻找问题。

添加依赖

在处理注解的Java library Module 名字为Complier,添加依赖

    dependencies {
        implementation fileTree(dir: 'libs', include: ['*.jar'])
        implementation 'com.google.auto.service:auto-service:1.0-rc5'
        implementation project(path: ':Annotation')
    }
    //中文乱码问题(错误:编码GBK不可映射字符)
tasks.withType(JavaCompile) {
    options.encoding = "UTF-8"
}
sourceCompatibility = "8"
targetCompatibility = "8"

Annotation为Java library Module,很简单

@Target(ElementType.FIELD) //作用于属性上  
@Retention(RetentionPolicy.CLASS) //作用于编译期,.class 存在于apk中
public @interface BindView {
    int value();
}

还有一个Android library Module 命名为apt-lib

主要有一个类ButterKnife和一个接口ViewBinder,代码如下:
1.ButterKnife.java

public class ButterKnife {
    public static void bind(Activity activity) {
        String className = activity.getClass().getName() + "$ViewBinder";
        try {
            Class<?> aClass = Class.forName(className);
            ViewBinder viewBinder = (ViewBinder) aClass.newInstance();
            viewBinder.bind(activity);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

2.ViewBinder.java

public interface ViewBinder<T> {
    void bind(T t);
}

注解处理器(Complier)

里面只有一个类ButterKnifeProcessor

@AutoService(Processor.class)//加上这个注解才能去执行
public class ButterKnifeProcessor extends AbstractProcessor {
    private Elements elementUtils;  //Elements中包含用于操作的工具
    private Filer filer;        //用来创建新的源文件,class以及其他文件

    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        //此方法主要是去初始化需要用到的工具
        elementUtils = processingEnvironment.getElementUtils();
        filer = processingEnvironment.getFiler();
    }


    @Override
    public Set<String> getSupportedAnnotationTypes() {
        //添加支持的注解类型
        Set<String> setTypes = new LinkedHashSet<>();
        setTypes.add(BindView.class.getCanonicalName()):
        return setTypes;
    }

    @Override
    public SourceVersion getSupportedSourceVersion() {
        //用哪个版本的jdk编译
        return SourceVersion.RELEASE_8;
    }

    /**
     * 注解处理器的核心方法,处理具体的注解,生成新的 Java Class文件
     */
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        try {
            JavaFileObject fileObject = filer.createSourceFile("LuacherActivity$ViewBinder");
            //获取writer,wirter就类似一支笔,去写java文件里的每一行代码
            Writer writer = fileObject.openWriter();
            writer.write("package com.lyh.apt;\n");      //包名
            writer.write("\n");
            writer.write("import com.liyh.aptlib.ViewBinder;\n");//导包
            writer.write("\n");
            writer.write("import com.lyh.apt.LuacherActivity;\n");
            writer.write("\n");
             writer.write("import com.lyh.apt.R;\n");
            writer.write("\n");
            writer.write("public class LuacherActivity$ViewBinder implements ViewBinder<LuacherActivity> {\n");
			writer.write("    @Override\n");
			writer.write("    public void bind(LuacherActivity target) {\n");
			writer.write("        target.tvText = target.findViewById(R.id.tv_text);\n}\n");
			writer.write("}");
			//最后不要忘记关流
            writer.flush();
            writer.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return false;
    }
}

当然目前我只是把代码写死了,真正实现可以从参数RoundEnvironment中获取到注解的类,这里只是想看下这Writer的用法。具体实现可以参考
【Android】APT https://www.jianshu.com/p/7af58e8e3e1
主要是重写init(ProcessingEnvironment processingEnvironment),getSupportedAnnotationTypes(),getSupportedSourceVersion()以及process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment)这四个方法

寻找不能自动生成文件的问题

  1. @AutoService(Processor.class),这个注解必须添加,否则注解处理器不能执行;

  2. 最后写完wirter的流没有关闭,会造成生成文件,但文件内容为空,或者不全;

  3. app Module 要添加之前的三个Library依赖,如下:

     implementation project(path: ':aptlib')
     implementation project(path: ':Annotation')
     annotationProcessor project(path: ':Complier')
    

以上我反复检查了N次,确认无误仍然不能编译生成想要看到的文件,最后找个大神请教下。
说是Android Gradle及构建版本问题,我的是3.4.1 + 5.2.1,会出现不兼容的情况,大神建议3.3.2 + 4.10.1以下都可以。
听了建议降低版本果然构建编译,新的文件生成了。

自动生成的LuacherActivity$ViewBinder类

package com.lyh.apt;

import com.lyh.aptlibViewBinder;
import com.lyh.apt.LuacherActivity;
import com.lyh.apt.R;
public class LuacherActivity$ViewBinder implements ViewBinder<LuacherActivity> {
    @Override
    public void bind(LuacherActivity target) {
        target.tvText = target.findViewById(R.id.tv_text);
    }
}

生成文件目录为:APT构建出来的文件目录

参考

https://www.jianshu.com/p/7af58e8e3e18

此篇文章仅记录问题解决方法,希望对其他人有所帮助,不要像我一样,浪费了大半个晚上,还只是做无用功。

评论 6
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值