Java基础——注解

概述

注解相当于一种标签，在程序中加了注解就等于为程序打上了某种标签，javac编译器，开发工具和其他程序可以用反射来了解你的类及各种元素上有无何种标签，看你有什么标记，就去干相应的事。标签可以加在包，类，字段，方法，方法的参数以及局部变量上。

定义

通过 @interface关键字进行定义。

@interface CusAnnotation{
}

注解定义跟接口非常相似，注解前面多了一个 @ 符号。上面的代码就创建了一个名字为 CusAnnotation 的注解。
可以理解为创建了一张名字为 CusAnnotation 的标签

作用

1 作为特殊的标记，用于告诉编译器一些信息
2 编译时动态处理，如动态生成代码
3 运行时动态处理，作为额外信息的载体，如获取注解信息
创建一个类 CustomAnnotation,然后在类定义的地方加上 @CusAnnotation 就可以用 CusAnnotation 注解这个类了。可以简单理解为将 CusAnnotation 这张标签贴到 CustomAnnotation 这个类上面。

@CusAnnotation
public class CustomAnnotation {
}

本质

The common interface extended by all annotation types所有的注解类型都继承自这个普通的接口（Annotation）

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

注解 @Override 的定义，其实它本质上就是：一个继承了 Annotation 接口的接口。

public interface Override extends Annotation{
}

内置注解/标准注解

@Override

子类覆盖父类方法或者实现接口的方法

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

它没有任何的属性，所以并不能存储任何其他信息。它只能作用于方法之上，编译结束后将被丢弃。
所以你看，它就是一种典型的『标记式注解』，仅被编译器可知，编译器在对 java 文件进行编译成字节码的过程中，一旦检测到某个方法上被修饰了该注解，就会去匹对父类中是否具有一个同样方法签名的函数，如果不是，自然不能通过编译。

public class User {
    private String name;
    private int age;
    public User(String n,int a){
        this.name = n;
        this.age = a;
    }
    @Override
    public String toString() {
        return "current user name:"+this.name+" age:"+this.age;
    }
}
public static void main(String[] args) {
       User user = new User("tom",20);
       System.out.println(user);
    }

@Deprecated

表示API已经过时

@Deprecated
    public User(String n,int a){
        this.name = n;
        this.age = a;
    }

@SuppressWarnings

如果我们不希望程序启动时，编译器检查代码中过时的方法，就可以使用 @SuppressWarnings 注解并给它的 value 属性传入一个参数值来压制编译器的检查。

@SuppressWarnings("deprecation")
    public static void main(String[] args) {
       User user = new User("tom",20);
       System.out.println(user);
    }

自定义注解

元注解

是用于标示注解的注解，元注解可以理解为一种特殊的标签，它的作用和目的就是给其他普通的注解进行解释说明的。JAVA 中有以下『元注解』，应用最多的是Target和Retention

@Target

字面解释指的是作用目标，大白话就是指该注解可以用于什么地方，是用来修饰方法？类？还是用来修饰字段属性的。ElementType 参数有：

Target.java源文件

@Documented 
@Retention(RetentionPolicy.RUNTIME)  
@Target(ElementType.ANNOTATION_TYPE)  
public @interface Target {  
   ElementType[] value();  
}

@Retention

英文意为保留期的意思，类似于标签的时间戳，表示该注解信息时间范围。可选的RetentionPolicy参数包括：

Retention源文件

@Documented 
@Retention(RetentionPolicy.RUNTIME)  
@Target(ElementType.ANNOTATION_TYPE)  
public @interface Retention {  
   RetentionPolicy value();  
}

@Override里面的Retention设为SOURCE,编译成功了就不要这一些检查的信息;相反,@Deprecated里面的Retention设为RUNTIME,表示除了在编译时会警告我们使用了哪个被Deprecated的方法,在执行的时候也可以查出该方法是否被Deprecated.

@Inherited

是否允许子类继承该注解，如果一个父类被标记为 @Inherited 注解进行注解的话，如果它的子类没有被任何注解应用的话，那么这个子类就继承了父类的注解。

import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Foo {}
@Foo
class SuperBar {
}
public class Bar extends SuperBar {
}

注解 Foo 被 @Inherited 修饰，类 SuperBar 被 Foo 注解，类 Bar 继承 SuperBar,类 Bar 也拥有 Foo 这个注解。

@Documented

是否允许子类继承父类中的注解

package cn.bx.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Method;
@Target(value = {ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface Description {
    String foo();
}
@Description(foo = "hello class ")
class UseAnnotation {
    @Description(foo = "hello method ")
    public void hello() {
        System.out.println("hello world");
    }
}
public class ParseAnnotation {
    public static void main(String[] args) {
        Class<UseAnnotation> useAnnotationClass = UseAnnotation.class;
        boolean annotationPresent = useAnnotationClass.isAnnotationPresent(Description.class);
        if (annotationPresent) {
            Description annotation = useAnnotationClass.getAnnotation(Description.class);
            System.out.println(annotation.foo());
        }
        Method[] methods = useAnnotationClass.getMethods();
        for (Method method : methods) {
            if (method.isAnnotationPresent(Description.class)) {
                Description annotation = method.getAnnotation(Description.class);
                System.out.println(annotation.foo());
            }
        }
    }
}

打印结果

hello class 
hello method