APT 编译时注解 知识点

1. 怎么自定义编译时注解的名称(以我的项目 AutoInject 为例)

  • 第一种方法:
    在AutoInject-compiler的main目录下创建目录resources/META-INF/services,并在该目录下创建文件javax.annotation.processing.Processor,在该文件中写入注解处理器的全限定类名(这里是com.zilong.compiler.AutoInjectProcessor)

  • 第二种方法:
    特别简单,只需要导入依赖google提供的auto-service开源库。如下:

      apply plugin: 'java-library'
    
      dependencies {
          implementation project(':annotation')
          implementation fileTree(dir: 'libs', include: ['*.jar'])
          //**************************************************************
          implementation 'com.google.auto.service:auto-service:1.0-rc4' //这里是导入的google开源库
          //*************************************************************
          implementation 'com.squareup:javapoet:1.11.1'
      }
      sourceCompatibility = "8"
      targetCompatibility = "8"
    

    然后在注解处理器上添加注解@AutoService(Processor.class)即可。如下:

      @AutoService(Processor.class)
      @SupportedSourceVersion(SourceVersion.RELEASE_8)
      public class AutoInjectProcessor extends AbstractProcessor { 
            ...
      }
    

2. 为什么一般都分为两个库(***-compiler 和 ***-annotation)

因为自定义AbstractProcessor的作用是在编译时生成相关的java源文件的,在程序中最后需要的是他生成的Java文件,最后打包进apk也是他生成的文件,***-compiler 本身是不需要打包的。 但是在 ***-compiler和主工程(用到编译时注解的业务代码工程)中需要对具体的注解类进行操作,所以将具体的注解Annotation放在一个库 ***-annotations中便于引用。

3. 为什么***-compiler工程要建成 java工程

在使用自定义AbstractProcessor需要使用到 javax 包中的相关类和接口,这个在android库中并不存在,所以需要使用到Java库。

4. Element 接口 参数解释

    #获取类名
    Element.getSimpleName().toString(); 
    #获取类的全名
    Element.asType().toString(); 
    #获取所在的包名
    Elements.getPackageOf(Element).asType().toString();
    #获取所在的类
    Element.getEnclosingElement();
    #获取父类
    Types.directSupertypes(Element.asType());
    #获取标注对象的类型
    Element.getKind();

Elment有几个子接口如下:他们的特有方法,用到了自己查一下

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

推荐阅读更多精彩内容