Java 中注解原理怎么在代码评审中检查注解的正确性

夜伟小哥_7274

夜伟小哥_7274

2026-09-28

107人浏览

原创

合格的自定义注解必须满足四点:①@retention为runtime;②@target覆盖所有实际使用位置;③属性类型限于基本类型、string、class、枚举、注解及一维数组;④附带可验证的使用示例与测试。

java 中注解原理怎么在代码评审中检查注解的正确性

注解本身不执行任何逻辑,它只是元数据。代码评审中判断一个自定义注解是否合格,关键不是看它“写得漂不漂亮”,而是看它能否被后续流程稳定识别和使用——编译器、IDE、构建工具或运行时框架是否能按预期读到它。

看 @Retention 是否为 RUNTIME

除非明确只用于编译期(比如 Lombok 或自定义代码生成器),否则业务类注解必须声明 @Retention(RetentionPolicy.RUNTIME)。

  • 写成 @Retention(RetentionPolicy.CLASS) 或默认 SOURCE:字节码里没有该注解,clazz.getAnnotations() 返回空数组,Spring AOP、校验器、日志切面等统统失效
  • 评审时直接驳回:没 RUNTIME 的注解,在 Spring Boot 场景下等于没写
  • 例外仅限配套了 Annotation Processor 且 CI 中已验证生成逻辑的编译期注解

看 @Target 是否覆盖所有真实使用位置

声明了 @Target 就必须穷举实际会加注解的地方;漏掉一个,编译就报错,CI 流水线失败。

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
  • 常见组合如 @Target({FIELD, METHOD, PARAMETER}),适用于字段校验 + 方法参数校验
  • 别误用 TYPE_PARAMETER:它是给泛型形参(如 class Box<t></t> 中的 T)用的,不是给 Box<string></string> 这种实参用的
  • 不确定未来扩展时,宁可宽泛些(比如加上 TYPE),也别漏掉当前已用位置

看属性类型是否合规

注解属性不能是任意对象,只能是 JVM 原生支持的“常量友好型”类型。

  • 允许:基本类型、String、Class、枚举、其他注解、一维数组(如 String[])
  • 禁止:List、Map、自定义 POJO、Object、多维数组(如 String[][])
  • 替代方案:用字符串传 JSON(需自行解析)、或拆成多个基础属性(如 String key() + String value())

看是否有可验证的使用示例

评审不只看注解定义,更要看它“能不能用”。合格的自研注解必须附带最小可行验证路径。

  • 提供一个简单类/方法,加上该注解,并在单元测试中通过反射获取它:field.getAnnotation(YourAnn.class)
  • 若用于校验,需给出校验器实现片段,证明能正确提取属性值并执行逻辑
  • 若依赖 Spring,要说明触发时机(例如:是否集成进 @Valid 链路,是否注册了 ConstraintValidator)

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

java

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

相关专题

更多
java
java

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

2023.06.15

9177

6

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

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

2023.07.05

6342

9

java自学难吗
java自学难吗

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

2023.07.31

5672

8

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

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

2023.08.01

1004

3

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

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

2023.08.02

848

3

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

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

2023.08.02

1196

5

java有什么用
java有什么用

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

2023.08.02

2409

5

java在线网站
java在线网站

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

2023.08.03

19771

3

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

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

2023.08.03

1095

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习