Java注解

Java注解

注解实际就是一种元数据 为程序元素设置元数据 并且可以对程序执行没有影响。

元数据

描述数据的数据 元数据可以为程序元素(如方法、类等)上添加额外信息。元数据作用大概可以分为三类:

  1. 编写文档:通过代码里标识的元数据生成文档 比如Javadoc
  2. 代码分析:通过代码里标识的元数据对代码进行分析 比如利用反射获取代码中的元数据
  3. 编译检查:通过代码里标识的元数据可以让编译器实现编译检查 比如Java提供的一些注解SuppressWarnings

Annotation类型

根据使用方法和用途注解可以分为三类:

  1. 元注解
  2. 系统内置注解
  3. 自定义注解

元注解

元注解是注解其他注解的注解。目前Java有5个元注解,他们是:

  • Retention

描述注解被保留的时间长短,有三个取值分别是:RetentionPolicy.SOURCE(注解仅存在于源码中)、RetentionPolicy.CLASS( 默认的保留策略,注解会在class字节码文件中存在)、RetentionPolicy.RUNTIME(在运行时可以通过反射获取到)

如果我们想要通过反射获取注解那么应该使用RetentionPolicy.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)作用于注解(@Retention注解中就使用该属性)
    @Target(ElementType.PACKAGE) 作用于包
    @Target(ElementType.TYPE_PARAMETER) 作用于类型泛型,即泛型方法、泛型类、泛型接口 (jdk1.8加入)
    @Target(ElementType.TYPE_USE) 类型使用.可以用于标注任意类型除了 class (jdk1.8加入)

  • Documented

作用是能够将注解中的元素包含到 Javadoc 中去。

  • Inherited

一个被@Inherited注解了的注解修饰了一个父类,如果他的子类没有被其他注解修饰,则它的子类也继承了父类的注解。

  • Repeatable

表示注解可以同时作用一个对象多次,但是每次作用注解又可以代表不同的含义。

系统内置注解

  • SuppressWarnings
    告知编译器忽略特定的异常信息 仅保留在源文件中
  • Deprecated
    表示该程序元素已过时 用于除注解类型声明之外的所有元素,保留时长为运行时。
  • FunctionalInterface
    Java 8 开始支持,标识一个匿名函数或函数式接口。 保留时长为运行时
  • override
    覆写父类方法 仅在源文件中保留

Android提供了众多注解比如@Keep、@NonNull、@Nullable、@StringRes等等

自定义注解

可以使用 @interface 自定义注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是 基本类型、Class、String、enum)。可以通过 default 来声明参数的默认值。

注解元素必须有确定的值,要么在定义注解的默认值中指定,要么在使用注解时指定,非基本类型的注解元素的值不可为null。因此, 使用空字符串或0作为默认值是一种常用的做法。

注解应用

  • Apt 注解处理器,用来在编译期扫描和处理注解,通过注解来生成 Java 文件
  • 插桩,编译后处理筛选
  • 运行时注解 反射获取注解

一小时搞明白自定义注解(Annotation)

教你实现一个轻量级的注解处理器(APT)

注解(Annotation)-Android讲解

详尽的Android编译时注解处理器教程

Android中注解的一些总结

字节码插桩--你也可以轻松掌握

Android 自定义注解处理器并生成 json 文件

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