• 已删除用户
Administrator
发布于 2018-07-05 / 0 阅读
0

Java 注解

Java注解又称Java标注,是在 JDK5 时引入的新特性。
Java 注解它提供了一种安全的类似注释的机制,用来将任何的信息或元数据(metadata)与程序元素(类、方法、成员变量等)进行关联。Java 注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。

元注解

所谓元注解,就是加在注解上的注解。

@Retention

标识这个注解怎么保存,是只在代码中,还是编入 class 文件中,或者是在运行时可以通过反射访问。

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

RetentionPolicy 是一个枚举类型,它定义了被 @Retention 修饰的注解所支持的保留级别:

生命周期类型

描述

RetentionPolicy.SOURCE

编译时被丢弃,不包含在类文件中

RetentionPolicy.CLASS

JVM 加载时被丢弃,包含在类文件中,默认值为 Class

RetentionPolicy.RUNTIME

由 JVM 加载,包含在类文件中,在运行时可以被获取到

@Documented

标记这些注解是否包含在用户文档中,对类作辅助说明。

@Target

标记这个注解应该是哪种 Java 成员。

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

ElementType 是一个枚举类型,它定义了被 @Target 修饰的注解可以应用的范围:

ElementType 类型

描述

ElementType.TYPE

应用于类、接口(包括注解类型)、枚举

ElementType.FIELD

应用于字段或属性

ElementType.METHOD

应用于方法

ElementType.PARAMETER

应用于方法的参数

ElementType.CONSTRUCTOR

应用于构造函数

ElementType.LOCAL_VARIABLE

应用于局部变量

ElementType.ANNOTATION_TYPE

应用于注解类型声明

ElementType.PACKAGE

应用于包

ElementType.TYPE_PARAMETER

应用于类型变量(Java 8 新增)

ElementType.TYPE_USE

应用于任何使用类型的语句中(Java 8 新增)

@Inherited

只能被用来标注Annotation类型,它所标注的 Annotation 具有继承性。

/**
 * 自定义注解
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@interface Inheritable {
}

/**
 * 父类
 */
@Inheritable
class Father {
    public Father() {
        // Father 是否具有 Inheritable 注解
        System.out.println("Father:"+Father.class.isAnnotationPresent(Inheritable.class));
    }
}

/**
 * 子类,继承于 InheritableFather,
 */
public class Son extends Father {
    public Son() {
        super();    // 调用父类的构造函数
        // Son类是否具有 Inheritable 注解
        System.out.println("Son:"+Son.class.isAnnotationPresent(Inheritable.class));
    }

    public static void main(String[] args) {
        Son is = new Son();
    }
}

运行结果:

Father:true
Son:true

@Repeatable

Java 8 开始支持。标识某注解可以在同一个声明上使用多次。
当我们需要重复使用某个注解时,希望利用相同的注解来表现所有的形式时,我们可以借助@Repeatable 注解。
以 Spring @Scheduled 为例:

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

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {
  // ...
}

标准注解

java.lang.annotation内置的常用注解。

@Override

检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。

@Deprecated

标记过时方法。如果使用该方法,会报编译警告。

@SuppressWarnings

指示编译器去忽略注解中声明的警告。

@SafeVarargs

Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。

@FunctionalInterface

Java 8 开始支持,标识一个匿名函数或函数式接口。

自定义注解

个人在封装工具时,喜欢声明一些自定义注解,在反射中使用或者 AOP 中使用。后续的章节中可以拿一两个例子分享分析。