Java注解

Java注解（Annotation）

Java注解存在的作用

编译检查

Annotation具有让编译器进行编译检查的作用，例如注解@SuppressWarnings，@Deprecated，@Override等注解都具有编译检查的作用。

在反射中使用注解

可以通过反射解析Class，Method，Field上的注解以及注解中的值

根据注解生成JavaDoc文档

通过给Annotation注解上加上@Documented注解，能够使该Annotation标签出现在JavaDoc中

提升代码可读性

通过@Override，@Deprecated等注解，我们可以很方便的了解程序的大致结构，另外我们也可以通过自定义注解来实现一些功能

Java内置注解

Java注解，也可以被称为Java标注，与JavaDoc不同的是，Java注解是可以通过反射获取到标注的内容，在编译之后是可以被嵌入class文件中，Java虚拟机可以保留标注内容，并且在运行时可以获取到标注内容，Java也可以支持自定义的标注。

在Java7之前，Java的注解一共有七个，其中三个在java.lang包下，另外四个在java.lang.annotation包下

java.lang包下的注解：

@Override：检查该方法是否是重写方法，如果发现其父类，或者实现的接口并没有该方法，编译器会报错
@Deprecated：标记该方法已过时，如果使用该方法，编译器会报警告
@SuppressWarnnings：指示编译器去忽略注解中声明的警告

java.lang.annotation包下的注解（元注解）：

通过这些元注解可以帮助我们去定义我们自己需要的注解

@Retention：标记一个注解怎么保存，是只在代码中，还是嵌入class文件中，又或者在运行中可以被JVM通过反射访问
@Documented：标记这个注解是否出现在JavaDoc中
@Target：标记这个注解的类型，也可以被称为作用范围
@Inherited：标记这个注解是继承哪个注解类

Java7新增注解：

@SafeVarargs：

Java8新增注解：

@FunctionalInterface：标记一个匿名函数或函数式接口
@Repeatable：标识某一个注解在同一个声明上可以使用多次

Annotation架构图

一个Annotaiion注解只有一个RetentionPolicy属性
一个Annotation注解可以有多个ElementType属性
Annotation有许多的实现类，包括Deprecated，Documented，Inherited，Override，Retention，Target等等

Annotation组成部分

Annotation部分

package java.lang.annotation;
public interface Annotation {
    boolean equals(Object obj);
    int hashCode();
    String toString();
    Class<? extends Annotation> annotationType();
}

ElementType部分

package java.lang.annotation;

public enum ElementType {
    TYPE,               /* 类、接口（包括注释类型）或枚举声明  */
    FIELD,              /* 字段声明（包括枚举常量）  */
    METHOD,             /* 方法声明  */
    PARAMETER,          /* 参数声明  */
    CONSTRUCTOR,        /* 构造方法声明  */
    LOCAL_VARIABLE,     /* 局部变量声明  */
    ANNOTATION_TYPE,    /* 注释类型声明  */
    PACKAGE             /* 包声明  */
}

RetentionPolicy部分

package java.lang.annotation;
public enum RetentionPolicy {
    SOURCE,            /* Annotation信息仅存在于编译器处理期间，编译器处理完之后就没有该Annotation信息了  */
    CLASS,             /* 编译器将Annotation存储于类对应的.class文件中。默认行为  */
    RUNTIME            /* 编译器将Annotation存储于class文件中，并且可由JVM读入 */
}

Annotation就是一个接口，我们所自定义的注解是继承于这个Annotation接口的，它必须与一个RetentionPolicy关联，与一个或多个ElementType进行关联，也就是我们所自定义的注解必须有一个RetentionPolicy属性，一个或多个ElementType属性
ElementType就是一个枚举类型
RetentionPolicy也是一个枚举类型，它决定着这个注解存在于什么范围之内

自定义注解

//以下代码来自若依框架，具体功能是标注匿名访问不鉴权
@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Anonymous{
}

target中指定了两种ElementType，分别是METHOD和TYPE，表示该注解可以作用在方法，类，接口上
Retention指定了RetentionPolicy的RUNTIME，表示该注解可以存在于class文件中，并且可以被JVM读取
Documented使这个注解在JavaDoc中

本文采用署名-非商业性使用-相同方式共享 4.0 国际许可协议，转载请注明出处。