讲师中心 微信公众号
AI工具推荐 视频效率加速

自定义注解属性的强约束检查_自定义注解如何通过APT在编译期强制校验属性合法性

轻瑶同学_9869

轻瑶同学_9869

发布时间:2026-05-15 20:02:36

|

680人浏览过

|

来源于php中文网

原创

必须用APT在编译期强制校验注解属性——通过@Retention(RetentionPolicy.SOURCE)声明注解,于process()中遍历标注元素、提取AnnotationMirror/Value并校验数值范围、字符串非空、枚举合法性、字段类型等,错误时调用messager报错中断编译。

自定义注解属性的强约束检查_自定义注解如何通过apt在编译期强制校验属性合法性

自定义注解属性的强约束检查,不能靠运行时反射或手动校验实现——那会漏掉错误、增加开销、无法阻止非法代码进入生产环境。真正“强制”的方式,是让检查发生在编译期,由APT(Annotation Processing Tool)在javac阶段就拦截不合法的用法,并直接报错中断编译。

为什么必须用APT做编译期强制校验

运行时注解(@Retention(RetentionPolicy.RUNTIME))只能在程序启动后通过反射读取,此时错误已打包进APK/JAR,用户运行才暴露;而编译期校验要求注解本身声明为 @Retention(RetentionPolicy.SOURCE),且校验逻辑嵌入处理器中。只要开发者写了不合规的属性值(如负数长度、空字符串必填字段、类型不匹配等),APT就会在IDE里实时标红、命令行编译直接失败。

关键:在process()中解析并校验注解属性值

注解处理器的 process() 方法不仅是生成代码的入口,更是执行强约束检查的唯一可控时机。你需要:

  • 遍历 roundEnv.getElementsAnnotatedWith(YourAnnotation.class) 获取所有被标注的元素
  • 对每个元素调用 element.getAnnotationMirrors() 或使用 AnnotationMirror/AnnotationValue API 提取实际传入的属性值(注意:不能用 element.getAnnotation(),那是运行时API,APT中不可用)
  • 逐项检查:比如 @MyLimit(maxLength = -5) 就应触发 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "maxLength must be >= 0", element)
  • 校验失败不生成代码,但必须返回 false 或确保错误被报告,否则编译可能静默通过

典型强约束场景与检查写法

以下检查都应在APT处理器内完成,而非留到运行时:

  • 数值越界:如 minLength() > maxLength(),或 minNum() > maxNum(),直接报错
  • 字符串合法性:如 description() 为空但业务要求非空,用 value.getValue().toString().trim().isEmpty() 判断
  • 枚举/常量匹配:若注解含 @interface MyRule { Level level() default Level.HIGH; },需校验传入的 Level 是否为已知枚举实例(通过 value.toString() 解析后比对)
  • 字段类型约束:例如注解只允许标注 String 字段,但用户加在 int 上 —— 用 element.asType().toString().equals("java.lang.String") 检查

配合注解声明增强语义约束

单靠处理器还不够,注解自身的元信息也要配合:

  • 使用 @Target({ElementType.FIELD, ElementType.PARAMETER}) 明确限定可用位置,超出即编译报错
  • 用 @Repeatable(MyAnnotations.class) 控制是否允许多次使用
  • 避免定义冗余或矛盾属性(如同时提供 required=true 和 defaultValue=""),这类设计缺陷应在文档和处理器中一并拦截

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

热门AI工具

更多
二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

更多
java
java

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

10997

2023.06.15

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

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

8102

2023.07.05

java自学难吗
java自学难吗

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

7032

2023.07.31

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

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

1184

2023.08.01

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

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

968

2023.08.02

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

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

1416

2023.08.02

java有什么用
java有什么用

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

2889

2023.08.02

java在线网站
java在线网站

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

20171

2023.08.03

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

0

2026.10.22

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn