Java中的注解

Java
Java
发布日期:   2021-01-09
更新日期:   2022-07-31
文章字数:   2.3k
阅读时长:   8 分
阅读次数:  

  

引言：

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

  1. Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
  2. Annotation 可以像修饰符一样被使用, 可用于修饰包, 类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation的 “name=value” 对中。
  3. 在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。
  4. 未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

一、注解的使用示例

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

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

  1. @author： 标明开发该类模块的作者，多个作者之间使用,分割
  2. @version： 标明该类模块的版本
  3. @see： 参考转向，也就是相关主题
  4. @since： 从哪个版本开始增加的
  5. @param： 对方法中某参数的说明，如果没有参数就不能写
  6. @return： 对方法返回值的说明，如果方法的返回值类型是void就不能写
  7. @exception： 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写
  8. 注意点：
    • @param @return 和 @exception 这三个标记都是只用于方法的。
    • @param的格式要求：@param 形参名 形参类型 形参说明
    • @return 的格式要求：@return 返回值类型 返回值说明
    • @exception的格式要求：@exception 异常类型 异常说明
    • @param和@exception可以并列多个

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

  1. @Override：限定重写父类方法, 该注解只能用于方法
  2. @Deprecated： 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
  3. @SuppressWarnings：抑制编译器警告

二、自定义注解

  1. 定义新的 Annotation 类型使用 @interface 关键字
  2. 自定义注解自动继承了java.lang.annotation.Annotation接口
  3. Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
  4. 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字
  5. 如果只有一个参数成员，建议使用参数名为value
  6. 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value，可以省略“value=”
  7. 没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation
  8. 注意：自定义注解必须配上注解的信息处理流程（使用反射）才有意义。
  9. 自定义注解通常都会指明两个元注解：Retention、Target
  10. 总结：

    ① 注解声明为：@interface
    ② 内部定义成员，通常使用value表示
    ③ 可以指定成员的默认值，使用default定义
    ④ 如果自定义注解没有成员，表明是一个标识作用。

    public @interface MyAnnotation {
    String value() default "hello";
}
    @Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

三、元注解

  JDK 的元 Annotation 用于修饰其他 Annotation 定义。对现有的注解进行解释说明的注解。
JDK 5.0 提供了4个标准的meta-annotation类型，分别是：

  1. @Retention：只能用于修饰一个 Annotation 定义，用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量。使用@Rentention 时必须为该 value 成员变量指定值。只有声明为RUNTIME生命周期的注解，才能在运行时通过反射获取。

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

  2. @Target：用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。@Target 也包含一个名为 value 的成员变量。

    取值(ElementType) 取值(ElementType)
    CONSTRUCTOR 用于描述构造器 PACKAGE 用于描述包
    FIELD 用于描述域 PARAMETER 用于描述参数
    LOCAL_VARIABLE 用于描述局部变量 TYPE 用于描述类、接口(包括注解类型)或枚举类enum声明
    METHOD 用于描述方法
    ElementType

  3. @Documented：用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。注：定义为Documented的注解必须设置Retention值为RUNTIME。

  4. @Inherited：被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation，则其子类将自动具有该注解。比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解。实际应用中，使用较少。

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, ANNOTATION_TYPE, PACKAGE, TYPE_PARAMETER, TYPE_USE})
@Documented
public @interface MyAnnotation {
    String value() default "hello";
}

四、利用反射获取运行时有效的注解的信息

  1. JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口, 该接口代表程序中可以接受注解的程序元素
  2. 当一个 Annotation 类型被定义为运行时 Annotation 后, 该注解才是运行时可见, 当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取
  3. 程序可以调用 AnnotatedElement对象的如下方法来访问 Annotation 信息：
    • getAnnotation(Class annotationClasss)
    • getAnnotations()
    • getDeclareAnnotations()
    • ……
import org.junit.Test;
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, ANNOTATION_TYPE, PACKAGE, TYPE_PARAMETER, TYPE_USE})
@Documented
@interface MyAnnotation {
    String value() default "hello";
}

@MyAnnotation
class Person {
    @MyAnnotation
    private String name;
    private int age;

    public Person() {}

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    @MyAnnotation
    public void walk() {
        System.out.println("人走路");
    }

    public void eat() {
        System.out.println("人吃饭");
    }
}

interface Info {
    void show();
}

class Student extends Person implements Info {
    @Override
    public void eat() {
        System.out.println("学生吃饭");
    }

    @Override
    public void show() {
        System.out.println("学生是祖国的花朵");
    }
}

@MyAnnotation
public class AnnotatonTest {
    @Test
    public void testAnnotation() {
        Class cls = Student.class;
        Annotation[] annotations = cls.getAnnotations();
        for (int i = 0; i < annotations.length; i++) {
            System.out.println(annotations[i]);
        }
    }
}

五、JDK 8 中的注解新特性：（可重复注解、类型注解）

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

  1. 可重复注解
    可重复注解
    ① 在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class
    ② MyAnnotation的Target、Retention以及@Inherit等元注解与MyAnnotations相同。若Target和Retention没有保持一致，则编译报错；若@Inherit没有保持一致，则运行报错。
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;

@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE})
@Repeatable(MyAnnotations.class)
@interface MyAnnotation {
    String value() default "hello";
}

@Retention(RetentionPolicy.RUNTIME)
@Target(TYPE)
public @interface MyAnnotations {
    MyAnnotation[] value();
}

//@MyAnnotations({@MyAnnotation("java"), @MyAnnotation("python")})//JDK 8 之前的写法
@MyAnnotation
@MyAnnotation("java")
class Person {
    public Person() {

    }
}
  1. 类型注解
      JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER，TYPE_USE。
    • ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明）
    • ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中
import java.lang.annotation.*;
import java.util.ArrayList;
import static java.lang.annotation.ElementType.*;

@Target({TYPE_USE, TYPE_PARAMETER})
@interface MyAnnotation {
    String value() default "hello";
}

class Generic<@MyAnnotation T>{//TYPE_PARAMETER起作用
    public void show() throws @MyAnnotation RuntimeException{//TYPE_USE起作用
        ArrayList<@MyAnnotation String> list = new ArrayList<>();//TYPE_USE起作用
        int num = (@MyAnnotation int) 10L;//TYPE_USE起作用
    }
}
文章作者: YangChongZhi
文章链接: http://yczlab.top/posts/74852cbf.html
版权声明: 本博客所有文章除特別声明外，均采用 CC BY 4.0 许可协议。转载请注明来源 YangChongZhi !
Java
赏
评论
 上一篇
Java中的集合Collection和Map Java中的集合Collection和Map
   引言： Java中的集合可分为 Collection 和 Map 两种体系。Collection接口：单列数据，定义了存取一组对象的方法的集合。Map接口：双列数据，保存具有映射关系“key-value对”的集合。Java 集合类可以
2021-01-09 Java
Java
下一篇 
Java中的枚举类 Java中的枚举类
   引言： java中枚举关于枚举类的使用说明 一、枚举类的使用1.枚举类的理解：类的对象只有有限个，确定的。我们称此类为枚举类2.当需要定义一组常量时，强烈建议使用枚举类3.如果枚举类中只有一个对象，则可以作为单例模式的实现方式。4.
2021-01-09 Java
Java
  目录