【注解】java 元注解详解，非得给你讲明白

一、定义

1、元数据 / 元注解

1.1 定义：

元数据（Metadata）是描述数据的数据，即用来描述其他数据的数据。在软件开发中，元数据提供关于代码、类、方法、字段等程序元素的信息。

1.2 例子：

在Java中，元数据通常以 注解（Annotations） 的形式存在。注解是一种以结构化、可读性强的方式为程序元素附加信息的机制。例如，你可以使用注解来描述一个方法的作者、版本号、是否过时等信息。

1.3 作用：

元数据的作用包括但不限于：

• 提供信息：通过元数据，你可以为程序元素提供额外的信息，使得代码更加清晰、可读。

• 配置和控制：一些框架和工具使用元数据来配置和控制程序的行为。例如，Spring框架中使用注解进行依赖注入和配置。

• 工具处理：IDE（集成开发环境）、构建工具、文档生成工具等可以利用元数据来提供更好的开发体验和工具支持。

• 运行时处理：一些注解可以在运行时被读取和处理，实现动态的行为。例如，JUnit框架中的测试注解就是在运行时被处理的。

所谓元注解，其主要作用就是负责注解其他注解，为其他注解提供了相关的解释说明。 常常在我们自定义注解的时候使用到.

二、元注解详细分类

在Java中，有一些内置的元注解，它们用于描述如何使用自定义注解。以下是几个常见的元注解：

1、@Target：

用于指定自定义注解可以应用的程序元素类型，如类、方法、字段等。更详细介绍参考【注解】@Target 指定注解可以应用的目标元素类型

@Target(ElementType.TYPE); //类、接口、注解、枚举
@Target(ElementType.FIELD); //字段、枚举常量
@Target(ElementType.METHOD); //方法
@Target(ElementType.PARAMETER);  //形式参数
@Target(ElementType.CONSTRUCTOR);  //构造方法
@Target(ElementType.LOCAL_VARIABLE);  //局部变量
@Target(ElementType.ANNOTATION_TYPE);  //注解
@Target(ElementType.PACKAGE);  //包
@Target(ElementType.TYPE_PARAMETER);  //类型参数
@Target(ElementType.TYPE_USE);  //类型使用

2、@Retention：

表示自定义注解的保留策略，即注解应该保留多长时间，包括 SOURCE、CLASS 和 RUNTIME。更详细介绍参考【注解】@Retention 元注解

@Retention(RetentionPolicy.SOURCE) // 注解仅在源代码中保留
@Retention(RetentionPolicy.CLASS) // 注解在.class文件中保留，但在运行时不可用
@Retention(RetentionPolicy.RUNTIME) // 注解在.class文件中保留，并在运行时可用

3、@Documented：

表示将自定义注解包含在JavaDoc中。
默认情况下，javadoc是不包括注解的，但如果使用了 @Documented 注解，则相关注解类型信息会被包含在生成的文档中.

javadoc是一种从文档注释生成HTML帮助文件的工具

@Documented
public @interface MyAnnotation {
    // 注解的详细信息
}

4、@Inherited：

表示一个自定义注解被用于一个类时，它将自动被该类的子类继承。

@Inherited
public @interface MyInheritedAnnotation {
    // 注解的详细信息
}

这些元注解提供了一种规范，让开发者更好地定义和使用自己的注解。当你需要创建自定义注解时，通常会使用这些元注解来配置你的注解。