一、常见的元注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Loggable{
}
二,注解说明
2.1.@Target注解
@Target注解定义了此注解用于方法、类等之上。
@Target(ElementType.METHOD)
2.2@Retention
@Retention 是 Java 中的一个元注解,用于指定注解的保留策略,即注解在代码编译后和运行时的保留状态。Java 中的注解在不同的保留策略下,可以在不同的阶段访问和处理。
@Retention 注解有一个属性 value,用于指定保留策略,它接受一个 RetentionPolicy 枚举值作为参数。以下是 RetentionPolicy 枚举的值及其含义:
- RetentionPolicy.SOURCE:注解仅在源代码中保留,编译后不会包含在编译后的字节码中,也不会在运行时可用。用于提供编译时的辅助信息,例如 Lombok 注解。
- RetentionPolicy.CLASS:注解会保留到编译后的字节码中,但在运行时不可用。这是默认的保留策略,如果没有显式指定 @Retention,则默认为 CLASS。
- RetentionPolicy.RUNTIME:注解会保留到编译后的字节码中,并且在运行时可以通过反射机制来获取和处理。用于在运行时动态地获取注解信息,例如自定义注解、Spring 的注解等。
2.3@Inherited注解
@Inherited 是一个标记注解,用于指示一个自定义注解是否可以被子类继承。默认情况下,自定义注解是不会被子类继承的,即使父类使用了该注解,子类也不会自动继承该注解。但是,如果将 @Inherited 注解放在自定义注解上,那么这个注解将会被子类继承。
示例:
import java.lang.annotation.*;
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyAnnotation {
String value();
}
@MyAnnotation("ParentClass")
public class ParentClass {
}
public class ChildClass extends ParentClass {
}
2.4@Documented注解
@Documented注解也是一个标记注解,用户表示在生成javadoc文档中是否包含。默认是不会包含的,加上就会包含。