JAVA中的元注解

最新推荐文章于 2024-10-01 18:51:18 发布

程序研

最新推荐文章于 2024-10-01 18:51:18 发布

阅读量690

点赞数 18

分类专栏： java 文章标签： java 开发语言后端

本文链接：https://blog.csdn.net/qa3629723/article/details/141719760

版权

java 专栏收录该内容

74 篇文章 0 订阅

订阅专栏

元注解是用于注解其他注解的注解。Java提供了几个元注解，它们定义了注解的行为和作用域。 一、@Target

简介 @Target注解用于指定注解可以应用于哪些Java元素。它有一个名为value的必需参数，该参数是一个ElementType枚举的数组，用于指定注解可以应用的目标类型。 ElementType的常用值包括：

ElementType.TYPE：应用于类、接口或枚举
ElementType.FIELD：应用于字段或枚举常量
ElementType.METHOD：应用于方法
ElementType.PARAMETER：应用于方法参数
ElementType.CONSTRUCTOR：应用于构造器
ElementType.LOCAL_VARIABLE：应用于局部变量
ElementType.ANNOTATION_TYPE：应用于注解类型
ElementType.PACKAGE：应用于包声明

代码例子

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
// 定义一个自定义注解，只能应用于方法
@Target(ElementType.METHOD)
@interface CustomAnnotation {
    String value() default "default";
}
class MyClass {
    // 使用自定义注解
    @CustomAnnotation("Hello")
    void myMethod() {
        System.out.println("Method annotated with CustomAnnotation");
    }
}
public class MetaAnnotationTest {
    public static void main(String[] args) {
        MyClass obj = new MyClass();
        obj.myMethod();
    }
}

运行结果

Method annotated with CustomAnnotation

如果我们尝试将CustomAnnotation应用于字段或其他非方法元素，编译器会报错。

二、@Retention

简介 @Retention注解用于指定注解的保留策略，即注解的生命周期。它有一个名为value的必需参数，该参数是RetentionPolicy枚举的一个值。 RetentionPolicy的值包括：

RetentionPolicy.SOURCE：注解只保留在源代码中，编译时会被忽略
RetentionPolicy.CLASS：注解保留在编译后的类文件中，但会被JVM忽略
RetentionPolicy.RUNTIME：注解保留在运行时，可以通过反射读取

代码例子

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.reflect.Method;
@Retention(RetentionPolicy.RUNTIME)
@interface CustomAnnotation {
    String value() default "default";
}
class MyClass {
    @CustomAnnotation("Hello")
    void myMethod() {
        System.out.println("Method annotated with CustomAnnotation");
    }
}
public class MetaAnnotationTest {
    public static void main(String[] args) throws NoSuchMethodException {
        MyClass obj = new MyClass();
        obj.myMethod();
        // 通过反射获取注解信息
        Method method = MyClass.class.getMethod("myMethod");
        CustomAnnotation annotation = method.getAnnotation(CustomAnnotation.class);
        System.out.println("Annotation value: " + annotation.value());
    }
}

运行结果

Method annotated with CustomAnnotation
Annotation value: Hello

如果我们把@Retention的值改为SOURCE或CLASS，那么在运行时通过反射获取注解信息将不会成功。

三、@Documented

简介 @Documented注解用于指示一个注解应该被 javadoc 工具记录。如果一个注解被@Documented注解，那么它的信息会被包含在生成的文档中。
代码例子

import java.lang.annotation.Documented;
@Documented
@interface CustomAnnotation {
    String value() default "default";
}
@CustomAnnotation("Hello")
class MyClass {
    // 类和方法
}
public class MetaAnnotationTest {
    public static void main(String[] args) {
        // 主方法
    }
}

运行结果运行这段代码本身不会有任何输出。但是，如果我们使用javadoc工具生成文档，MyClass类和CustomAnnotation注解的相关信息将会被包含在生成的文档中。

四、@Inherited

简介 @Inherited注解用于指示一个注解类型被自动继承。如果一个类使用了@Inherited注解的注解，那么它的子类也会继承这个注解。
代码例子

import java.lang.annotation.Inherited;
@Inherited
@interface CustomAnnotation {
    String value() default "default";
}
@CustomAnnotation("Hello")
class ParentClass {
}
class ChildClass extends ParentClass {
}
public class MetaAnnotationTest {
    public static void main(String[] args) throws NoSuchMethodException {
        // 检查ChildClass是否继承了CustomAnnotation
        CustomAnnotation annotation = ChildClass.class.getAnnotation(CustomAnnotation.class);
        if (annotation != null) {
            System.out.println("ChildClass inherits the annotation: " + annotation.value());
        } else {
            System.out.println("ChildClass does not inherit the annotation.");
        }
    }
}

运行结果

ChildClass inherits the annotation: Hello

在这个例子中，ParentClass 使用了 @CustomAnnotation 注解，由@CustomAnnotation 被 @Inherited 元注解标记，因此 ChildClass 继承了 ParentClass 的注解。以上是Java中四个元注解的详细介绍、代码例子和运行结果。元注解是Java注解机制中非常重要的一部分，它们定义了注解的行为和作用域，使得注解能够以不同的方式被使用。虽然本回答已经详细介绍了四个元注解，但Java的注解机制非常灵活和强大，还有更多的细节和用法可以探索。例如，可以结合使用多个元注解来定义复杂的注解行为，还可以通过自定义注解处理器（Annotation Processor）在编译时处理注解。在实际开发中，元注解可以帮助我们创建出符合特定需求的注解，从而提高代码的可读性、可维护性以及减少重复工作。

以下是一些使用元注解的额外提示：