JDK的四个元注解

╰+攻爆jí腚メ 2023-10-09 14:54 31阅读 0赞

#### 四个元注解 ####

*  一：前言
 *  二：什么是Java注解
 *  三：@Target 注解
 *   *  3.1 示例
     *  3.2 常用ElementType
 *  四：@Retention 注解
 *   *  4.1 示例
     *  4.2 常用RetentionPolicy
 *  五：@Documented 注解
 *   *  5.1 示例
 *  六：@Inherited 注解
 *   *  6.1 示例
 *  七：为什么要有元注解
 *   *  7.1 创造注解的机会
     *  7.2 保留字
     *  7.3 管理和控制
     *  7.4 避免错误
 *  八：总结

## 一：前言 ##

最近在研究JAVA注解，既然要研究注解，那么元注解肯定是绕不过去的，今天我就来盘一盘Java的4个元注解

## 二：什么是Java注解 ##

*  在Java中，注解（Annotation）是一种元数据（metadata）的形式，它提供了一种在代码中添加元数据的方式，可以帮助我们更好地理解和组织代码，也可以让代码更具有可读性和可维护性。
 *  注解可以被添加到类、方法、字段、参数等代码元素上，它们以@符号开头，后跟注解名称和一组圆括号，其中可能包含一些参数。

例如，下面是一个使用注解的例子：

@MyAnnotation(name = "demo", value = "test")
    public class MyClass {
        
        //...
    }

\-在这个例子中，@MyAnnotation就是一个注解，它被应用于MyClass类上，并提供了两个参数：name和value。当编译器或运行时环境遇到注解时，它会根据注解的定义来处理相应的代码元素。

## 三：@Target 注解 ##

### 3.1 示例 ###

@Target 注解用于指定注解可以应用于哪些元素。它包含一个 value 属性，可以指定一个 ElementType 数组。  
例如：

@Target({
        ElementType.TYPE, ElementType.METHOD})
    public @interface MyAnnotation {
        
        //...
    }

上面的代码表示 MyAnnotation 注解可以应用于类和方法。

### 3.2 常用ElementType ###

常用的 ElementType 包括：

*  ElementType.TYPE：类、接口、枚举
 *  ElementType.FIELD：字段
 *  ElementType.METHOD：方法
 *  ElementType.PARAMETER：方法参数
 *  ElementType.CONSTRUCTOR：构造方法
 *  ElementType.LOCAL\_VARIABLE：局部变量
 *  ElementType.ANNOTATION\_TYPE：注解
 *  ElementType.PACKAGE：包

## 四：@Retention 注解 ##

### 4.1 示例 ###

@Retention 注解用于指定注解可以保留多长时间。它包含一个 value 属性，可以指定一个 RetentionPolicy 枚举值。例如：

@Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnnotation {
        
        //...
    }

### 4.2 常用RetentionPolicy ###

上面的代码表示 MyAnnotation 注解可以保留到运行时。常用的 RetentionPolicy 包括：

*  RetentionPolicy.SOURCE：只保留在源代码中，不会包含在编译后的 class 文件中。
 *  RetentionPolicy.CLASS：保留到编译时，会包含在编译后的 class 文件中，但不会被加载到 JVM 中。
 *  RetentionPolicy.RUNTIME：保留到运行时，会被加载到 JVM 中，并可以通过反射机制读取注解信息。

## 五：@Documented 注解 ##

### 5.1 示例 ###

@Documented 注解用于指定注解是否包含在 Java 文档中。如果一个注解被 @Documented 修饰，那么在使用 javadoc 命令生成文档时，该注解信息会被包含在文档中。例如：

@Documented
    public @interface MyAnnotation {
        
        //...
    }

## 六：@Inherited 注解 ##

### 6.1 示例 ###

@Inherited 注解用于指定注解是否可以被继承。如果一个注解被 @Inherited 修饰，那么它可以被子类继承。例如：

@Inherited
    public @interface MyAnnotation {
        
        //...
    }

注意，只有在被修饰的注解应用于类时，@Inherited 才会起作用。如果应用于其他元素（如方法或字段），则子类不会继承该注解。

## 七：为什么要有元注解 ##

### 7.1 创造注解的机会 ###

*  元注解，是专门用来定义注解的注解，所有的注解可以由四个元注解限定，这四个注解，给了我们一个可以创造注解的机会。就如同编程语言中的保留字一样，通过这些注解，定制我们需要的注解。