[Java基础复习]注解
一、什么是注解
- 注解是JDK1.5才引入的,Java增加了对元数据(描述数据的数据)的支持,也就是注解。
- 注解可以标注在类,成员变量,方法、形参上等。
- 注解可以做到在不改变代码逻辑的前提下在代码中嵌入补充信息。
- 这些信息被保存在注解的“name=value”键值对中。
- 框架=反射+注解+设计模式
从JDK5.0开始,Java增加了对元数据的支持,也就是注解。注解其实就是代码中的特殊标记,这些特殊标记可以在编译、类加载、运行时被读取,并执行相应的处理。通过使用注解,可以做到在不改变代码原有逻辑的情况下,在代码中嵌入一些补充信息。注解可以标注在类,成员变量,方法,形参上等。
二、JDK内置注解
-
@Deprecated:
- 被这个注解标注的元素已过时。
- 这个注解是给编译器看的,编译器看到这个注解之后会有警告提示信息。
-
@Override:
- 修饰实例方法,则该方法必须是个重写方法,否则就会编译失败。
-
@FunctionalInterface:
- “函数式接口”的注解,这个是JDK1.8版本引入的特性。使用@FunctionalInterface标注的接口,则该接口就有且只能存在一个抽象方法,否则就会发生编译错误。
三、自定义注解
- 使用@interface来定义注解
@元注解
【修饰符】 @interface 注解名 {
返回值类型 属性名() default 默认值;
}
- 默认情况下可以出现在类上、方法上、属性上、构造方法上、方法参数上等
- 所有自定义的注解,其父类是:java.lang.annotation.Annotation
- 不包含任何元素(或者说属性)的注解称为标记注解
四、注解也可以定义属性
- 注解可以定义属性,不过属性定义时,属性名后面必须加一个小括号。
- 如果这个注解中有属性,那么使用的时候,必须给属性赋值。没有赋值则报错,除非在定义注解的时候给属性指定了默认值。
- 怎么给属性赋值? @MyAnnotation(属性名=值, 属性名=值, 属性名=值)
- 注解的元素在使用时表现为名-值的形式,并且需要放置在@注解()声明之后的括号内。
- 属性的类型只能是:
- byte、short、int、long、float、double、boolean、char
- String、Class、枚举类型、注解类型
- 以上所有类型的一维数组形式
- 后面写default,给出默认值,如果没有指定默认值,那么使用该注解时必须通过“方法名=值”的形式进行赋值
- 如果是数组,则使用{}进行赋值
五、注解的使用
- 注解在使用时必须给属性赋值,除非使用了default关键字为属性指定了默认值
- 如果属性只有一个,并且属性名是value时,使用注解时value可以省略不写
- 如果属性是一个数组,使用注解时,数组值只有一个,数组的大括号可以省略
- 注意:任何非基本类型的元素,无论是在源代码声明时还是在注解接口中定义默认值时,都不能使用null作为其值。这个限制使得处理器很难表现一个元素的存在或者缺失的状态。为了绕开这个约束,可以自定义一些特殊的值,比如空字符串或者负数用于表达某个元素不存在。
import java.lang.annotation.*;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SimulatingNull {
int id() default -1;
String description() default "";
}
六、元注解(用来标注注解的注解)
元注解:用来标注注解的注解(也是JDK内置的注解)
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override{
}
常用的元注解:
- @Retention:设置注解的保持性
- @Target:设置注解可以出现的位置
- @Documented:设置注解是否可以生成到帮助文档中
- @Inherited:设置注解是否支持继承
- @Repeatable:设置注解在某一元素上是否可以重复使用(Java8新特性)
@Retention
@Retention:用于解释新声明注解的保留策略。使用Retention注解时必须用枚举类RetentionPolicy的三个常量对象之一来指定具体的保留策略。
- Retention英文意思有保留、保持的意思,它表示注解存在阶段是保留在源代码(编译期)、字节码(类加载)或运行时(JVM中运行)
- 在@Retention注解中使用枚举RetectionPolicy来表示注解保留时期。
- @Retention(RetectionPolicy.SOURCE):注解仅存在于源码中,在字节码文件中不包含
- @Retention(RetectionPolicy.CLASS):注解在字节码文件中存在,但运行时无法获得
- @Retention(RetectionPolicy.RUNTIME):注解在字节码文件中存在,且运行时可以通过反射获取(程序员自定义的注解都使用这个策略,因为必须保证程序运行期间使用反射读取到注解信息)
@Target
用于解释新声明的注解可以使用在什么位置。使用Target注解时必须用枚举类的常量对象来指定具体的位置。如果某个注解声明时没有加Target注解,则表示所有位置都可以。
- 用于描述注解可以使用的位置,该注解使用ElementType枚举类型用于描述注解可以出现的位置
@Documented
用于解释新声明注解用在某个包、类、方法等上面后,当使用javadoc工具提取文档注释生成的API文档时,是否将对应的注解信息也读取到API文档。加@Documented的注解其@Retention的RetentionPolicy值必须为RUNTIME才有意义。
@Inherited
一个被@Inherited注解修饰的注解,如果该注解修饰了一个父类,则它的子类也会继承父类的注解
@Repeatable
Java 8以前的版本在使用注解时有一个限制,即相同的注解在同一位置只能使用一次,不能使用多次。Java 8引入了重复注解机制,这样相同的注解可以在同一地方使用多次,重复注解机制本身必须用@Repeatable注解标记。
Repeatable表示可以重复的含义,该注解属于JDK1.8版本的新特性,允许一个注解被使用一次或者多次。
七、反射注解
// 获取类
Class<MyClass> myClass = MyClass.class;
// 判断该类上是否存在这个注解
if (myClass.isAnnotationPresent(Annotation1.class)) {
// 获取指定的某个注解
Annotation1 a1 = myClass.getAnnotation(Annocation1.class);
// 访问注解对象中的属性值
System.out.println(a1.name());
}