Java注解使用

注解基本使用

注解简单介绍

Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation,程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。

自定义注解

使用自定义注解的一般情况是通过反射获取自定义注解的信息。

• 定义新的 Annotation 类型使用 @interface 关键字。
• 自定义注解自动继承了java.lang.annotation.Annotation接口。
• Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其
  方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能
  是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、
  和以上所有类型的数组。

public @interface MyAnnotation {
    // value就是变量的名字，String是变量的类型
    String value();
}

数组情况是这样：

public @interface MyAnnotation {
    // 如果变量类型是数组就可以赋多个值
    String [] value();
}
---------------------------------------------------
@MyAnnotation({"hi","hello"})
public class AnnotationTest   {
    @Override
    public String toString() {
        return super.toString();
    }
}

• 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始
  值可使用 default 关键字

public @interface MyAnnotation {
    // value就是变量的名字，String是变量的类型
    String value() default "hello";
}

• 如果只有一个参数成员，建议使用参数名为value
• 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认
  值。格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value，
  可以省略“value=”

@MyAnnotation(value = "hi")
public class AnnotationTest {
}

和

@MyAnnotation("hi")
public class AnnotationTest {
}

效果一样

• 如果自定义注解没有成员，表明是一个标识作用。

JDK元注解

元注解：就是修饰注解的注解。
JDK5.0提供了4个标准的meta-annotation类型，分别是：

• @Retention
  只能用于修饰 Annotation 定义,作用是定义被它所注解的注解保留多久 用于指定该 Annotation 的生命周期@Rentention 包含一个 RetentionPolicy 类型的成员变量, RetentionPolicy是一个枚举类，使用@Rentention 时必须为该 value 成员变量指定值:

1. RetentionPolicy.SOURCE: 在源文件中有效（即源文件保留），编注解只保留在源文件，当Java文件编译成class文件的时候，注解被遗弃。
2. RetentionPolicy.CLASS: 在class文件中有效（即class保留） ， 当运行 Java 程序时, JVM 不会保留注解。 这是默认值。
3. RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。

那怎么来选择合适的注解生命周期呢？

首先要明确生命周期长度 SOURCE < CLASS < RUNTIME ，所以前者能作用的地方后者一定也能作用。一般如果需要在运行时去动态获取注解信息，那只能用 RUNTIME 注解；如果要在编译时进行一些预处理操作，比如生成一些辅助代码（如 ButterKnife），就用 CLASS注解；如果只是做一些检查性的操作，比如 @Override 和 @SuppressWarnings，则可选用 SOURCE 注解。

• @Target
  用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。
• @Documented
  用于指定被该元 Annotation 修饰的 Annotation 类将被
  javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。 定义为Documented的注解必须设置Retention值为RUNTIME。
• @Inherited
  被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。

Java 8 注解新特性

• 可重复注解

Java 8之前可重复注解使用演示：

public @interface MyAnnotation {
    String value();
}
-----------------------------------------------------------------------
@MyAnnotations({@MyAnnotation(value="hi"),@MyAnnotation(value="hi")})
public @interface MyAnnotations {
    MyAnnotation [] value();
}

Java 8之后可使用 @Repeatable注解

@Repeatable(MyAnnotations.class)
public @interface MyAnnotation {
    String value();
}
--------------------------------------------
@MyAnnotation("hi")
@MyAnnotation("hello")
public @interface MyAnnotations {
    MyAnnotation [] value();
}

• 可用于类型的注解
  ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明）。
  ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {

    String value() default "hello";
}
-----------------------------------------------------------------------------
class Generic<@MyAnnotation T>{
    public void show() throws @MyAnnotation RuntimeException{
        ArrayList<@MyAnnotation String> list = new ArrayList<>();
        int num = (@MyAnnotation int) 10L;
    }
}