美文网首页
今天学习十分钟——Annotation Processor To

今天学习十分钟——Annotation Processor To

作者: 走川 | 来源:发表于2017-09-27 01:14 被阅读127次

大家好,我是走川。只有十分钟,没时间废话了!我要发车了!!!!

所有Android开发一定都了解或使用过 Butterknife、Dragger等编译期生成代码的框架,今天的学习就是入门 Annotation Processor Tools(注解处理工具),在简单的学习之后,你能有以下收获

1. 学习代码辅助生成的方式
2. 成功通过APT生成以下代码

public class MainActivity_SayHi{
 public void sayHi(String content){
   System.out.println(content);
 }
}

好了,在开始之前,我们先准备好原材料:新建一个Android工程 (´・ω・`)

工程目录

0x1

新建一个 Java Module,并让app工程依赖于这个lib

新建Java Module 修改依赖

0x2 在这个lib库中新增一个自定义注解

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface SayHi {
}

0x3 在app工程中MainActivity增加SayHi注解


@SayHi
public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
}

0x4 在这个lib库中新增一个自定义 注解处理器

注解处理器在使用前需要先向JVM注册,在module的META-INF目录下新建services目录,并创建一个名为javax.annotation.processing.Processor的文件,在此文件内逐行声明注解处理器。同样地,此处需要声明的也是处理器类的完全限定名。
另一个简便的方法是使用Google提供的auto-services库,在build.gradle中引入com.google.auto.service:auto-service:1.0-rc2,并在处理器类上添加注解@AutoService(Processor.class),auto-services也是一个注解处理器,会在编译时为该module生成声明文件。

@AutoService(Processor.class)
public class SayHiProcessor extends AbstractProcessor {

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> types = new HashSet<>();
        types.add(SayHi.class.getCanonicalName());
        return types;
    }

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        /*roundEnv.getRootElements()会返回工程中所有的Class
        在实际应用中需要对各个Class先做过滤以提高效率,避免对每个Class的内容都进行扫描*/
        for (Element element : roundEnvironment.getRootElements()) {
            if (element.getAnnotation(SayHi.class) == null) { //过略掉没有添加SayHi注解的class
                return true;
            }
            String enclosingName = ((TypeElement) element).getQualifiedName().toString(); //获取类的全限定类名
            String packageName = enclosingName.substring(0, enclosingName.lastIndexOf('.')); //获取包名
            String clazzName = element.getSimpleName() + "_SayHi";  //生成类的名字

            try {
                JavaFileObject javaFileObject = processingEnv.getFiler().createSourceFile(clazzName); //创建文件
                Writer writer = javaFileObject.openWriter();
                //以下都是对文件的文件流操作,对下面的插入字符可以对照上面的生成代码
                PrintWriter printWriter = new PrintWriter(writer);
                printWriter.println("package " + packageName + ";");
                printWriter.println("\npublic class " + clazzName + "{");
                printWriter.println("\n\tpublic void sayHi(String content){");
                printWriter.println("\n\t\tSystem.out.println(content);");
                printWriter.println("\n\t}");
                printWriter.println("\n}");
                printWriter.flush();
                printWriter.close();
                writer.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return true;
    }
}

0x5 添加APT插件

  1. 修改project的build.gradle
  1. 修改app的build.gradle
image.png

0x6 运行结果

  1. 点击 Build -> Rebuild Project


    点击Rebuild
  2. 打开 build -> generated -> source -> debug 查看生成文件
查看生成文件

参考链接:
http://www.jianshu.com/p/f85e5212be55
https://yq.aliyun.com/articles/59493
https://www.2cto.com/kf/201608/536317.html

相关文章

网友评论

      本文标题:今天学习十分钟——Annotation Processor To

      本文链接:https://www.haomeiwen.com/subject/rdxyextx.html