Java语言高级特性——注解

一 注解作用或意义

• 定义
  Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。 注解是元数据的一种形式，提供有关于程序但不属于程序本身的数据。注解对它们注解的代码的操作没有直接影响。
• 意义
  注解本身没有任何意义，单独的注解就是一种注释，他需要结合其他如反射、插桩等技术才有意义。
  
  

  注解01.png

二 注解声明

• 声明一个注解类型
  Java中所有的注解，默认实现Annotation 接口：

public interface Annotation {
    boolean equals(Object var1);

    int hashCode();

    String toString();

    Class annotationType();
}

与声明一个"Class"不同的是，注解的声明使用@interface 关键字。一个注解的声明如下：

public @interface Lance {

}

三 元注解

在定义注解时，注解类也能够使用其他的注解声明。对注解类型进行注解的注解类，我们称之为 metaannotation（元注解）
一般的，我们在定义自定义注解时，需要指定的元注解有两个 ：

另外还有@Documented 与 @Inherited 元注解，前者用于被javadoc工具提取成文档，后者表示允许子类
继承父类中定义的注解。

1. @Target
注解标记另一个注解，以限制可以应用注解的 Java 元素类型。目标注解指定以下元素类型之一作为其值：

• ElementType.ANNOTATION_TYPE 可以应用于注解类型。
• ElementType.CONSTRUCTOR 可以应用于构造函数。
• ElementType.FIELD 可以应用于字段或属性。
• ElementType.LOCAL_VARIABLE 可以应用于局部变量。
• ElementType.METHOD 可以应用于方法级注解。
• ElementType.PACKAGE 可以应用于包声明。
• ElementType.PARAMETER 可以应用于方法的参数。
• ElementType.TYPE 可以应用于类的任何元素。

2. @Retenton
注解指定标记注解的存储方式：

• RetentionPolicy.SOURCE - 标记的注解仅保留在源级别中，并被编译器忽略。
• RetentionPolicy.CLASS - 标记的注解在编译时由编译器保留，但 Java 虚拟机(JVM)会忽略。
• RetentionPolicy.RUNTIME - 标记的注解由 JVM 保留，因此运行时环境可以使用它。

@Retention 三个值中 SOURCE < CLASS < RUNTIME，即CLASS包含了SOURCE，RUNTIME包含SOURCE、
CLASS。下文会介绍他们不同的应用场景。

下面来看例子：

//@Target(ElementType.TYPE) 只能在类上标记该注解
@Target({ElementType.TYPE,ElementType.FIELD}) // 允许在类与类属性上标记该注解
@Retention(RetentionPolicy.SOURCE) //注解保留在源码中
public @interface Lance {
}

四 注解类型元素

在上文元注解中，允许在使用注解时传递参数。我们也能让自定义注解的主体包含 annotation type element (注解
类型元素) 声明，它们看起来很像方法，可以定义可选的默认值。

public @interface Lance {
    String value(); //无默认值
    int age() default 1; //有默认值
}

注意：在使用注解时，如果定义的注解中的类型元素无默认值，则必须进行传值。

@Lance("技术好") //如果只存在value元素需要传值的情况，则可以省略:元素名=
@Lance(value="技术好",age = 2)
int i;

五 注解的保留级别以及应用场景

注解保留级别.png

注解的应用场景.png

SOURCE

1. IDE语法检查
在Android开发中， support-annotations 与androidx.annotation) 中均有提供@IntDef 注解，此注解的定义如
下：

@Retention(SOURCE) //源码级别注解
@Target({ANNOTATION_TYPE})
public @interface IntDef {
int[] value() default {};
boolean flag() default false;
boolean open() default false;
}

• 首先看看枚举方法如何语法检查的

public enum Week {
    MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY
}
 //枚举方法
    public static void testEnum(Week week){
        String str = "";
        switch (week) {
            case MONDAY:
                str = ">今天星期一";
                break;
            case TUESDAY:
                str = ">今天星期二";
                break;
            case WEDNESDAY:
                str = "今天星期三";
                break;
            case THURSDAY:
                str = ">今天星期四";
                break;
            case FRIDAY:
                str = ">今天星期五";
                break;
            case SATURDAY:
                str = ">今天星期六";
                break;
            case SUNDAY:
                str = ">今天周末";
                break;
        }
        System.out.print(str);
    }

Java中Enum(枚举)的实质是特殊单例的静态成员变量，在运行期所有枚举类作为单例，全部加载到内存中。比常量多5到10倍的内存占用。

• 而现在为了进行内存优化，我们现在不再使用枚举，则方法定义为：

    public static final int MONDAY = 0;
    public static final int TUESDAY = 1;
    public static final int WEDNESDAY = 2;
    public static final int THURSDAY = 3;
    public static final int FRIDAY = 4;
    public static final int SATURDAY = 5;
    public static final int SUNDAY = 6;
    //改为
    public static void testEnum(int week){
            case MONDAY:
                str = ">今天星期一";
                break;
            case TUESDAY:
                str = ">今天星期二";
                break;
            case WEDNESDAY:
            ........
    }

但是因为是基本类型 无法限制传递参数 可以传递0—6 之外任何值，所以这种方法是不行的

• 采用注解可以替代枚举 且可以达到代码检查 限制参数传递的效果

 public static final int MONDAY = 0;
    public static final int TUESDAY = 1;
    public static final int WEDNESDAY = 2;
    public static final int THURSDAY = 3;
    public static final int FRIDAY = 4;
    public static final int SATURDAY = 5;
    public static final int SUNDAY = 6;

 @IntDef(value = {MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY})//限定
    @Target({ElementType.PARAMETER})//作用于参数的注解
    @Retention(RetentionPolicy.SOURCE)//保留级别为源码
    public @interface week{

    }

public static void testAn(@week int week) {
        String str = "";
        switch (week) {
            case 0:
                str = "今天星期一";
                break;
            case 1:
                str = "今天星期二";
                break;
            case 2:
                str = "今天星期三";
                break;
            case 3:
                str = "今天星期四";
                break;
            case 4:
                str = "今天星期五";
                break;
            case 5:
                str = "今天星期六";
                break;
            case 6:
                str = "今天周末";
                break;
        }
        System.out.print(str);
    }

这里有个注意点：Add library 'Gradle: com.android.support:support-annotations:27.1.1@jar' to classpath
在编写Android程序时，我们经常使用 @NonNull，@UiThread,@IntegerRes等这些Android提供的注解：但是当你想在一个 Java Library中使用 support-annotations时，你却发现 gradle 一直弹出 :Add library 'Gradle: com.android.support:support-annotations:X.X.X@jar' to classpath 这个时候可以自己下载support-annotations 手动添加、或者使用SDK已下载好的 手动添加到lib路径下即可

2. APT注解处理器
APT全称为："Anotation Processor Tools"，意为注解处理器。顾名思义，其用于处理注解

CLASS

定义为CLASS 的注解，会保留在class文件中，但是会被虚拟机忽略(即无法在运行期反射获取注解)。此时完全符合
此种注解的应用场景为字节码操作。如：AspectJ、热修复Roubust中应用此场景。
所谓字节码操作即为，直接修改字节码Class文件以达到修改代码执行逻辑的目的。在程序中有多处需要进行是否
登录的判断。

RUNTIME

注解保留至运行期，意味着我们能够在运行期间结合反射技术获取注解中的所有信息。

代码