Java自定义注解

一、什么是注解

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

简单地说，就是一种标记，可以在程序代码中的关键节点（类、方法、变量、参数、包）上打上这些标记，然后程序在编译时或运行时可以根据这些标记执行一些特殊操作。例如我们常用的@Component就是用于标识一个bean组件用于启动时初始化bean的。

二、自定义注解

package com.offer.interview.annotation;


import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(value = {ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface CustomAnnotationType {
    String value() default "value 的默认值";
    String[] values() default {};
}

注解声明

如上，注解使用的关键字是@interface，所有定义的注解都会自动继承于java.lang.annotation.Annotation接口。

定义注解类型元素

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

1. 访问修饰符必须为public，不写默认为public；
2. 该元素的类型只能是基本数据类型、String、Class、枚举类型、注解类型（体现了注解的嵌套效果）以及上述类型的一维数组；
3. 该元素的名称一般定义为名词，如果注解中只有一个元素，请把名字起为value（后面使用会带来便利操作）；
4. ()不是定义方法参数的地方，也不能在括号中定义任何参数，仅仅只是一个特殊的语法；
5. default代表默认值，值必须和第2点定义的类型一致；
6. 如果没有默认值，代表后续使用注解时必须给该类型元素赋值。

添加元注解

元注解就是专门修饰注解的注解。常用的元注解有：

1.@Target：用来限定某个自定义注解能够被应用在哪些Java元素上面。它的可选值是枚举类来定义的。如下：

一般会用到TYPE和METHOD，作用于类上或者方法上。

public enum ElementType {
    /** 类，接口（包括注解类型）或枚举的声明 */
    TYPE,
    /** 属性的声明 */
    FIELD,
    /** 方法的声明 */
    METHOD,
    /** 方法形式参数声明 */
    PARAMETER,
    /** 构造方法的声明 */
    CONSTRUCTOR,
    /** 局部变量声明 */
    LOCAL_VARIABLE,
    /** 注解类型声明 */
    ANNOTATION_TYPE,
    /** 包的声明 */
    PACKAGE
}

2.@Retention：用来修饰自定义注解的作用域。可选值是在RetentionPolicy 枚举类中定义的。

有三个值，一般我们都是定义为RetentionPolicy.RUNTIME，即在运行时可以获取注解解析使用。

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
}

 3.@Inherited：指定某个自定义注解如果写在了父类的声明部分，那么子类的声明部分也能自动拥有该注解。因此这个注解只有在@Target被定义为ElementType.TYPE的自定义注解中起作用。

三、使用注解

1.如果注解本身没有注解类型元素，那么在使用注解的时候可以省略()，直接写为：@注解名。

@CustomAnnotationType

或者

@CustomAnnotationType()

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

@CustomAnnotationType(value = "注解的值")

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

@CustomAnnotationType(values = {"数组值1"})

或者

@CustomAnnotationType(values = "数组值1")

4.如果一个注解的@Target是定义为Element.PACKAGE，那么这个注解是配置在package-info.java中的，而不能直接在某个类的package代码上面配置