今天准备把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或点击下方蓝色字体了解。