编译时生成代码

ButterKnife使我们经常使用的一款View注入框架,使用方便,特点是ButterKnife使用的是编译时生成代码,而不是反射注入。那么我就有一个问题,ButterKnife究竟是如何在编译时生成代码的呢?这就是这篇文章的目的了。。。

先做一个例子我们来试着在编译时做一些操作。
介绍几个概念

1.APT

APT-annotation processing tool是在编译时,扫描和处理注解的一个构建工具,该工能由 javac 来实现,我们可以在 javac 编译时源代码额外生成 java 源代码(也可以是其它类型的文件)。关于如何处理注解我们需要了解AbstractProcessor这个类。Annotation Processor的实现,都需要继承自该类。

2.AbstractProcessor

AbstractProcessor 是 javac 扫描和处理注解的关键类。介绍两个关键的方法,

(1)public Set<String> getSupportedAnnotationTypes()

制定需要处理哪些注解 ,返回值是注解全类名的Set。

(2)public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)

Processor的主方法,可以在该方法中处理注解,并生成Java代码,并可以通过RoundEnvironment获取到被注解的元素。

先创建三个Module

1.app (Android Module已存在)

2.api (Java Module存放我们的注解)

3.compiler (Java Module 存放我们的Processor)

声明插件依赖

声明插件android-apt,这个是Android Studio 与annotation processors结合的一个插件,在构建工程时将辅助javac执行processor, 在根目录的build.gradle添加:

  classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'

api Module

定义注解

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

app module

在app的build.gradle:

  apply plugin: 'com.neenbedankt.android-apt'

  dependencies {
      ...
      compile project(':api')
      apt project(':compiler')
      ...
  }

使用api中定义的注解

    @MyAnnotation
    public class Bean {
    }

compiler module

在build.gradle:

  apply plugin: 'java'

  dependencies {
      compile fileTree(include: ['*.jar'], dir: 'libs')
      compile 'com.google.auto.service:auto-service:1.0-rc3'
      compile 'com.squareup:javapoet:1.8.0'
      compile project(':api')
  }

这里添加了三个依赖

1.api: 我们需要获取到我们定义的MyAnnotation注解

2.auto-service:用来自动生成 javax.annotation.processing.Processor 文件。location:https://github.com/google/auto/tree/master/service

3.javapoet:自动生成代码的工具类库。location:https://github.com/square/javapoet

然后创建我们的Processor类。

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

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        return Collections.singleton(MyAnnotation.class.getCanonicalName());
    }

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        System.out.println("Message");
        return true;
    }
}

这时clean下Project 然后运行./gradlew assemble就可以看到输出的Message。

JavaPoet是一个用来生成.java源文件的Java API。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容