自定义注解

发表于 更新于

使用自定义注解时的一些元注解。

mate-annotation

元注解是提供给注解的注解。Java5.0定义了4个标准的 meta-annotation 类型，它们被用来提供对其它 annotation 类型作说明。Java5.0 定义的元注解：

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

@Target

@Target 说明了Annotation所修饰的对象范围： Annotation 可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在 Annotation 类型的声明中使用了 target 可更加明晰其修饰的目标。

取值定义在 ElementType 枚举中：

  • ElementType.CONSTRUCTOR: 用于描述构造器
  • ElementType.FIELD: 用于描述域
  • ElementType.LOCAL_VARIABLE: 用于描述局部变量
  • ElementType.METHOD: 用于描述方法
  • ElementType.PACKAGE: 用于描述包
  • ElementType.PARAMETER: 用于描述参数
  • ElementType.TYPE: 用于描述类、接口(包括注解类型) 或 enum 声明

@Retention

@Retention 定义了该 Annotation 被保留的时间长短：某些 Annotation 仅出现在源代码中，而被编译器丢弃；而另一些却被编译在 class 文件中；编译在 class 文件中的 Annotation 可能会被虚拟机忽略，而另一些在 class 被装载时将被读取（请注意并不影响 class 的执行，因为 Annotation 与 class 在使用上是被分离的）。使用这个 meta-Annotation 可以对 Annotation 的“生命周期”限制。

取值定义在 RetentionPoicy 枚举中：

  • RetentionPoicy.SOURCE: 在源文件中有效
  • RetentionPoicy.CLASS: 在class文件中有效
  • RetentionPoicy.RUNTIME: 在运行时有效

@Documented

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

@Inherited

@Inherited 元注解是一个标记注解，@Inherited表示了被标注的 annotation 是可以被继承的。如果一个使用了 @Inherited 修饰的 annotation 类型被用于一个 class，则这个 annotation 将被用于该 class 的子类。当使用反射获取该某个类的子类 annotation 时也会获取到父类存在有 @inherited 声明的 annotation 。