注解
Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。
Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同,Java 标注可以通过反射获取标注内容。在编译器生成类文件时,标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容,在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注。
RetentionPolicy 注解 是 Java 中用来控制注解在程序的不同阶段保留时间的注解。它可以有以下三种取值:
- SOURCE: 注解只在源码阶段保留,编译时会被丢弃。主要用于文档注释或者工具处理。
- CLASS: 注解在编译时保留,但不会写入 class 文件。主要用于编译时代码生成或分析。
- RUNTIME: 注解在编译时保留,写入 class 文件,并在运行时可以通过反射机制获取。这是最常用的保留策略,常用于框架、配置和动态行为。
举个例子:
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
String value();
}
上面的代码定义了一个名为 MyAnnotation
的注解,并指定其保留策略为 RUNTIME
。这意味着该注解会在运行时保留,可以通过反射获取并使用。
RetentionPolicy 注解的常见应用场景:
- 框架: Spring 框架广泛使用注解来配置 Bean、注入依赖等。
- ORM 框架: Hibernate 等 ORM 框架使用注解来映射对象和数据库表。
- 自定义注解: 开发者可以自定义注解来标记代码,并在运行时进行处理。
retentionpolicy注解和annotation注解的区别
RetentionPolicy 和 annotation 虽然经常一起使用,但它们是两个不同的概念:
RetentionPolicy
-
定义: RetentionPolicy 是一个 注解,用来 指定 一个注解(annotation)的 生命周期,也就是这个注解在程序的不同阶段(源码、编译期、运行期)是否保留。
-
作用: 它告诉编译器如何处理被它修饰的注解。
-
取值:
有三种取值:
- SOURCE: 注解只在源代码阶段存在,编译时会被丢弃。
- CLASS: 注解在编译时保留,但不会写入 class 文件。
- RUNTIME: 注解在编译时保留,写入 class 文件,可以在运行时通过反射获取。
annotation(注解)
- 定义: annotation 是 Java 的一种 元数据,用于给程序元素(类、方法、字段等)添加额外的信息。
- 作用: 可以用来生成文档、进行代码检查、实现 AOP 等。
- 组成: 一个注解通常包括注解名、注解参数和 RetentionPolicy 等元注解。
- 使用: 可以将注解应用于类、方法、字段等元素上,提供额外的信息。
简单来说:
- RetentionPolicy 是用来控制注解的 生命周期 的。
- annotation 是用来 标注 程序元素的。
举个例子:
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
String value();
}
在这个例子中:
@Retention(RetentionPolicy.RUNTIME)
表示MyAnnotation
这个注解会在运行时保留,可以通过反射获取。@Target(ElementType.METHOD)
表示MyAnnotation
这个注解只能用于方法上。MyAnnotation
是一个自定义的注解,它的作用是给方法添加一个额外的信息。
总结
RetentionPolicy 是注解的“元注解”,用来控制注解的生命周期,而 annotation 则是用来给程序元素添加信息的。它们是相辅相成的,RetentionPolicy 决定了注解在什么时候可以被访问和使用。
一些annotation注解
- @Override - 检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。
- @Deprecated - 标记过时方法。如果使用该方法,会报编译警告。
- @SuppressWarnings - 指示编译器去忽略注解中声明的警告。
作用在其他注解的注解(或者说 元注解)是:
- @Retention - 标识这个注解怎么保存,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。
- @Documented - 标记这些注解是否包含在用户文档中。
- @Target - 标记这个注解应该是哪种 Java 成员。
- @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)
从 Java 7 开始,额外添加了 3 个注解:
- @SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
- @FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。
- @Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。