Java 注解

目录

• 基本注解
• 元注解
• 自定义注解

本质上都一种数据类型，是一种接口类型

作用：

• 生成帮助文档
• 跟踪代码依赖性，实现替代配置文件功能，减少配置文件数量
• 在编译时进行格式检查。如把 @Override 注解放在方法前，如果这个方法并不是重写了父类方法，则编译时就能检查出

到 Java 8 为止 Java SE 提供了 11 个内置注解.

基本注解

• 其中有 5 个是基本注解，来自于 java.lang 包.
  • @Override
    • 指定方法重写
  • @Deprecated
    • 注解类、接口、成员方法和成员变量等，用于表示某个元素（类、方法等）已过时. 当其他程序使用已过时的元素时，编译器将会给出警告
  • @SuppressWarnings
    • 取消显示编译器警告
  • @SafeVarargs
  • @FunctionalInterface
    • 用来指定某个接口必须是函数式接口，所以 @FunInterface 只能修饰接口，不能修饰其它程序元素.
• 有 6 个是元注解，来自于 java.lang.annotation 包，自定义注解会用到元注解.

元注解

元注解就是负责注解其他的注解，负责对其它注解进行说明

• @Documented

  • @Documented 是一个标记注解，没有成员变量。用 @Documented 注解修饰的注解类会被 JavaDoc 工具提取成文档。默认情况下，JavaDoc 是不包括注解的，但如果声明注解时指定了 @Documented，就会被 JavaDoc 之类的工具处理，所以注解类型信息就会被包括在生成的帮助文档中。

• @Target

  • 用来指定一个注解的使用范围，即被 @Target 修饰的注解可以用在什么地方。@Target 注解有一个成员变量（value）用来设置适用目标，value 是 java.lang.annotation.ElementType 枚举类型的数组，下表为 ElementType 常用的枚举常量。

  

  @Target({ElementType.TYPE})
  public @interface MyTarget {
  }
  
  @MyTarget
  class Test {
      void myTest() {
          System.out.println("Hello");
      }
  }
  

• @Retention

  • 用于描述注解的生命周期，也就是该注解被保留的时间长短。@Retention 注解中的成员变量（value）用来设置保留策略，value 是 java.lang.annotation.RetentionPolicy 枚举类型，RetentionPolicy 有 3 个枚举常量

    • SOURCE：在源文件中有效（即源文件保留）
    • CLASS：在 class 文件中有效（即 class 保留）
    • RUNTIME：在运行时有效（即运行时保留）

    生命周期大小排序为 SOURCE < CLASS < RUNTIME，前者能使用的地方后者一定也能使用。如果需要在运行时去动态获取注解信息，那只能用 RUNTIME 注解；如果要在编译时进行一些预处理操作，比如生成一些辅助代码，就用 CLASS 注解；如果只是做一些检查性的操作，比如 @Override 和 @SuppressWarnings，则可选用 SOURCE 注解。

    @Retention(RetentionPolicy.RUNTIME)
    

• @Inherited

  • 标记注解，用来指定该注解可以被继承。使用 @Inherited 注解的 Class 类，表示这个注解可以被用于该 Class 类的子类。就是说如果某个类使用了被 @Inherited 修饰的注解，则其子类将自动具有该注解

• @Repeatable

  • Java 8 新增加的，它允许在相同的程序元素中重复注解，在需要对同一种注解多次使用时，往往需要借助 @Repeatable 注解。

• @Native

  • 使用 @Native 注解修饰成员变量，则表示这个变量可以被本地代码引用，常常被代码生成工具使用

自定义注解

声明自定义注解使用 @interface 关键字（interface 关键字前加 @ 符号）实现。定义注解与定义接口非常像

// 定义一个简单的注解类型
public @interface Test {
}

默认情况下，注解可以在程序的任何地方使用，通常用于修饰类、接口、方法和变量等

定义注解和定义类相似，注解前面的访问修饰符和类一样有两种，分别是公有访问权限（public）和默认访问权限（默认不写）。一个源程序文件中可以声明多个注解，但只能有一个是公有访问权限的注解。且源程序文件命名和公有访问权限的注解名一致

1. 不包含任何成员变量的注解称为标记注解
2. 元数据注解：包含成员变量的注解,可以在定义时定义默认值，也可在使用时赋值

public @interface MyTag {
    // 定义带两个成员变量的注解
    // 注解中的成员变量以方法的形式来定义
    String name();
    int age();
}