当前位置:网站首页 > 技术博客 > 正文

java @注解



廖雪峰
资深软件开发工程师,业余马拉松选手。

Java的注解本身对代码逻辑没有任何影响。根据的配置:

  • 类型的注解在编译期就被丢掉了;
  • 类型的注解仅保存在class文件中,它们不会被加载进JVM;
  • 类型的注解会被加载进JVM,并且在运行期可以被程序读取。

如何使用注解完全由工具决定。类型的注解主要由编译器使用,因此我们一般只使用,不编写。类型的注解主要由底层工具库使用,涉及到class的加载,一般我们很少用到。只有类型的注解不但要使用,还经常需要编写。

因此,我们只讨论如何读取类型的注解。

因为注解定义后也是一种,所有的注解都继承自,因此,读取注解,需要使用反射API。

Java提供的使用反射API读取的方法包括:

判断某个注解是否存在于、、或:

  • Class.isAnnotationPresent(Class)
  • Field.isAnnotationPresent(Class)
  • Method.isAnnotationPresent(Class)
  • Constructor.isAnnotationPresent(Class)

例如:

使用反射API读取Annotation:

  • Class.getAnnotation(Class)
  • Field.getAnnotation(Class)
  • Method.getAnnotation(Class)
  • Constructor.getAnnotation(Class)

例如:

使用反射API读取有两种方法。方法一是先判断是否存在,如果存在,就直接读取:

第二种方法是直接读取,如果不存在,将返回:

读取方法、字段和构造方法的和Class类似。但要读取方法参数的就比较麻烦一点,因为方法参数本身可以看成一个数组,而每个参数又可以定义多个注解,所以,一次获取方法参数的所有注解就必须用一个二维数组来表示。例如,对于以下方法定义的注解:

要读取方法参数的注解,我们先用反射获取实例,然后读取方法参数的所有注解:

注解如何使用,完全由程序自己决定。例如,JUnit是一个测试框架,它会自动运行所有标记为的方法。

我们来看一个注解,我们希望用它来定义一个字段的规则:字段长度满足的参数定义:

在某个JavaBean中,我们可以使用该注解:

但是,定义了注解,本身对程序逻辑没有任何影响。我们必须自己编写代码来使用注解。这里,我们编写一个实例的检查方法,它可以检查实例的字段长度是否满足的定义:

这样一来,我们通过注解,配合方法,就可以完成实例的检查。注意检查逻辑完全是我们自己编写的,JVM不会自动给注解添加任何额外的逻辑。

使用注解来检查Java Bean的字段。如果字段类型是,就检查的长度,如果字段是,就检查的范围。

下载练习

可以在运行期通过反射读取类型的注解,注意千万不要漏写,否则运行期无法读取到该注解。

可以通过程序处理注解来实现相应的功能:

  • 对JavaBean的属性值按规则进行检查;
  • JUnit会自动运行标记的测试方法。

版权声明


相关文章:

  • 查看linux内核版本号的方法2025-05-17 12:01:05
  • 12306抢票脚本原理2025-05-17 12:01:05
  • 树莓派 怎么买2025-05-17 12:01:05
  • 荃优399水稻品种简介2025-05-17 12:01:05
  • pop函数用法2025-05-17 12:01:05
  • java键值对有哪些集合2025-05-17 12:01:05
  • 超像素分割后的提取2025-05-17 12:01:05
  • 运维平台app2025-05-17 12:01:05
  • 随机一致性指标数值表2025-05-17 12:01:05
  • 数据结构快速排序图解2025-05-17 12:01:05