Java注解（Annotation）笔记

注解(Annotation)概述

  • 从JDK5.0开始，Java增加了对元数据(MetaData) 的支持, 也就是Annotation(注解)

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

  • Annotation可以像修饰符一样被使用, 可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明, 这些信息被保存在Annotation的 “name=value” 对中。

  • 在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。

  • 未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

注解(Annotation)的示例

使用Annotation时要在其前面增加@符号, 并把该Annotation当成一个修饰符使用，用于修饰它支持的程序元素。

示例一：生成文档相关的注解

  • @author 标明开发该类模块的作者，多个作者之间使用,分割
  • @version 标明该类模块的版本
  • @see 参考转向，也就是相关主题
  • @since 从哪个版本开始增加的
  • @param 对方法中某参数的说明，如果没有参数就不能写
  • @return 对方法返回值的说明，如果方法的返回值类型是void就不能写
  • @exception 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写

其中：

  1. @param @return 和 @exception 这三个标记都是只用于方法的。
  2. @param的格式要求：@param 形参名 形参类型 形参说明
  3. @return 的格式要求：@return 返回值类型 返回值说明
  4. @exception的格式要求：@exception 异常类型 异常说明
  5. @param和@exception可以并列多个
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package com.annotation.javadoc;
  /**
  * @author shkstart
  * @version 1.0
  * @see Math.java
  */
public class JavadocTest {
  /**
  * 程序的主方法，程序的入口
  * @param args String[] 命令行参数
  */
  public static void main(String[] args) {
  }
  /**
  * 求圆面积的方法
  * @param radius double 半径值
  * @return double 圆的面积
  */
  public static double getArea(double radius){
  	return Math.PI * radius * radius;
  }
}

示例二：在编译时进行格式检查(JDK内置的三个基本注解)

  • @Override: 限定重写父类方法, 该注解只能用于方法
  • @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
  • @SuppressWarnings: 抑制编译器警告
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
package com.annotation.javadoc;
public class AnnotationTest{
  public static void main(String[] args) {
    @SuppressWarnings("unused")
    int a = 10;
  }
  @Deprecated
  public void print(){
  	System.out.println("过时的方法");
  }
  @Override
  public String toString() {
  	return "重写的toString方法()";
  }
}

示例三：跟踪代码依赖性，实现替代配置文件功能

自定义注解（Annotation）

  • 定义新的Annotation类型使用@interface关键字

  • 自定义注解自动继承了java.lang.annotation.Annotation接口

  • Annotation的成员变量在Annotation定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型，以上所有类型的数组。

  • 可以在定义Annotation的成员变量时为其指定初始值, 指定成员变量的初始值可使用default关键字

  • 如果只有一个参数成员，建议使用参数名为value

  • 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是”参数名 = 参数值”，如果只有一个参数成员，且名称为value，可以省略”value=”

  • 没有成员定义的Annotation称为标记; 包含成员变量的Annotation称为元数据Annotation

自定义注解必须配上注解的信息处理流程（使用反射）才有意义。

  1. 注解声明为@interface

  1. 内部定义成员，通常使用value表示

  2. 可以指定成员的默认值，使用default定义

  3. 如果自定义注解没有成员，表示是一个标识作用

    如果注解有成员，在使用注解时，需要指明成员的值。

JDK中的元注解

JDK的元Annotation用于修饰其他Annotation定义

元注解：对现有的注解进行解释说明的注解。

JDK5.0提供了4个标准的meta-annotation类型，分别是：

  • Retention
  • Target
  • Documented
  • Inherited

Retention

@Retention:只能用于修饰一个Annotation定义, 用于指定该Annotation的生命周期, @Rentention包含一个 RetentionPolicy类型的成员变量，使用@Rentention时必须为该value成员变量指定值:

  • RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释
  • RetentionPolicy.CLASS:在class文件中有效（即class保留），当运行Java程序时, JVM不会保留注解。这是默认值。
  • RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行Java程序时，JVM会保留注释。程序可以通过反射获取该注释。

image-20210411155235014

RetentionPolicy对象的定义

1
2
3
4
5
public enum RetentionPolicy{
  SOURCE,
  CLASS,
  RUNTIME
}

使用@Retention

1
2
3
4
5
@Retention(RetentionPolicy.SOURCE)
@interface MyAnnotation1{ }

@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{ }

Target

@Target:用于修饰Annotation定义，用于指定被修饰的Annotation能用于修饰哪些程序元素。@Target也包含一个类型ElementType[]，名为value的成员变量。

ElementType是一个枚举类，包含下面👇的对象。

image-20210411155526091

ElementType的定义如下👇：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

@Target的定义👇

1
2
3
4
5
6
7
8
9
10
11
12
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();
}

@Target的使用

1
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})

👆上面的代码表示可以修饰类型（类、接口）、属性、方法、参数、构造器、局部变量

Documented（出现频率较低）

@Documented: 用于指定被该元 Annotation修饰的Annotation类将被javadoc工具提取成文档。

默认情况下，javadoc是不包括注解的。

定义为Documented的注解必须设置Retention值为RUNTIME。

例如@Deprecated注解，在API文档中会显示。

Inherited（出现频率较低）

@Inherited:被它修饰的Annotation将具有继承性。如果某个类使用了被@Inherited修饰的Annotation, 则其子类将自动具有该注解。

通过反射获取注解信息（未完待续）

JDK8中注解的新特性

Java 8对注解处理提供了两点改进：可重复的注解及可用于类型的注解。此外，反射也得到了加强，在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解。

可重复注解示例

image-20210411163020958

类型注解

JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER、TYPE_USE。

在Java1.8之前，注解只能是在声明的地方所使用，Java1.8开始，注解可以应用在任何地方。

  • ElementType.TYPE_PARAMETER：表示该注解能写在类型变量的声明语句中（如：泛型声明）。
  • ElementType.TYPE_USE：表示该注解能写在使用类型的任何语句中。

例：

TYPE_PARAMETER

image-20210411163249750

TYPE_USE

image-20210411163310719