1. 注解的基本概念
1.1. 注解(Annotation)又叫标注,是从Java5开始增加的一种引用数据类型。
1.2. 注解本质上就是代码中的特殊标记,通过这些标记可以在编译、类加载、 以及运行时执行指定的处理。
2. 注解的语法格式
2.1. 访问修饰符 @interface 注解名称 { 注解成员};
2.2. 自定义注解自动继承java.lang.annotation.Annotation接口。
2.3. 通过@注解名称的方式可以修饰包、类、 成员方法、成员变量、构造方 法、参数、局部变量的声明等。
3. 注解的使用方式
3.1. 注解体中只有成员变量没有成员方法,而注解的成员变量以“无形参的方 法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。
3.2. 如果注解只有一个参数成员,建议使用参数名为value,而类型只能是八 种基本数据类型、String类型、Class类型、enum类型及Annotation类型。
4. 元注解的概念
4.1. 元注解是可以注解到注解上的注解,或者说元注解是一种基本注解,但 是它能够应用到其它的注解上面。
4.2. 元注解主要有 @Retention、@Documented、@Target、@Inherited、 @Repeatable。
5. 元注解
5.1 @Retention
@Retention 应用到一个注解上用于说明该注解的的生命周期,取值如下
5.1.1. RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时 它将被丢弃忽视。
5.1.2. RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加 载到 JVM 中,默认方式。
5.1.3. RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载 进入到 JVM 中,所以在程序运行时可以获取到它们。
5.2. 元注解@Documented
5.2.1. 使用javadoc工具可以从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档,而该工具抽取时默认不包括注解内容。
5.2.2. @Documented用于指定被该注解将被javadoc工具提取成文档。
5.2.3. 定义为@Documented的注解必须设置Retention值为RUNTIME。
5.3. 元注解@Target
@Target用于指定被修饰的注解能用于哪些元素的修饰,取值如下
ElementType.ANNOTATION_TYPE |
可以给一个注解进行注解 |
ElementType.CONSTRUCTOR |
可以给构造方法进行注解 |
ElementType.FIELD |
可以给属性进行注解 |
ElementType.LOCAL_VARIABLE |
可以给局部变量进行注解 |
ElementType.METHOD |
可以给方法进行注解 |
ElementType.PACKAGE |
可以给一个包进行注解 |
ElementType.PARAMETER |
可以给一个方法内的参数进行注解 |
ElementType.TYPE |
可以给类型进行注解,比如类、接口、枚举 |
5.4. 元注解@Inherited
@Inherited并不是说注解本身可以继承,而是说如果一个超类被该注解标 记过的注解进行注解时,如果子类没有被任何注解应用时,则子类就继 承超类的注解。
5.5. 元注解@Repeatable
5.5.1. @Repeatable表示自然可重复的含义,从Java8开始增加的新特性。
5.5.2. 从Java8开始对元注解@Target的参数类型ElementType枚举值增加了两个
其中ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明 语句中,如:泛型。
其中ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中
6. 常见的预制注解
6.1. 预制注解就是Java语言自身提供的注解,具体如下
@author
|
标明开发该类模块的作者,多个作者之间使用,分割 |
@version |
标明该类模块的版本 |
@see |
参考转向,也就是相关主题 |
@since |
从哪个版本开始增加的 |
@param |
对方法中某参数的说明,如果没有参数就不能写 |
@return |
对方法返回值的说明,如果方法的返回值类型是void就 不能写 |
@exception |
对方法可能抛出的异常进行说明
|
6.2. 常见的预制注解
@Override |
限定重写父类方法, 该注解只能用于方法 |
@Deprecated |
用于表示所修饰的元素(类, 方法等)已过时 |
@SuppressWarnings |
抑制编译器警告 |