深入理解编译注解(二)annotationProcessor与android-apt

来源:互联网 发布:nc 数据库修改凭证 编辑:程序博客网 时间:2024/06/12 21:49

前言

之前我们已经实际感受了编译注解的使用,虽然操作起来稍微复杂一些,但是提高了程序运行的效率,用户体验会更好,作为开发者来说,这点牺牲还是值得的。

在demo中使用了annotationProcessor来表明程序之间是编译关系,这一篇来仔细的了解一下annotationProcessor。

正文

什么是APT?

APT(Annotation Processing Tool)是一种处理注释的工具,它对源代码文件进行检测找出其中的Annotation,使用Annotation进行额外的处理。 Annotation处理器在处理Annotation时可以根据源文件中的Annotation生成额外的源文件和其它的文件(文件具体内容由Annotation处理器的编写者决定),APT还会编译生成的源文件和原来的源文件,将它们一起生成class文件。

annotationProcessor就是APT工具中的一种,他是google开发的内置框架,不需要引入,具体的使用方法:

这里写图片描述

这里写图片描述

首先配置好要编译的库,如果没有其他的需要,这就已经足够了,当然在个别情况下,想要给编译处理器一些参数,就可以用arguments来设置,中括号里面是键值对,通过“,”隔开。

配置参数需要在android—>defaultConfig 中设置
arguments 设置给编译处理器的参数
includeCompileClassPath 包含编译Class的路径(供系统使用)
classNames 运行指定的编译处理器(供系统使用)

arguments的参数该怎么得到呢?

@Override    public synchronized void init(ProcessingEnvironment processingEnv) {        super.init(processingEnv);        messager = processingEnv.getMessager();        elementsUtils = processingEnv.getElementUtils();        // 在这里打印gradle文件传进来的参数        Map<String, String> map = processingEnv.getOptions();        for (String key : map.keySet()) {            messager.printMessage(Diagnostic.Kind.NOTE, "key" + ":" + map.get(key));        }    }

在自定义AbstractProcessor的init方法,可以来得到gradle配置的参数,输出信息可以在Message窗口看到:

这里写图片描述

annotationProcessor提供的主要就是这些功能,如果你已经学习编译注解有一段时间,你应该还见过android-apt。

android-apt

android-apt是由一位开发者自己开发的apt框架,随着Android Gradle 插件 2.2 版本的发布,Android Gradle 插件提供了名为 annotationProcessor 的功能来完全代替 android-apt ,自此android-apt 作者在官网发表声明证实了后续将不会继续维护 android-apt ,并推荐大家使用 Android 官方插件annotationProcessor。

某妹纸对android-apt的官方文档的翻译:http://www.jianshu.com/p/2494825183c5

android-apt的使用步骤:

1、在project中,配置android-apt插件:

这里写图片描述

2、指定要编译的库:

这里写图片描述

3、可以设置参数:

这里写图片描述

总结

annotationProcessor与android-apt的使用方法非常类似的,推荐使用google自己开发的annotationProcessor,配置简单,而且google自己维护的框架各方面的性能都是有保证的。

有讲解错误或者有不明白的地方,欢迎留言指正。

点击下载源码

1 0
原创粉丝点击