java annotation 详解

在java的世界里面,不管是我们自己写代码,亦或是看一些开源框架的代码,我们经常会看到作者使用注解,注解是定义一些额外的信息或者是操作处理的手段,这就是注解的全部意义

注解的分类

Java 1.5中开始引入的Annotation,类似于注释解释的一种技术,我们常常使用它在代码中来做一些注释,并且在适当(编译代码或运行代码等时机)的时候,对其进行解释,并且做一些额外的操作

我们先来了解一下java中已经存在的那些注解和使用方式,然后我们再进行自定义注解操作和使用。

内置注解

我们在开发中,用得最多的Annotation莫过于@Override了。大家天天用,可能很多人却没有关注过其背后的细节,我们看一下它的定义:

// 方法注解,表示此注解修饰的方法覆盖了父类或是接口的方法
// 如果不是这样,则输出警告
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

// 对于此注解所修饰的对象(类、域、方法等)
// 当你使用了它们时编译器将输出“已废弃”警告
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Deprecated {
}

// 关闭警告,通过给此注解的元素赋值
// 可以关闭特定警告
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    String[] value();
}

元注解

@Documented  // 标志将此注解包含至javadoc中

// 定义注解保存级别
// 1.SOURCE 源代码注解,被编译器丢弃
// 2.CLASS 类注解,被编译器记录在class文件中,运行时被VM丢弃,在编译时使用,属于默认配置
// 3.RUNTIME 被编译器记录在class文件中,运行时可用,被VM保留,所以可以在运行时搭配反射使用
@Retention(RetentionPolicy.RUNTIME)

// 定义注解适用的目标
// 1.TYPE Class类,接口(包括注解类型或者enum类型)
// 2.FIELD 属性(包括enum实例)
// 3.METHOD 方法
// 4.PARAMETER 方法参数
// 5.CONSTRUCTOR 类构造器
// 6.LOCAL_VARIABLE 本地变量
// 7.ANNOTATION_TYPE 注解类型
// 8.PACKAGE 包
@Target(ElementType.METHOD)

// 定义继承类型,注解也允许继承
@Inherited

在定义元注解的时候,@Target的值都是定义为ElementType.ANNOTATION_TYPE,例如:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)  // 目标定义为注解类型
public @interface Retention {
    RetentionPolicy value();
}

自定义注解

// 定义运行时使用策略
@Retention(RetentionPolicy.RUNTIME) 
// 适用目标是类的成员变量
@Target(ElementType.FIELD)
public @interface DBField {
    String value() default "";  // default定义了默认值,此处为""
}

那么我们如何使用以上3种类型的注解呢?

举几个栗子

栗子1

public class ApplicantResult {
    @DBField(DBConstants.sign.SHEET_ID)
    long sheetId;
}

解释:由于我们上面定义的DBField注解,使用是在成员变量使用,所以这里我们在ApplicantResult类的属性sheetId中使用,我们发现为什么不是使用@DBField(value=DBConstants.sign.SHEET_ID)呢?
这里使用注解的过程中有几个隐晦的使用规则

  1. 如果注解中定义了value元素
  2. 如果在使用注解时value是惟一需要赋值的元素
  3. 那么只需在括号内给出value的值即可
  4. 如果没有给相应的注解赋值,那么将使用注解中的默认值,类似于@DBField(),value值默认被赋予空值(即default "")

所以这里才有了我们简写的注解使用

栗子2

@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Deprecated {
}

对于元注解@Target,如果你希望一个注解可以作用于ElementType中的所有类型,那么就可以不使用@Target——@Deprecated就是这样做的。

注解的使用

注解的使用,主要是依据@Retention的分类,可以在源码,编译时,运行时,结合不同的@Target配合使用,我们下面主要讲解一下注解有哪几种使用场景

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

推荐阅读更多精彩内容