• Annotation学习笔记


    什么是Annotation

    Java Annotation是JDK5.0引入的一种注释机制。

    Annotation其实是代码里的特殊标记,这些标记可以在编译、类加载、运行时被读取,并执行相应的处理。通过使用Annotation,程序开发人员可以在不改变原有逻辑的情况下,在源文件嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。

    Annotation提供了一条为程序元素设置元数据的方法,从某些方面来看,Annotation就像修饰符一样被使用,可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明,这些信息被存储在Annotation的“name-value”对中。

    Annotation能被用来为程序元素(类、方法、成员变量等)设置元数据。值得指出的是:Annotation不能影响程序代码的执行,无论增加、删除Annotation,代码都始终如一地执行。如果希望让程序中的Annotation能在运行时起一定的作用,只有通过某种配套的工具对Annotation中的信息进行访问的处理,访问和处理Annotation的工具统称APT(Annotation Processing Tool)。

    Annotation架构

    images/clip_2020-11-23_10-39-07.png

    从中,我们可以看出:

    • 1个Annotation 和 1个RetentionPolicy关联。
      可以理解为:每1个Annotation对象,都会有唯一的RetentionPolicy属性。

    • 1个Annotation 和 1~n个ElementType关联。
      可以理解为:对于每1个Annotation对象,可以有若干个ElementType属性。

    • Annotation 有许多实现类,包括:Deprecated, Documented, Inherited, Override等等。
      Annotation 的每一个实现类,都“和1个RetentionPolicy关联”并且“和1~n个ElementType关联”。

    java annotation 的组成中,有3个非常重要的主干类。它们分别是:

    Annotation.java

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

    ElementType.java

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

    RetentionPolicy.java

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

    说明:

    • Annotation 就是个接口。
      “每1个Annotation” 都与 “1个RetentionPolicy”关联,并且与 “1~n个ElementType”关联。可以通俗的理解为:每1个Annotation对象,都会有唯一的RetentionPolicy属性;至于ElementType属性,则有1~n个。

    • ElementType 是Enum枚举类型,它用来指定Annotation的类型。
      “每1个Annotation” 都与 “1~n个ElementType”关联。当Annotation与某个ElementType关联时,就意味着:Annotation有了某种用途。
      例如,若一个Annotation对象是METHOD类型,则该Annotation只能用来修饰方法。

    • RetentionPolicy 是Enum枚举类型,它用来指定Annotation的策略。通俗点说,就是不同RetentionPolicy类型的Annotation的作用域不同。“每1个Annotation” 都与 “1个RetentionPolicy”关联。

      • 若Annotation的类型为 SOURCE,则意味着:Annotation仅存在于编译器处理期间,编译器处理完之后,该Annotation就没用了。例如,@Override 标志就是一个Annotation。当它修饰一个方法的时候,就意味着该方法覆盖父类的方法;并且在编译期间会进行语法检查!编译器处理完后,@Override就没有任何作用了。
      • 若Annotation的类型为 CLASS,则意味着:编译器将Annotation存储于类对应的.class文件中,它是Annotation的默认行为。
      • 若Annotation的类型为 RUNTIME,则意味着:编译器将Annotation存储于class文件中,并且可由JVM读入。

    这时,只需要记住“每1个Annotation” 都与 “1个RetentionPolicy”关联,并且与 “1~n个ElementType”关联。学完后面的内容之后,再回头看这些内容,会更容易理解。

    常见Annotation

    由于目前的任务是理解代码逻辑,关于Annotation更详细的实现原理,先不深究。下面列出工作中常见的Annotation以供后续查阅和继续学习Annotation相关知识。

    Java 定义的Annotation

    Java 5开始定义了一套注解,共有 7 个,3 个在 java.lang 中,剩下 4 个在 java.lang.annotation 中。

    作用在代码的注解是:

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

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

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

    作用在其他注解的注解(或者说元注解)是:

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

    @Documented - 标记这些注解是否包含在用户文档中。

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

    @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

    从 Java 7 开始,额外添加了 3 个注解:

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

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

    @Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。

    lombok定义的Annotation

    @Getter / @Setter - 自动生成Getter/Setter方法

    @Data - 自动为所有字段添加@ToString, @EqualsAndHashCode, @Getter方法,为非final字段添加@Setter@RequiredArgsConstructor

    @NoArgsConstructor - 自动生成无参数构造函数

    @AllArgsConstructor - 自动生成全参数构造函数

    @NonNull - 可以帮助我们避免空指针

    @Cleanup - 自动帮我们调用close()方法

    Spring定义的Annotation

    @Component - 定义一个Bean

    @Resource - 注入“文件”,方便程序读取

    @PropertySource - 注入配置文件

    @Autowired - 把指定类型的Bean注入到指定的字段中

    @Bean - 创建第三方Bean:在@Configuration类中编写一个Java方法创建并返回,需要给方法标记一个@Bean注解

    @Configuration - 使用AnnotationConfigApplicationContext创建ApplicationContext必须用

    @ComponentScan - 告诉容器,自动搜索当前类所在的包以及子包,把所有标注为@Component的Bean自动创建出来,并根据 @Autowired进行装配。

    @PostConstruct - Bean初始化时会调用的方法

    @PreDestroy - Bean销毁时会调用的方法

    参考

    [1]. Java Annotation认知(包括框架图、详细介绍、示例说明)
    [2]. Java中Annotation用法
    [3]. 廖雪峰 - Spring开发 - 使用Annotation配置
    [4]. Java 必须掌握的 20+ 种 Spring 常用注解
    [5]. Spring基础知识汇总 Java开发必看

  • 相关阅读:
    700.二叉搜索树中的搜索
    645.错误的集合
    567.字符串的排列
    560.和为K的子数组
    518.零钱兑换 II
    516.最长回文子序列
    509.斐波那契数
    503.下一个更大元素 II
    496.下一个更大元素 I
    leetcode 1171 Remove Zero Sum Consecutive Nodes from Linked List
  • 原文地址:https://www.cnblogs.com/yaohl0911/p/14177359.html
Copyright © 2020-2023  润新知