Java自定义Annotation注解

元注解

元注解的作用在于: 负责注解其它注解。

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

@Target

@Target 说明了Annotation 所修饰的对象的范围, 使用枚举类ElementType 来指定。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
public enum ElementType {
/** Class, interface (including annotation type), or enum declaration */
TYPE,

/** Field declaration (includes enum constants) */
FIELD,

/** Method declaration */
METHOD,

/** Formal parameter declaration */
PARAMETER,

/** Constructor declaration */
CONSTRUCTOR,

/** Local variable declaration */
LOCAL_VARIABLE,

/** Annotation type declaration */
ANNOTATION_TYPE,

/** Package declaration */
PACKAGE,

/**
* Type parameter declaration
*
* @since 1.8
*/
TYPE_PARAMETER,

/**
* Use of a type
*
* @since 1.8
*/
TYPE_USE
}

@Retention

@Retention : 用于描述注解的生命周期, 即被描述的注解在什么范围内有效。

取值范围有(在枚举类RetentionPolicy 中有说明):

  • SOURCE:在源文件中有效(即在源文件中保留)
  • CLASS:在class 文件中有效(即在CLASS 文件中保留)
  • RUNTIME:在运行时有效(即在运行时保留)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
public enum RetentionPolicy {
/**
* Annotations are to be discarded by the compiler.
*/
SOURCE,

/**
* Annotations are to be recorded in the class file by the compiler
* but need not be retained by the VM at run time. This is the default
* behavior.
*/
CLASS,

/**
* Annotations are to be recorded in the class file by the compiler and
* retained by the VM at run time, so they may be read reflectively.
*
* @see java.lang.reflect.AnnotatedElement
*/
RUNTIME
}

@Documented

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

@Inherited

@Inherited 是一个标记注解, 阐述了某个被标注的类型是被继承的,

参考文档

本文标题:Java自定义Annotation注解

文章作者:Enda Lin

发布时间:2019年07月10日 - 09:35

最后更新:2019年07月10日 - 11:38

原始链接:https://wt-git-repository.github.io/2019/07/10/Java自定义Annotation注解/

许可协议: 署名-非商业性使用-禁止演绎 4.0 国际 转载请保留原文链接及作者。