java注解Annotation

注释只会存在于源文件中，即不会从.java文件编译到.class文件中

而注解是一种可以“注释到代码执行期的一种注释机制”，又称为标注。

简介

Java 语言中的类、方法、变量、参数和包等都可以被标注。和注释不同，Java 标注可以通过反射获取标注内容。

在编译器生成类文件时，标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容 。

当然它也支持自定义 Java 标注。

主要用于编译格式检查、反射中解析、生成帮助文档、跟踪代码依赖等。

内置注解

@Override ： 重写

@Deprecated：废弃。示例：stop()

@SafeVarargs：忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告

@FunctionalInterface： 函数式接口，标识一个匿名函数或函数式接口

@Repeatable：标识某注解可以在同一个声明上使用多次

@SuppressWarnings：抑制编译时的警告信息。

1. @SuppressWarnings("unchecked") [^ 抑制单类型的警告]

2. @SuppressWarnings("unchecked","rawtypes") [^ 抑制多类型的警告]

3. @SuppressWarnings("all") [^ 抑制所有类型的警告]

参数列表：

元注解

作用于其他自定义注解的注解（帮助规范下文的自定义注解）

分类：

@Retention - 标识这个注解怎么保存，是只在代码中，还是编入 class 文件中，或者是在运行时可以通过反射访问。

@Documented - 标记这些注解是否包含在用户文档中 。

@Target - 标记这个注解应该是哪种 Java 成员（类/包/方法...）。

@Inherited - 标记这个注解是自动继承的

1. 子类会继承父类使用的注解中被@Inherited修饰的注解

2. 接口继承关系中，子接口不会继承父接口中的任何注解，不管父接口中使用的注解有没有被@Inherited修饰

3. 类实现接口时不会继承任何接口中定义的注解

自定义注解

注解架构：

在java中，自定义注解是接口的方式存在的，格式和定义接口的格式非常像：

@interface 自定义注解名{}

每 1 个 Annotation 对象，都会有唯一的 RetentionPolicy 属性（保存/作用域策略，对应元注解的@Retention），默认为RetentionPolicy.CLASS；

至于 ElementType 属性（对应元注解的@Target），则有1~n个(不写该属性默认可以应用与任何地方)。

而@Documented和@Inherited则可有可无。

ElementType(注解的用途类型)

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

package java.lang.annotation;
public enum ElementType {
    TYPE, /* 类、接口（包括注释类型）或枚举声明 */
    FIELD, /* 字段声明（包括枚举常量） */
    METHOD, /* 方法声明 */
    PARAMETER, /* 参数声明 */
    CONSTRUCTOR, /* 构造方法声明 */
    LOCAL_VARIABLE, /* 局部变量声明 */
    ANNOTATION_TYPE, /* 注释类型声明 */
    PACKAGE /* 包声明 */
}

RetentionPolicy （注解作用域策略）

a) 若 Annotation 的类型为 SOURCE，则意味着：Annotation 仅存在于编译器处理期间，编译器处理完之后，该 Annotation 就没用了。 例如，" @Override" 标志就是一个 Annotation。当它修饰一个方法的时候，就意味着该方法覆盖父类的方法；并且在编译期间会进行语法检查！编译器处理完后，"@Override" 就没有任何作用了。

b) 若 Annotation 的类型为 CLASS，则意味着：编译器将 Annotation 存储于类对应的 .class 文件中，它是 Annotation 的默认行为。

c) 若 Annotation 的类型为 RUNTIME，则意味着：编译器将 Annotation 存储于 class 文件中，并且可由JVM读入。

package java.lang.annotation;
public enum RetentionPolicy {
    SOURCE, /* Annotation信息仅存在于编译器处理期间，编译器处理完之后就没有该Annotation信息了 */
    CLASS, /* 编译器将Annotation存储于类对应的.class文件中。默认行为 */
    RUNTIME /* 编译器将Annotation存储于class文件中，并且可由JVM读入 */
}

注意事项

1. 定义的注解，自动继承了java.lang,annotation.Annotation接口

2. 注解中的每一个方法（主要在反射机制中应用，上文没有提到），实际是声明的注解配置参数

• 方法的名称就是配置参数的名称
• 方法的返回值类型，就是配置参数的类型。只能是：基本类型/Class/String/enum

3. 可以通过default来声明参数的默认值

4. 如果只有一个参数成员，一般参数名为value

5. 注解元素必须要有值，我们定义注解元素时，经常使用空字符串、0作为默认值。

案例：

@Documented
@Target(ElementType.TYPE,ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface MyAnnotation1 {
    参数类型 参数名() default 默认值;
}

(01) @interface

使用 @interface 定义注解时，意味着它实现了 java.lang.annotation.Annotation 接口，即该注解就是一个Annotation。

定义 Annotation 时，@interface 是必须的。

注意：它和我们通常的 implemented 实现接口的方法不同。Annotation 接口的实现细节都由编译器完成。通过 @interface 定义注解后，该注解不能继承其他的注解或接口。

(02) @Documented

类和方法的 Annotation 在缺省情况下是不出现在 javadoc 中的。如果使用 @Documented 修饰该Annotation，则表示它可以出现在 javadoc 中。

定义 Annotation 时，@Documented 可有可无；若没有定义，则 Annotation 不会出现在 javadoc中。

(03) @Target(ElementType.TYPE)

@Target(ElementType.TYPE) 的意思就是指定该 Annotation 的类型是 ElementType.TYPE。这就意味着，MyAnnotation1 是来修饰"类、接口（包括注释类型）或枚举声明"的注解。

定义 Annotation 时，@Target 可有可无。若有 @Target，则该 Annotation 只能用于它所指定的地方；若没有 @Target，则该 Annotation 可以用于任何地方。

(04) @Retention(RetentionPolicy.RUNTIME)

@Retention(RetentionPolicy.RUNTIME) 的意思就是指定该 Annotation 的策略是RetentionPolicy.RUNTIME。这就意味着，编译器会将该 Annotation 信息保留在 .class 文件中，并且能被虚拟机读取。

定义 Annotation 时，@Retention 可有可无。若没有 @Retention，则默认是RetentionPolicy.CLASS。