Java注解

Java注解（Annotation）

Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。
注解也叫元数据，一种代码级别的说明，说明程序的是给计算机看的，与类，接口，枚举是在同一个层次，通过@注解名称使用·
元注解：可以理解为注解上的注解，或者说元注解是一种基本注解，但是它可以应用到其他的注解上面。
元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

每1个Annotation对象，都会有唯一的RetentionPolicy属性。对于每 1 个 Annotation 对象，可以有若干个 ElementType 属性。Annotation 有许多实现类，包括：Deprecated, Documented, Inherited, Override 等等。
Annotation 的每一个实现类，都 “和 1 个 RetentionPolicy 关联” 并且 " 和 1~n 个 ElementType 关联"。
Annotation.java

package java.lang.annotation;
public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}
1
2
3
4
5
6
7
8
9
10
11

ElementType.java

package java.lang.annotation;

public enum ElementType {
    TYPE,               /* 类、接口（包括注释类型）或枚举声明  */

    FIELD,              /* 字段声明（包括枚举常量）  */

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

    CONSTRUCTOR,        /* 构造方法声明  */

    LOCAL_VARIABLE,     /* 局部变量声明  */

    ANNOTATION_TYPE,    /* 注释类型声明  */

    PACKAGE             /* 包声明  */
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

RetentionPolicy.java

package java.lang.annotation;
public enum RetentionPolicy {
    SOURCE,            /* Annotation信息仅存在于编译器处理期间，编译器处理完之后就没有该Annotation信息了  */

    CLASS,             /* 编译器将Annotation存储于类对应的.class文件中。默认行为  */

    RUNTIME            /* 编译器将Annotation存储于class文件中，并且可由JVM读入 */
}
1
2
3
4
5
6
7
8

(1) Annotation 就是个接口。

“每 1 个 Annotation” 都与 “1 个 RetentionPolicy” 关联，并且与 “1～n 个 ElementType” 关联。可以通俗的理解为：每 1 个 Annotation 对象，都会有唯一的 RetentionPolicy 属性；至于 ElementType 属性，则有 1~n 个。

(2) ElementType 是 Enum 枚举类型，它用来指定 Annotation 的类型。

“每 1 个 Annotation” 都与 “1～n 个 ElementType” 关联。当 Annotation 与某个 ElementType 关联时，就意味着：Annotation有了某种用途。例如，若一个 Annotation 对象是 METHOD 类型，则该 Annotation 只能用来修饰方法。

(3) RetentionPolicy 是 Enum 枚举类型，它用来指定 Annotation 的策略。通俗点说，就是不同 RetentionPolicy 类型的 Annotation 的作用域不同。

“每 1 个 Annotation” 都与 “1 个 RetentionPolicy” 关联。

（1）若 Annotation 的类型为 SOURCE，则意味着：Annotation 仅存在于编译器处理期间，编译器处理完之后，该 Annotation 就没用了。 例如，" @Override" 标志就是一个 Annotation。当它修饰一个方法的时候，就意味着该方法覆盖父类的方法；并且在编译期间会进行语法检查！编译器处理完后，“@Override” 就没有任何作用了。
（2） 若 Annotation 的类型为 CLASS，则意味着：编译器将 Annotation 存储于类对应的 .class 文件中，它是 Annotation 的默认行为。
（3） 若 Annotation 的类型为 RUNTIME，则意味着：编译器将 Annotation 存储于 class 文件中，并且可由JVM读入。

注解和注释的区别
注解：说明程序的，给计算机看的
注释：用文字描述程序的，给程序员看的

作用分类：
编写文档：通过代码里标识的注解生成文档（生成文档doc文档）
代码分析：通过代码里标识的注解对代码进行分析（使用反射）
编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查（Override）

Java定义了一套注解，共有七个，三个在java.lang 中，@Override @Deprecated @SuppressWarnings 剩下 4 个在 java.lang.annotation中。
@Retention @Documented @Target @Inherited
在Java 7 开始，额外添加了三个注解,前两个也在java.lang中 最后一个在java.lang.annotation中：
@SafeVarargs @FunctionalInterface @Repeatable

Java.lang中的注解也叫Java预置的注解
@Deprecated
这个元素是用来标记过时的元素，编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。

@Override
提示子类要复写父类中被 @Override 修饰的方法

@SuppressWarnings
阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后，编译器会警告提醒，而有时候开发者会忽略这种警告，他们可以在调用的地方通过 @SuppressWarnings 达到目的。

@SafeVarargs
参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。

@FunctionalInterface
函数式接口注解，这个是 Java 1.8 版本引入的新特性。函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。

元注解
@Retention
当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。@Retention 去给一张标签解释的时候，它指定了这张标签张贴的时间。@Retention 相当于给一张标签上面盖了一张时间戳，时间戳指明了标签张贴的时间周期。

RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。
1
2
3

@Documented
它的作用是能够将注解中的元素包含到 Javadoc 中去。

@Target
target 指定了注解运用的地方。当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。

ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
ElementType.CONSTRUCTOR 可以给构造方法进行注解
ElementType.FIELD 可以给属性进行注解
ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
ElementType.METHOD 可以给方法进行注解
ElementType.PACKAGE 可以给一个包进行注解
ElementType.PARAMETER 可以给一个方法内的参数进行注解
ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举
1
2
3
4
5
6
7
8

@Inherited
继承，@Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。

@Repeatable
@Repeatable 是 Java 1.8 才加进来的，所以算是一个新的特性。可重复，就是一个可以有多个身份

注解的提取（重点）
注解通过反射获取，首先可以通过Class对象的isAnnotationPresent()方法判断他是否应用了某个注解

public boolean isAnnotationPresent(Class annotationClass) {}
1

然后通过 getAnnotation() 方法来获取 Annotation 对象。返回指定类型的注解

public  A getAnnotation(Class annotationClass) {}
1

public Annotation[] getAnnotations() {}
1

@TestAnnotation()
public class Test {
    public static void main(String[] args) {
        boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
        if ( hasAnnotation ) {
            TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
            System.out.println("id:"+testAnnotation.id());
            System.out.println("msg:"+testAnnotation.msg());
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11

 id: -1 msg:
1

提供信息给编译器： 编译器可以利用注解来探测错误和警告信息
编译阶段时的处理： 软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。
运行时的处理： 某些注解可以在程序运行的时候接受代码的提取
值得注意的是，注解不是代码本身的一部分。
1
2
3
4