当前位置：首页 > article >正文

【Java 基础】15 注解

article 2024/11/12 8:50:12

文章目录

- 1.什么是注解
- 2.元注解
- - 1）定义
  - 2）分类
- 3.内置注解
- 4.自定义注解
- 5.注解的基本语法
- 6.验证注解是否生效
- 7.注解的使用场景
- 8.注解的注意事项
- 结语

1.什么是注解

注解（Annotation）可以理解成一种特殊的 “注释”

注解定义时以 @ 符号开头，可以写在包、类、构造方法、方法、字段等元素上，为这些元素提供额外的信息。

如下图： 我们为实体类 User 添加了两个 Lombok 的注解，用以为属性增加 set 和 get 方法
在这里插入图片描述

2.元注解

1）定义

元注解（meta-annotation）是用于注解其他注解的注解

这个听起来或许有一点绕，这些是注解的基础，它们用于提供注解拥有哪些行为信息。

如下图：Lombok 在定义 Getter 的时候，使用了两个元注解 @Target 和 @Retention
在这里插入图片描述

2）分类

在这里插入图片描述

@Target： 用于指定注解可以应用的程序元素类型，包括 TYPE（类、接口、枚举）、FIELD（字段）、METHOD（方法）等。如果没有 @Target 注解，注解可以应用于任何程序元素。
```
@Target(ElementType.TYPE)
public @interface DemoAnnotation {
    // 注解的定义
}
```
@Retention： 用于指定注解的生命周期，即注解在何时有效。可以有三个值：SOURCE（源代码时有效）、CLASS（编译时有效，默认值）、RUNTIME（运行时有效），90% 使用的都是 RUNTIME。
```
@Retention(RetentionPolicy.RUNTIME)
public @interface DemoAnnotation {
    // 注解的定义
}
```
@Documented： 用于指定注解是否包含在 Javadoc 文档中。如果一个注解使用了 @Documented，那么它将会被包含在生成的文档中。
```
@Documented
public @interface DemoAnnotation {
    // 注解的定义
}
```
@Inherited： 用于指定一个注解是否具有继承性。如果一个类使用了带有 @Inherited 的注解，并且其子类没有使用相同的注解，那么子类将继承父类的注解。
```
@Inherited
public @interface DemoAnnotation {
    // 注解的定义
}
```

@Repeatable： 用于指定注解是否可以重复应用于同一程序元素。如果一个注解使用了 @Repeatable，则可以在同一程序元素上多次使用该注解。

@Repeatable(MyAnnotations.class)
public @interface MyAnnotation {
    // 注解的定义
}

public @interface MyAnnotations {
    MyAnnotation[] value();
}

上述元注解用于控制注解的行为，提供了更多的灵活性和可定制性。这些元注解的组合使得我们可以更加精细地定义和使用注解，以满足不同的需求。

3.内置注解

Java 提供了一些内置的注解，它们具有特殊的含义和用途。其中几个常用的内置注解包括：

@Override： 用于标记一个方法是覆盖父类的方法。
@Deprecated： 用于标记已经过时的方法等，提醒开发者不再使用。
@SuppressWarnings： 用于抑制编译器警告。

4.自定义注解

除了使用内置注解，我们还可以定义自己的注解。自定义注解使用 @interface 关键字，并且可以定义元素（成员变量等）。

例如：

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface ClassInfoAnnotation {
    String author();
    String version() default "1.0.0";
    String description();
}

上述代码定义了一个名为 ClassInfoAnnotation 的注解，它有三个元素：author ，version 和 description。

5.注解的基本语法

@interface 注解名 {

}

示例代码：这里使用上一步自定义的注解

@ClassInfoAnnotation(author = "Cheney", description = "This class is Hello")
class Test {
    public void sayHello(){
        System.out.println("hello");
    }
}

在 Test 类上应用了 ClassInfoAnnotation 这个注解，并为元素 author 和 description 赋了值，version 使用默认值。

6.验证注解是否生效

在上面两个步骤中，我们定义了一个自己的注解 ClassInfoAnnotation，也在 Test 类上应用了，那么这个注解是否生效了呢？是否可以帮助我们做一些事情呢？

例如：打印类的信息（author，version，description）

示例代码：

    public static void main(String[] args) {
        // 获取类上的注解
        ClassInfoAnnotation anno = Test.class.getAnnotation(ClassInfoAnnotation.class);
        // 打印注解信息
        System.out.println("Author: " + anno.author());
        System.out.println("Version: " + anno.version());
        System.out.println("Description: " + anno.description());
    }