聊聊编译时注解(一)

题图

先来看一些用到的注解:
系统自带的


MainActivity

ButterKnife


ButterKnife

以上是两种比较常见的注解。大家肯定也遇到过,今天要讲的是编译时的注解,先把基本概念搬出来晒一下:

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

在 JDK 1.5 之后,Java 语言提供了对注解(Annotation)的支持,这些注解和普通的 Java 代码一样,是在运行期间发挥作用的。在JDK 1.6 中实现了JSR-269 规范。提供了一组差入职注解处理器的标准 API 在编译期间对注解进行处理,我们可以把它看做是一组编译器的插件,在这些插件里面,可以读取,修改,添加抽象语法书中的任意元素。

三类注解:

  • 标准 Annotation
    包括 Override, Deprecated, SuppressWarnings,是java自带的几个注解,他们由编译器来识别,不会进行编译。
  • 元 Annotation
    @Retention, @Target, @Inherited, @Documented,它们是用来定义 Annotation 的 Annotation。也就是当我们要自定义注解时,需要使用它们。
  • 自定义 Annotation
    根据需要,自定义的Annotation。

自定义 Annotation:

@Retention: 定义注解的保留策略

  • @Retention(RetentionPolicy.SOURCE)
    SOURCE
    该注解仅用于源码阶段,就是我们编写的java文件。
  • @Retention(RetentionPolicy.CLASS)
    CLASS
    该注解用于源码、类文件阶段。就是我们编写java文件和编译后产生的class文件。
  • @Retention(RetentionPolicy.RUNTIME)
    RUNTIME
    该注解用于源码、类文件和运行时阶段。

@Target:定义注解的作用目标

  • @Target(ElementType.TYPE)
    接口、类、枚举、注解
  • @Target(ElementType.FIELD)
    字段、枚举的常量
  • @Target(ElementType.METHOD)
    方法
  • @Target(ElementType.PARAMETER)
    方法参数
  • @Target(ElementType.CONSTRUCTOR)
    构造函数
  • @Target(ElementType.LOCAL_VARIABLE)
    局部变量
  • @Target(ElementType.ANNOTATION_TYPE)
    注解
  • @Target(ElementType.PACKAGE)

@interface 表示申明注解用的

写完了注解的知识,接下来我们写个 demo 简单跑一下,加深下理解。

先来看段代码


MainActivity

这段代码中我们看到使用了「@ClickAnnotation」这句代码。那为什么加了这句就会起作用呢?这就是前面讲到的使用了「@Target(ElementType.METHOD)」,作用目标就是在 method 上。后面包含了两个值,一个是 int 型的资源 id ,一个是 String 型。

看看这段代码运行结果


运行结果

那么,上面添加的注解到底做了什么事情呢?我们看下 generated 中生成的代码,可以看到多了一个 MAinActivity$$PROXY 的文件。

生成的文件目录

先不关心这个文件是怎么来的,先打开看看里面是什么东西,打开后可以看到具体生成的代码:


生成的代码

看到这里,大家应该大致上能够了解为什么简单加了注解后会出现上面 gif 显示的效果。其实真正起作用的是这份 java 代码。而这份代码在编译的时候就已经生成了,所以 app 运行的时候就显示了 toast。

今天先写到这,下次聊聊这份 java 代码具体是怎么生成的。

Demo 源码这这边。大家可以先动手玩一下。这样有助于加深理解。
Demo 源码:https://github.com/ibrothergang/DemoAnnotation

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

推荐阅读更多精彩内容

  • 本文章涉及代码已放到github上annotation-study 1.Annotation为何而来 What:A...
    zlcook阅读 28,920评论 15 116
  • 什么是注解(Annotation):Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和...
    九尾喵的薛定谔阅读 3,073评论 0 2
  • 整体Retrofit内容如下: 1、Retrofit解析1之前哨站——理解RESTful 2、Retrofit解析...
    隔壁老李头阅读 6,206评论 4 31
  • 基础知识 定义:注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个...
    老猫头阅读 415评论 0 0
  • 一、什么是注解? 注解对于开发人员来讲既熟悉又陌生,熟悉是因为只要你是做开发,都会用到注解(常见的@Overrid...
    _Justin阅读 1,319评论 0 10