Java 注解学习

参考：

https://www.iteye.com/blog/josh-persistence-2226493

https://www.cnblogs.com/Z-Dey/p/12904429.html

《Java 核心技术 卷Ⅱ》--- 第八章注解部分

一、注解介绍

从 Java5 开始，引入了注解（Annontation）这一新特征。据书中描述，注解是那些插入到源代码中使用其他工具可以对其进行处理的标签。这些工具可以在源码层次上进行操作，或者可以处理编译器在其中放置了注解的类文件。

注解不会改变程序的编译方式，Java 编译器对于包含注解和不包含注解的代码会生成相同的虚拟机指令。

注解处理器（AbstractProcessor）的作用：注解处理器用来在编译时扫描和处理注解，是javac的一个工具。一般使用注解处理器在编译时生成新的java文件，新生成的java文件会在编译期同其它java文件一样被编译。（就是把标记了注解的类，变量等作为输入内容，经过注解处理器处理，生成想要生成的java代码）

更通俗的意思是为程序的元素（类、方法、成员变量）加上更直观更明了的说明，这些说明信息是与程序的业务逻辑无关，并且是供指定的工具或框架使用的。

注解像一种修饰符一样，可以应用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中。

二、原理

注解的生命周期：java源文件–>class文件–>内存中的字节码

Annotation其实是一种接口。通过Java的反射机制相关的API来访问Annotation信息。相关类（框架或工具中的类即使用注解的类）根据这些信息来决定如何使用该程序元素或改变它们的行为。

Annoation和程序代码的隔离性：Annotation是不会影响程序代码的执行，无论Annotation怎么变化，代码都始终如一地执行。（生成相同的虚拟机指令）

忽略性：Java语言解释器在工作时会忽略这些annotation，因此在JVM 中这些Annotation是“不起作用”的，只能通过配套的工具才能对这些Annontaion类型的信息进行访问和处理。

Annotation与interface的异同：

　　1）Annotation类型使用关键字@interface而不是interface。

　　这个关键字声明隐含了一个信息：它是继承了java.lang.annotation.Annotation接口，并非声明了一个interface。

　　2）Annotation类型、方法定义是独特的、受限制的。

　　Annotation 类型的方法必须声明为无参数、无异常抛出的。

​ 这些方法定义了Annotation的成员：方法名成为了成员名，而方法返回值成为了成员的类型。方法返回值类型必须为primitive类型、Class类型、枚举类型、annotation类型或者由前面类型之一作为元素的一维数组。方法的后面可以使用 default和一个默认数值来声明成员的默认值，null不能作为成员默认值，这与我们在非Annotation类型中定义方法有很大不同。

　　Annotation类型和它的方法不能使用Annotation类型的参数、成员不能是generic。只有返回值类型是Class的方法可以在Annotation类型中使用generic，因为此方法能够用类转换将各种类型转换为Class。

　　3）Annotation类型又与接口有着近似之处。

　　它们可以定义常量、静态成员类型（比如枚举类型定义）。Annotation类型也可以如接口一般被实现或者继承。

三、使用、自定义注解

使用注解：

注解的使用十分简单，只需要在类、方法或属性上使用 @注解名就行了。

class Person{
    public void wolk(){
        System.out.println("人走路");
    }
}
class Student extends Person{
    @Override//注解：重写标记
    public void wolk() {
        System.out.println("学生走路");
    }
}

@Override表示子类的方法是重写的父类的方法，在程序编译时期会检查该方法是否满足重写的要求。

Java的3个内置注解

• @Override 重写标记，表示子类方法是重写的父类方法
• @Deprecated 过时标记 表示该方法不推荐使用，有更好的替代方法
• @SuppressWarnings 压制警告 可以压制当前代码的警告

经常用的就是@Override这个注解了，其他的用的不多。

自定义注解：

Java内置的Override注解定义：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

其中使用了@interface声明了Override是一个注解，@Target注解表示@Override使用的位置，@Retention注解表示@Override的生命周期。
@Target、@Retention是元注解。
元注解：用来修饰注解的注解
Java中的元注解有四个：

• @Target
• @Retention
• @Documented
• @Inherited

1. @Target

@Target用来说明注解使用的位置，它有一个ElementType[]属性。ElementType是一个枚举类型。

public enum ElementType {
   
    TYPE, /**  Class, interface (including annotation type), or enum declaration 该注解可以用在类、接口（注解）或枚举上 */

    FIELD, /**Field declaration (includes enum constants) 该注解可以用在属性上（枚举属性） */

    METHOD,/**Method declaration 该注解可以用在方法上 */
 
    PARAMETER,/** Formal parameter declaration 该注解可以用在参数上*/
    
    CONSTRUCTOR,/** Constructor declaration  该注解可以用在构造器上*/

    LOCAL_VARIABLE,/** Local variable declaration 该注解可以用在局部变量上*/

    ANNOTATION_TYPE,/** Annotation type declaration 该注解可以用在注解类型上 */

    PACKAGE,/** Package declaration 该注解可以用在包上*/

    /**
     * Type parameter declaration
     * 该注解可以用在泛型上
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     * 该注解可以用在任意类型上
     * @since 1.8
     */
    TYPE_USE
}

2. @Retention

@Retention表示该注解的生命周期。@Retention有一个属性，属性是一个枚举类型。枚举了注解的三个生命周期。

public enum RetentionPolicy {
    
    SOURCE,//表示注解只保留在源码阶段，只在源码阶段起作用

    CLASS,//表示注解保留在.class文件中，在类加载时不会被加载，jvm不可获得注解信息。默认值

    RUNTIME//表示注解保留在.class文件中，在类加载时会被加载，jvm可以获得注解信息
}

3. @Documented
@Documented表示该注解在使用javadoc命令时，将该注解包含到Java文档中。

4. @Inherited
@Inherited表示被该注解修饰的类的子类会继承该注解。
如果一个类被@Inherited修饰，那它的子类如果没有被其他注解修饰，子类会继承父类的注解

注解的属性

注解的属性可以是以下类型：

• 8个基本数据类型（char、byte、short、int、long、float、double、boolean）
• String
• enum
• class
• annotation
• 也可以是上面几种类型的数据类型

定义了注解的属性后，在使用注解时需要给注解的属性赋值。也可以在定义属性时使用default设置默认值

@Target({ElementType.TYPE})
@interface MyAnno{
    String value() default "我的注解";
}