java注解

注解是什么

注解可以类比于生活中的标签，可以准确表示事物的特性。在java和class，interface一样也是一种类型。

注解的定义

public @interface Code {
}

上面的代码创建一个名为code的注解，显而易见，与接口相比就多了个@符号，也就是可以理解为我们创建了一个名为code的标签。

注解的应用

@Code
public class Test {

}

上面的代码是为Test的类添加了一个名为Code的注解，也就是为这个类打上一个名为Code的标签。

元注解

元注解即可以注解到其他注解上的注解。可以简单的理解为最基本标签（注解），即可以为其他普通标签（注解）起解释说明的标签（注解）。

元注解包括以下@Retention、@Documented、@Target、@Inherited、@Repeatable 5种。

@Retention

@Retention意为保留期，当它用在一个注解上时即表示这个注解的保留时间。

取值如下：

RetentionPolicy.SOURCE注解在源码阶段保留，在编译时被丢弃。

RetentionPolicy.CLASS 注解只被保留到编译进行时，不会被加载到JVM中。

RetentionPolicy.RUNTIME注解会被保留到到程序运行时，会被加载到JVM，在程序运行时可以通过反射获取。

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

像上面的代码，我们可以理解为给这个注解加上了存活时间的时间戳。

@Documented

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

@Target

@Target指定注解运用到什么地方， 当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。

@Target 有下面的取值：

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

@Inherited

Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类被 @Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。 

@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface Code {
}

@Code
public class A {
}
public class B extends A {
}





注解code被@Inherited 注解，A被code注解，B就就继承code这个注解。

@Repeatable

Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的，所以算是一个新的特性。

什

@SafeVarargs

么样的注解会多次应用呢？通常是注解的值可以同时取多个。

举个例子，一个人他既是程序员又是产品经理,同时他还是个画家。

@interface Persons {
    Person[]  value();
}


@Repeatable(Persons.class)
@interface Person{
    String role default "";
}


@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{

}

注意上面的代码，@Repeatable 注解了 Person。而 @Repeatable 后面括号中的类相当于一个容器注解。

什么是容器注解呢？就是用来存放其它注解的地方。它本身也是一个注解。

如果不好理解的话，可以这样理解。Persons 是一张总的标签，上面贴满了 Person 这种同类型但内容不一样的标签。把 Persons 给一个 SuperMan 贴上，相当于同时给他贴了程序员、产品经理、画家的标签。

注解的属性

注解的属性也叫做成员变量。注解只有成员变量，没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。

@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Target(ElementType.TYPE)
public @interface Code {
    int id();
    String msg();
}

上面代码定义了 Code 这个注解中拥有 id 和 msg 两个属性。在使用的时候，我们应该给它们进行赋值。

@Code(id=0,msg="成功!")
public class Test {

}

需要注意的是，在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组。

注解中属性可以有默认值，默认值需要用 default 关键值指定。比如：

@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Target(ElementType.TYPE)
public @interface Code {
    int id() default 1;
    String msg() default "失败";
}

java预置的注解

@Deprecated

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

@Override

这个大家应该很熟悉了，提示子类要复写父类中被 @Override 修饰的方法。

@SuppressWarnings

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

@FunctionalInterface

函数式接口注解，这个是 Java 1.8 版本引入的新特性。函数式编程很火，所以 Java 8 也及时添加了这个特性。

函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。

注解和反射

注解通过反射获取的步骤：

1、 首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解。

2、然后通过 getAnnotation() 方法来获取 Annotation 对象。或者是 getAnnotations() 方法。

前一种方法返回指定类型的注解，后一种方法返回注解到这个元素上的所有注解。

如果获取到的 Annotation 如果不为 null，则就可以调用它们的属性方法了。

@Code(id=0,msg="成功!")
public class Test {

    public static void main(String[] args) {
        boolean flag=Test.class.isAnnotationPresent(Code.class);
        if(flag){
            Code code=Test.class.getAnnotation(Code.class);
            System.out.println(code.id());
            System.out.println(code.msg());
        }
    }
}

程序运行结果：

0
成功!