AI专业者开发社区 1 号成员
  •  0 回帖  •  3 浏览  •  5 个月前
 

Java 元注解

注解（Annontion）是 Java5 开始引入的新特征。它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。

1、元注解

      元注解的作用就是负责注解其他注解。Java5.0 定义了 4 个标准的 meta-annotation 类型，它们被用来提供对其它 annotation 类型作说明。Java5.0 定义的元注解有以下几种：

  • @Target
  • @Retention
  • @Documented
  • @Inherited

1.1 @Target

　　用于描述注解的范围，即注解在哪用。它说明了 Annotation 所修饰的对象范围：Annotation 可被用于 packages、types（类、接口、枚举、Annotation 类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch 参数）等。取值类型（ElementType）有以下几种：

  1. 　　CONSTRUCTOR: 用于描述构造器
  2. 　　FIELD: 用于描述域即类成员变量
  3. 　　LOCAL_VARIABLE: 用于描述局部变量
  4. 　　METHOD: 用于描述方法
  5. 　　PACKAGE: 用于描述包
  6. 　　PARAMETER: 用于描述参数
  7. 　　TYPE: 用于描述类、接口 (包括注解类型) 或 enum 声明
  8. 　　TYPE_PARAMETER:1.8 版本开始，描述类、接口或 enum 参数的声明
  9. 　　TYPE_USE:1.8 版本开始，描述一种类、接口或 enum 的使用声明

示例：

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

上述表示 Log 注解可以用在类、接口、enum 和方法上

1.2 @Retention

　　用于描述注解的生命周期，表示需要在什么级别保存该注解，即保留的时间长短。取值类型（RetentionPolicy）有以下几种：

  1. 　　SOURCE: 在源文件中有效（即源文件保留）
  2. 　　CLASS: 在 class 文件中有效（即 class 保留）
  3. 　　RUNTIME: 在运行时有效（即运行时保留）

示例：

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {　　......}

上述示例使用 RetentionPolicy.RUNTIME，这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理。

1.3 @Documented

　　用于描述其它类型的 annotation 应该被作为被标注的程序成员的公共 API，因此可以被例如 javadoc 此类的工具文档化。它是一个标记注解，没有成员。

示例：

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {　　......}

1.4 @Inherited

　　用于表示某个被标注的类型是被继承的。如果一个使用了 @Inherited 修饰的 annotation 类型被用于一个 class，则这个 annotation 将被用于该 class 的子类。