关于注解的一些理解

简介：归纳一下注解的相关知识以及使用。
参考文章及教程：
frank909的博客 和 尚学堂B站视频

什么是注解？

比较官方的解释如下：

Java 注解用于为 Java 代码提供元数据。
作为元数据，注解不直接影响你的代码执行，但也有一些类型的注解实际上可以用于这一目的。
Java 注解是从 Java5 开始添加到 Java 的。

这句话大概的意思就是，注解并不是程序本身，而是一种附带的东西。可以把注解简单理解为为程序贴标签，但和注释不同的是，注解不仅可以解释程序，还可以存储一些数据来丰富代码的内容。但不论我们为代码贴上怎样的标签，代码始终是那个代码，标签大部分时候，是给"第三方"看的。

需要注意的是:代码被注解的单位一般是包，类(或者接口，注解，枚举)，属性，方法等。

注解的定义

提到注解的时候，一般都会按照：基本注解——元注解——自定义注解的方式去介绍。但我感觉反过来介绍，会更加得自然一点，所以我们首先来介绍自定义注解。
首先，就和我们的class,interface一样，注解其实也是一个.java文件，也是一种数据类型。它的定义格式如下：

public @interface A {
}

相较于类和接口，注解里面只存放成员变量，并且成员变量是以方法的形式存在的，比如:

public @interface A {
    String a();
    int b();
}

也就说，虽然看起来像是成员方法，但我们用的时候，还是把它当作成员变量用。本例中，该注解就是有两个属性——String类型的a属性和int类型的b属性。

注解的使用

定义完注解，使用的方式也很简单，就是在想要注解的代码上，打上"@注解1号",然后设置相关的值，比如我们使用一下刚才的A类型注解：

public class Demo1 {
	@A(a="abc", b = 1)
    private int a;
}

这样，我们的属性a，就被打上了标签，并拥有了一些数据。需要注意的是，如果使用注解，必需把里面所有的属性，都赋上值，否则会报错。当然，如果你在定义的时候像下列代码一样赋予了初值，就可以不写：

public @interface A {
    String a() default "";
    int b() default -1;
}

如果，某个注解类型只定义了一个变量，在使用的时候，也可以把属性名省略，只写属性值。(但是这个变量的取名需要为value)

	@A("abc")
    private int a;

元注解

既然注解是给程序打标签，那么首先就要表明一下，它能注解的程序，是怎样的类型。比如，有点注解是给类(或者接口，注解，枚举)做解释的(贴标签的)，有些是给属性贴标签的，而有些是给方法贴标签的。比如下述代码中，

@A1
public class Demo1 {
	@A2
    private int a;
    @A3
    public void f();
}

A1类型的注解就是作用他于类，而A2和A3类型，就是分别作用于属性和方法。
那么，如何来规定我们自定义的注解，到底是作用于哪种类型呢？这就可以使用@Target注解。格式如下:

@Target(ElementType.TYPE_PARAMETER)
public @interface A {  
}

这里的@Target,就是元注解的一种，所谓的元注解，其实就是注解的注解。在Java中，常用的原驻节有以下几种:这里直接复制此篇文章中的相关内容:https://blog.csdn.net/briblue/article/details/73824058

@Target

Target 是目标的意思，@Target 指定了注解运用的地方。

你可以这样理解，当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。

类比到标签，原本标签是你想张贴到哪个地方就到哪个地方，但是因为 @Target 的存在，它张贴的地方就非常具体了，比如只能张贴到方法上、类上、方法参数上等等。@Target 有下面的取值

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

@Retention

Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。

它的取值如下：

RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。
我们可以这样的方式来加深理解，@Retention 去给一张标签解释的时候，它指定了这张标签张贴的时间。@Retention 相当于给一张标签上面盖了一张时间戳，时间戳指明了标签张贴的时间周期。

@Retention(RetentionPolicy.RUNTIME)
	public @interface TestAnnotation {
}

上面的代码中，我们指定 TestAnnotation 可以在程序运行周期被获取到，因此它的生命周期非常的长。

@Documented

顾名思义，这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

基本注解

所谓的基本注解，就是Java帮我们写好的一些自定义注解，常用的有：

@override

重写注解，如果方法被此注解修饰，那么如果直接或间接父类中都找不到此方法，就会报错

@Deprecated

这个元素是用来标记过时的元素，想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。被此注解标记的元素，会有一道中划线

@SuppressWarnings

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

注解的读取

如果我们仅仅是定义注解并附加到程序上，那注解几乎就只发挥了百分之一的功能。我们之所以写注解，最终的目标还是在于给别人读取并加工使用，而别的程序想要使用，最重要的步骤就是如何拿到某个代码上所注解的数据。接下来我们写一个读取注解的程序的小案例。这里我们先给定一个自定义注解和一个使用了该注解的类:
自定义的注解——MyAnnotation01

@Target({ElementType.FIELD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation01 {
    String name();
    int age();
}

使用MyAnnotation01注解的类——Student

@MyAnnotation01(name = "T", age = 88)
public class Student {
    @MyAnnotation01(name = "Tom", age = 19)
    Student student;
}

现在自定义一个解析类——Demo，来获取Student类中，类的注解数据以及student属性的注解数据。

public class Demo {
    public static void main(String[] args) throws Exception {
        Student student = new Student();
        //通过反射获得类对象
        Class clazz = student.getClass();
        //获得类的所有注解
        Annotation[] as = clazz.getAnnotations();
        //打印类的所有注解（类的所有注解只注解在类上的，并不是指该类包含的所有注解）
        for (Annotation a :
                as) {
            System.out.println(a);
        }
        //获得一个属性类型的对象
        Field student_field =  clazz.getDeclaredField("student");
        //获得该属性的某个注解
        MyAnnotation01 myAnnotation01 = student_field.getAnnotation(MyAnnotation01.class);
        //输出这个注解的属性值
        System.out.println(myAnnotation01.name() + "\t" + myAnnotation01.age());
    }
}