Annotation注解:自定义变量注解与运行时解析

雨浩酱_8874

雨浩酱_8874

2026-05-09

826人浏览

原创

实现自定义变量注解需定义@target(elementtype.field)和@retention(retentionpolicy.runtime)的注解,并通过反射调用getdeclaredfields()与getannotation()安全读取;属性须有合法默认值,避免null及作用域错配。

annotation注解:自定义变量注解与运行时解析

要实现自定义变量注解并在运行时解析,关键在于两点:一是正确定义作用于字段(FIELD)的 RUNTIME 级注解;二是通过反射安全获取并读取字段上的注解属性。变量注解和方法、类注解在定义逻辑上一致,但目标位置和使用场景不同——它常用于数据绑定、校验、序列化或 ORM 映射等场景。

定义变量级 RUNTIME 注解

必须用 @Target(ElementType.FIELD) 限定只能标注在成员变量上,且 @Retention(RetentionPolicy.RUNTIME) 是硬性前提,否则反射无法读到。

  • 属性类型仅限:基本类型、String、Class>、枚举、其他注解,或它们的一维数组(如 String[])
  • 每个属性必须有 default 值(null 不合法),否则使用时必须显式赋值
  • 示例定义:

  @Target(ElementType.FIELD)
  @Retention(RetentionPolicy.RUNTIME)
  public @interface Column {
    String name() default "";
    boolean nullable() default true;
    String type() default "VARCHAR";
  }

在字段上使用注解

直接写在类的成员变量前,支持省略 value() 名(若存在且唯一需设值),其余属性用键值对形式。

  • 合法写法:@Column(name = "user_name", nullable = false)
  • 若只设 name 且它是唯一无默认值的属性(或只有 value()),可简写为:@Column("user_name")
  • 数组写法:@Column(name = "tags", type = "TEXT", nullable = false)(注意不能写 default null)

运行时解析字段注解

通过 Class.getDeclaredFields() 获取所有字段,再逐个调用 field.getAnnotation(YourAnnotation.class)。务必先判空,避免 NPE。

  • 推荐方式:if (field.isAnnotationPresent(Column.class)) { Column col = field.getAnnotation(Column.class); ... }
  • 不建议用 toString() 或 equals() 比较注解对象,它只是 JVM 生成的代理实例
  • 注意:getDeclaredAnnotations() 返回全部注解数组,getAnnotation() 才按类型精准获取
  • 性能提示:频繁反射建议缓存字段+注解结果,或结合 Spring 的 ReflectionUtils 工具类简化操作

常见踩坑点

很多“读不到注解”的问题其实源于配置疏漏:

  • 忘了加 @Retention(RetentionPolicy.RUNTIME) —— 编译后注解就消失了
  • 用了 @Target(ElementType.METHOD) 却标在字段上,编译直接报错
  • 属性声明为 String value() default null —— null 不是合法默认值,编译失败
  • 反射时未调用 setAccessible(true) 访问 private 字段(若字段非 public)
  • 误用 getAnnotations()(只返回 public 父类继承的)而非 getDeclaredAnnotations()
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10957

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

8082

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7012

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1184

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

968

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1416

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2889

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20171

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1275

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.9万人学习