第9章-第3节-Java中的自定义注解

注解：有@Override,我们把它称为重写的注解。那么注解到底什么呢？我们能不能自定义注解。

1、概念：

注解是一种能被添加到java代码中的元数据，类、方法、变量、参数和包都可以用注解来修饰。注解对于它所修饰的代码并没有直接的影响。

* 注解是一种元数据形式。即注解是属于java的一种数据类型，和类、接口、数组、枚举类似。
* 注解用来修饰，类、方法、变量、参数、包。
* 注解不会对所修饰的代码产生直接的影响。

2、既然注解是一种数据类型，那我们自然可以去自定义的使用它

3、 自定义注解

简单来说自定义注解分为三步：

• 定义注解——相当于定义标记；

• 配置注解——把标记打在需要用到的程序代码中；

• 解析注解——在编译期或运行时检测到标记，并进行特殊操作。

4、基本语法：

注解在Java中，与类、接口、枚举类似，因此其声明语法基本一致，只是所使用的关键字有所不同@interface。

在底层实现上，所有定义的注解都会自动继承java.lang.annotation.Annotation接口。

public @interface TestAnnotation {
    
}

 根据我们在自定义类的经验，在类的实现部分无非就是书写构造、属性或方法。但是，在自定义注解中，其实现部分只能定义一个东西：注解类型元素（annotation type element）

/**
 * 自定义注解 @interface
 */
public @interface TestAnnotation {
    //定义注解类型元素
    public String name();
    int age() default 18;  //default代表带有默认值为18
    int[] array();
}

5、注解定义就只包括了上面的两部分内容：

• 1、注解的名字

• 2、注解包含的类型元素

6、定义注解类型元素时需要注意如下几点：

• 访问修饰符必须为public，不写默认为public；

• 该元素的类型只能是基本数据类型、String、Class、枚举类型、注解类型（体现了注解的嵌套效果）以及上述类型的一位数组；

• 该元素的名称一般定义为名词，如果注解中只有一个元素，请把名字起为value（后面使用会带来便利操作）；

• ()不是定义方法参数的地方，也不能在括号中定义任何参数，仅仅只是一个特殊的语法；

• default代表默认值，值必须和第2点定义的类型一致；

• 如果没有默认值，代表后续使用注解时必须给该类型元素赋值。

7、除了定义好注解，在哪用？怎么用？注意些什么？说这些之前，我们还需要补充一个概念：元注解

1）、@Target：是专门用来限定某个自定义注解能够被应用在哪些Java元素上面的

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

    /** 属性的声明 */
    FIELD,

    /** 方法的声明 */
    METHOD,

    /** 方法形式参数声明 */
    PARAMETER,

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

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

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

    /** 包的声明 */
    PACKAGE
}

//@CherryAnnotation被限定只能使用在类、接口或方法上面
@Target(value = {ElementType.TYPE,ElementType.METHOD})
public @interface TestAnnotation {
    String name();
    int age() default 18;
    int[] array();
}

2）、@Retention注解，翻译为持久力、保持力。即用来修饰自定义注解的生命力。 注解的生命周期有三个阶段：1、Java源文件阶段；2、编译到class文件阶段->默认；3、运行期阶段。

同样使用了RetentionPolicy枚举类型定义了三个阶段：

public enum RetentionPolicy {
    /**
     * Annotations are to be discarded by the compiler.
     * （注解将被编译器忽略掉）
     */
    SOURCE,

    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior.
     * （注解将被编译器记录在class文件中，但在运行时不会被虚拟机保留，这是一个默认的行为）
     */
    CLASS,

    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     * （注解将被编译器记录在class文件中，而且在运行时会被虚拟机保留，因此它们能通过反射被读取到）
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME
}

• 如果一个注解被定义为RetentionPolicy.SOURCE，则它将被限定在Java源文件中，那么这个注解即不会参与编译也不会在运行期起任何作用，这个注解就和一个注释是一样的效果，只能被阅读Java文件的人看到；

• 如果一个注解被定义为RetentionPolicy.CLASS，则它将被编译到Class文件中，那么编译器可以在编译时根据注解做一些处理动作，但是运行时JVM（Java虚拟机）会忽略它，我们在运行期也不能读取到；

• 如果一个注解被定义为RetentionPolicy.RUNTIME，那么这个注解可以在运行期的加载阶段被加载到Class对象中。那么在程序运行阶段，我们可以通过反射得到这个注解，并通过判断是否有这个注解或这个注解中属性的值，从而执行不同的程序代码段。我们实际开发中的自定义注解几乎都是使用的RetentionPolicy.RUNTIME；

• 在默认的情况下，自定义注解是使用的RetentionPolicy.CLASS。

3）、 @Documented，是被用来指定自定义注解是否能随着被定义的java文件生成到JavaDoc文档当中。

4）、@Inherited注解，是指定某个自定义注解如果写在了父类的声明部分，那么子类的声明部分也能自动拥有该注解。@Inherited注解只对那些@Target被定义 为ElementType.TYPE的自定义注解起作用。

说完了元注解，我们可以看到元注解其实就是用来配置我们的自定义注解，让自定义注解更加精确的使用

8、自定义注解补充

@Retention(RetentionPolicy.RUNTIME) //规定运行时
@Target(value = {ElementType.METHOD}) //规定在方法上使用
@Documented//JavaDoc文档当
public @interface CherryAnnotation {
    String name();
    int age() default 18;
    int[] score();
}

简单分析下：

• CherryAnnotation的@Target定义为ElementType.METHOD，那么它书写的位置应该在方法定义的上方

• 由于我们在CherryAnnotation中定义的有注解类型元素，而且有些元素是没有默认值的，这要求我们在使用的时候必须在标记名后面打上()，并且在()内以“元素名=元素值“的形式挨个填上所有没有默认值的注解类型元素（有默认值的也可以填上重新赋值），中间用“,”号分割；

9、使用注解

public class Student {
    @CherryAnnotation(name = "cherry-peng",age = 23,score = {99,66,77})
    public void study(int times){
        for(int i = 0; i < times; i++){
            System.out.println("Good Good Study, Day Day Up!");
        }
    }
}

10、特殊用法：

1）、如果注解本身没有注解类型元素，那么在使用注解的时候可以省略()，直接写为：@注解名，它和标准语法@注解名()等效！

@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.TYPE})
@Documented
public @interface FirstAnnotation {
}

//等效于@FirstAnnotation()
@FirstAnnotation
public class JavaBean{
	//省略实现部分
}

2）、如果注解本本身只有一个注解类型元素，而且命名为value，那么在使用注解的时候可以直接使用：@注解名(注解值)，其等效于：@注解名(value = 注解值)

@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.TYPE})
@Documented
public @interface SecondAnnotation {
	String value();
}

//等效于@ SecondAnnotation(value = "this is second annotation")
@SecondAnnotation("this is annotation")
public class JavaBean{
	//省略实现部分
}

3）、如果注解中的某个注解类型元素是一个数组类型，在使用时又出现只需要填入一个值的情况，那么在使用注解时可以直接写为：@注解名(类型名 = 类型值)，它和标准写法：@注解名(类型名 = {类型值})等效！

@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.TYPE})
@Documented
public @interface ThirdAnnotation {
	String[] name();
}

//等效于@ ThirdAnnotation(name = {"this is third annotation"})
@ ThirdAnnotation(name = "this is third annotation")
public class JavaBean{
	//省略实现部分
}

本电子书目录：《Java基础的重点知识点全集》