自定义注解时,通常需要使用到三个元注解,它们分别是 @Retention
、@Target
和 @Documented
。这些元注解用于指定自定义注解的保留策略、作用目标和是否包含在 Java 文档中。下面是它们的作用和示例用法:
@Retention
:- 用于指定自定义注解的保留策略,即注解在什么时候有效。
- 有三种保留策略:
RetentionPolicy.SOURCE
:注解仅在源代码中有效,编译后不保留。RetentionPolicy.CLASS
:注解在编译时有效,但不会包含在运行时的字节码中,默认值。RetentionPolicy.RUNTIME
:注解在运行时有效,可以通过反射获取注解信息。
- 示例:
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
// 自定义注解内容
}
-
@Target
:- 用于指定自定义注解的作用目标,即注解可以应用到哪些元素上。
- 可以指定多个作用目标,如类、字段、方法等。
- 示例:
import java.lang.annotation.ElementType; import java.lang.annotation.Target; @Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD}) public @interface MyAnnotation { // 自定义注解内容 }
-
@Documented
:- 用于指定是否将注解包含在 Java 文档中。
- 如果使用了
@Documented
元注解,那么在生成 Java 文档时,该注解会包含在文档中。 - 示例:
import java.lang.annotation.Documented; @Documented public @interface MyAnnotation { // 自定义注解内容 }
通过结合使用这三个元注解,可以定义出具有灵活性和可读性的自定义注解,并且可以控制注解的保留策略、作用目标和是否包含在文档中,实现不同的注解用途和行为。