java进阶之自定义注解

一、简介

注解是Java 1.5引入的,可以提供代码的额外信息,目前正在被广泛应用。除了Java内置注解,我们也可以自定义注解。

以下就是一个自定义注解的简单例子:

@Target(ElementType.TYPE) //注解作用于类型(类,接口,注解,枚举)@Retention(RetentionPolicy.RUNTIME) //运行时保留,运行中可以处理@Inherited// 注解将被用于该类的子类@Documented// 生成javadoc文件public @interfaceJsAnnotation { String DEFAULT_VALUE = "JS"; /** * 创建此value方法,则使用注解时可直接传参,如 @JsAnnotation("msg") * * @return */ String value default DEFAULT_VALUE;

}

自定义注解关键点:

@interface关键字定义注解

注解可以被其它注解修饰,最重要的就是元注解

注解和接口类似,内部可以定义常量和方法

注解定义的方法有一些限制:方法不能有参数;返回值只能是基本类型、字符串、Class、枚举、注解、及以上类型的数组;可以包含默认值

小编是一个有着5年工作经验的java程序员,对于java,自己有做资料的整合,一个完整学习java的路线,学习资料和工具,相信这里有很多学习java的小伙伴,我创立了一个2000人学习扣群,479121291。每晚都有java的直播课程。无论是初级还是进阶的小伙伴小编我都欢迎!

二、元注解介绍

元注解就是定义注解的注解。

包含@Target、@Retention、@Inherited、@Documented这四种

1、@Target

描述注解的使用目标。

其源码为:

@Documented@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.ANNOTATION_TYPE}) public @interfaceTarget { ElementType[] value;

}

注解方法返回值是ElementType[],ElementType枚举类型,枚举值就是@Target注解的可取值。

方法名value,这样在使用注解时,可以不需要指定方法名。

可取的值有:

取值含义

ElementType.PACKAGE注解作用于包

ElementType.TYPE注解作用于类型(类,接口,注解,枚举)

ElementType.ANNOTATION_TYPE注解作用于注解

ElementType.CONSTRUCTOR注解作用于构造方法

ElementType.METHOD注解作用于方法

ElementType.PARAMETER注解作用于方法参数

ElementType.FIELD注解作用于属性

ElementType.LOCAL_VARIABLE注解作用于局部变量

注意:默认可以作用于以上任何目标。

2、@Retention

描述注解的生命周期。

其源码为:

@Documented@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.ANNOTATION_TYPE}) public @interfaceRetention { RetentionPolicy value;

}

注解方法返回值是枚举类型RetentionPolicy,枚举值就是@Retention注解的可取值。

可取的值有:

取值含义

RetentionPolicy.SOURCE源码中保留,编译期可以处理

RetentionPolicy.CLASSClass文件中保留,Class加载时可以处理

RetentionPolicy.RUNTIME运行时保留,运行中可以处理

默认RetentionPolicy.CLASS 值。

3、@Documented

描述注解可以文档化,是一个标记注解。

在生成javadoc的时候,是不包含注释的,但是如果注解被@Documented修饰,则生成的文档就包含该注解。

其源码为:

@Documented@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.ANNOTATION_TYPE}) public @interfaceDocumented { }

4、@Inherited

标记注解,使用@Inherited修饰的注解作用于一个类,则该注解将被用于该类的子类。

其源码为:

@Documented@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.ANNOTATION_TYPE}) public @interfaceInherited { }

三、自定义注解示例

1、定义注解

@Target(ElementType.TYPE) //注解作用于类型(类,接口,注解,枚举)@Retention(RetentionPolicy.RUNTIME) //运行时保留,运行中可以处理@Inherited// 注解将被用于该类的子类@Documented// 生成javadoc文件public @interfaceJsAnnotation { String DEFAULT_VALUE = "JS"; /** * 颜色枚举 * * @author peida */enum Color {

BULE, RED, GREEN

} /** * 创建此value方法,则使用注解时可直接传参,如 @JsAnnotation("msg") * * @return */ String value default DEFAULT_VALUE; /** * 此方法返回为枚举类型,使用注解时,如 @JsAnnotation(color=Color.BLUE) * * @return */ Color color default Color.BULE; int num default -1;

}

其中:定义了三个方法,三个方法都有默认返回值。定义了Color枚举(因为注解的方法可以返回枚举类型)

这里注意:

- value方法:使用注解时可直接传参,如 @JsAnnotation(“msg”)

- 普通方法:使用注解时,如 @JsAnnotation(color=Color.BLUE)

2、使用注解

@JsAnnotation("jia shuai") publicclass AnnotationTest {

}

@JsAnnotation(num = 100) publicclass AnnotationTest {

}

@JsAnnotation(color = Color.BLUE) publicclass AnnotationTest {

}

3、获取注解

public static void main(String[] args) {

AnnotationTest test = new AnnotationTest; Class tClass = test.getClass; JsAnnotation jsAnnotation = (JsAnnotation) tClass.getAnnotation(JsAnnotation.class); System.out.println(jsAnnotation.value); System.out.println(jsAnnotation.color); System.out.println(jsAnnotation.num); }

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

推荐阅读更多精彩内容