Java 注解@Annotation 与 自定义注解

1.注解的由来

在引入注解之前，在不同类型的应用程序使用XML作为标准的代码配置机制,程序员们描述其代码的形式尚未标准化，每个人的做法各异：transient关键字、注释、接口等,代码和XML的解耦以及未来对这种解耦应用的维护并不低廉,这显然不是一种优雅的方式,随之而来的JDK5.0引入一种崭新的记录元数据的形式——注解被引入到Java中。 它的作用是修饰编程元素。什么是编程元素呢？例如：包、类、构造方法、方法、成员变量等。

2.什么是注解

DK5.0中的类型：1、类（class）2、接口（interface）3、枚举（enum）4、注解（Annotation） 因此，注解与其他3种类型一样，都可以定义、使用，以及包含有自己的属性、方法

注解分类 ：

• 标记注释：注解的内部没有属性，称作标记注解 使用方法：@注解名 使用例子：@MarkAnnotation。
• 单值注解：注解的内部只有一个属性，称作单值注解 使用方法：@注解名(属性名=属性值) 使用例子：@SingleAnnotation(value="abc") //也可以写成@SingleAnnotation("abc") *(属性名=属性值)可以简化为(属性值)，但是需要满足以下两个条件： 1、该注解必须为单值注解 2、该注解的属性名必须为value。
• 多值注解：注解的内部有多个属性，称作多值注解 使用方法：@注解名(属性名1=属性值1, 属性名2=属性值2……) 使用例子：@MultipliedAnnotation(value1 = "abc", value2 = 30……)。

元注解 

Java提供了一下几个元注解：Target、Retention、Documented和Inherited。

元注解的作用：

可以用于注解类（annotate Classes）、注解接口(annotate Interfaces)、注解枚举类型(annotate Enums) 也可以用于注解注解（annotate Annotations）。

3.注解语法

java Annotation 的组成中，有 3 个非常重要的主干类。它们分别是：

java.lang.annotation.Annotation ：

public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}
           

java.lang.annotation.ElementType ：

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

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

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

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

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

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

    PACKAGE             /* 包声明  */
}
           

java.lang.annotation.RetentionPolicy ： 

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

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

    RUNTIME            /* 编译器将Annotation存储于class文件中，并且可由JVM读入 */
}
           

各自作用：

• Annotation就是一个接口，"每 1 个 Annotation" 都与 "1 个 RetentionPolicy" 关联，并且与 "1～n 个 ElementType" 关联。可以通俗的理解为：每 1 个 Annotation 对象，都会有唯一的 RetentionPolicy 属性；至于 ElementType 属性，则有 1~n 个。
• ElementType是Enum枚举类型，用来指定Annotation的作用范围。当 Annotation 与某个 ElementType 关联时，就意味着：Annotation有了某种作用范围。例如，若一个 Annotation 对象是 METHOD 类型，则该 Annotation 能用来修饰方法。

• 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读入。

4.内置注解

Java 5 定义了一套注解，共有 7 个，3 个在 java.lang 中，剩下 4 个在 java.lang.annotation 中。

作用在代码的注解是：

• @Override - 检查该方法是否是重载方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。
• @Deprecated - 标记过时方法。在源程序中加入这个标记后，并不影响程序的编译，但编译器会显示一些警告信息。
• @SuppressWarnings - 用于有选择的关闭编译器对类、方法、成员变量、变量初始化的警告：

  deprecation：使用了不赞成使用的类或方法时的警告；
  unchecked：执行了未检查的转换时的警告，例如当使用集合时没有用泛型 (Generics) 来指定集合保存的类型; 
  fallthrough：当 Switch 程序块直接通往下一种情况而没有 Break 时的警告;
  path：在类路径、源文件路径等中有不存在的路径时的警告; 
  serial：当在可序列化的类上缺少 serialVersionUID 定义时的警告; 
  finally：任何 finally 子句不能正常完成时的警告; 
  all：关于以上所有情况的警告。
             

作用在其他注解的注解(或者说 元注解)是:

• @Retention - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问。
• @Documented - 标记这些注解是否包含在用户文档中。
• @Target - 标记这个注解应该是哪种 Java 成员。
• @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

从 Java 7 开始，额外添加了 3 个注解:

• @SafeVarargs - Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
• @FunctionalInterface - Java 8 开始支持，标识一个匿名函数或函数式接口。
• @Repeatable - Java 8 开始支持，标识某注解可以在同一个声明上使用多次。

5.自定义注解

用一个例子来说明：

@Documented
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface PerformanceLog {
    String value() default "";
}
           

说明：

上面的作用是定义一个 Annotation，它的名字是 PerformanceLog。定义了 PerformanceLog 之后，我们可以在代码中通过 "@PerformanceLog" 来使用它。 其它的，@Documented, @Target, @Retention, @interface 都是来修饰 PerformanceLog 的。下面分别说说它们的含义：

• @interface：

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

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

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

• @Documented：

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

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

• @Target(ElementType.TYPE)

  前面我们说过，ElementType 是 Annotation 的类型属性。而 @Target 的作用，就是来指定 Annotation 的类型属性。

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

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

• @Retention(RetentionPolicy.RUNTIME)

  前面我们说过，RetentionPolicy 是 Annotation 的策略属性，而 @Retention 的作用，就是指定 Annotation 的策略属性。@Retention(RetentionPolicy.RUNTIME) 的意思就是指定该 Annotation 的策略是 RetentionPolicy.RUNTIME。这就意味着，编译器会将该 Annotation 信息保留在 .class 文件中，并且能被虚拟机读取。定义 Annotation 时，@Retention 可有可无。若没有 @Retention，则默认是 RetentionPolicy.CLASS。