java中的自定义注解

今天准备把Java中的自定义注解分享一下子,因为好多小伙伴,貌似都不知道注解这个东西到底是什么,只知道怎么用,却不知道注解的底层原理。这一篇就和大家分享一下,文章结构:

Java中的注解概述

四种元注解

自定义注解


1. Java中的注解概述

首先要说明一个东西,注解这个东西绝对不是Spring为我们提供的,而是JDK带的,JDK自己也是有很多内置注解的,比如@override. 注解的功能其实就是为一些加了注解的类,方法等赋予特殊的含义,具体如何产生自定义的含义,其实就是注解处理器了,这是下一篇和大家讲的.

2. 四种元注解

元注解,说白了,就是JDK自带的注解,这些注解是干嘛的呢?其实就是在我们自定义注解时,注解到我们自定义的注解上的,举个例子:

@Target(ElementType.TYPE) public @interface Table { public String tableName() default "className"; }

大家先不要管语法,Table其实就是我自定义的一个注解,可以@Table这样使用了,那么这个@Target其实就是元注解了。JDK自带的元注解如下:

@Target

@Retention

@Documented

@Inherited

@Target

用于描述注解的使用范围,有一个枚举ElementType来指定,具体如下:

CONSTRUCTOR:用于描述构造器

FIELD:用于描述域

LOCAL_VARIABLE:用于描述局部变量

METHOD:用于描述方法

PACKAGE:用于描述包

PARAMETER:用于描述参数

TYPE:用于描述类、接口(包括注解类型) 或enum声明

eg:

@Target(ElementType.METHOD) public @interface Dog { }

大家可以看到,这个Dog注解,只能用到方法上面 。

1). @Retention

表示需要在什么级别保存该注释信息,用于描述注解的生命周期,也是一个枚举RetentionPoicy来决定的,这个枚举我不列出来了,包括这个注解的具体怎么决定注解的生命周期我也不多讲,因为根据小弟这么多年使用的经验,都是填的RetentionPoicy.RUNTIME,填这个值注解处理器才能通过反色拿到注解信息,实现自己的语义,所以大家都填RetentionPoicy.RUNTIME就可以了,想扩展了解的自行google..

2). @Documented

如果用javadoc生成文档时,想把注解也生成文档,就带这个。(话说老铁们都是怎么写文档的,小弟表示从不写文档... ^_^)

3). @Inherited

@Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。注意,@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。

其实这几个注解只有一个有点用,就是@Target,大家稍微注意下就行了。注解不是你想加哪就加哪的。

3. 自定义注解

上面把元注解说了,来讲下如何自定义注解,顺带提一下,自定义的注解又叫组合注解.然后说下自定义注解格式:

1)固定格式,不要搞事.

2)只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型;

3)定义注解参数的类型,只能为:

所有基本数据类型(int,float,boolean,byte,double,char,long,short)

String类型

Class类型

enum类型

Annotation类型

以上所有类型的数组

方法名,就是这个注解的支持的属性名,像常见的value.

表示该属性名在不指定时的默认值,可以不要。

好了,举个例子:

@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Dog { public String dog() default ""; }

好了,大家可以看到,这样就定义了一个注解了。

自定义注解有两种用法:

自定义注解处理器专门为你自定义的注解实现语义(比如加了@Dog注解的方法,在调用的时候,全部都打印出调用信息到日志系统) ,后一篇博客讲自定义注解处理器。

配合Spring使用.

在讲如何配合Spring使用前,先说一个知识点,大家可能会忽略掉,那就是注解是可以组合的,如上图,在自定义注解时,不仅可以加元注解,还可以加其他自定义注解 。这就好玩了,我举个例子:

@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Component public @interface Dog { public String dog() default ""; }

我为刚刚的@Dog注解加了@Component,那么这个注解就会有@Component的功能了(被Spring当做bean加入到Spring容器里).现在在顺带说下属性修饰符public和默认的区别

public修饰的属性能被覆盖,默认的则不能. 举个例子:

@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented @Component @Dog public @interface StupidDog { public String dog() default "我是一条StupidDog"; }

我现在又定义了一个StupidDog注解,这个注解覆盖掉了@Dog的dog属性,把默认值从""改成了"我是一条StupidDog"..

好了,回到话题上,知道了组合注解可以拥有被注解的注解的功能,还拿刚才那个加了@Component注解的@Dog注解来说,当某个类被加了这个注解,比如:

@Dog public class TestService { ... }

我们知道这个TestService在Spring的环境下会被加到Spring容器里成为Bean,可是这有什么鸟用了?这个作用可大了!这可以把Spring容器里的bean区分开来,比如如下代码片段:

// ctx 为Spring的ApplicationContext // // 获取所有带有 Dog 注解的 Spring Bean Map serviceBeanMap = ctx.getBeansWithAnnotation(Dog.class);

大家可以看到,可以通过ApplicationContext取到一些带有特殊标记(自定义注解)的Spring bean! 大家不要小看了这一功能,如果你想在Spring容器初始化完毕后,对某一类Spring Bean做一些特殊操作。自定义注解可以帮你区分开来。

更多java小知识询462403503或点击下方蓝色字体了解

蓝色字体

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

推荐阅读更多精彩内容