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

Java 怎么编写只能在源码级别生效的自定义注解

落雪同学_2186

落雪同学_2186

发布时间:2026-09-04 17:19:59

|

1008人浏览过

|

来源于php中文网

原创

关键在于使用@Retention(RetentionPolicy.SOURCE),该策略使注解仅保留在源码中,编译时丢弃,不写入.class文件,无法反射获取,适用于编译期检查、IDE提示或APT处理。

java 怎么编写只能在源码级别生效的自定义注解

Java 中编写只能在源码级别生效的自定义注解,关键在于将注解的 @Retention 策略设为 RetentionPolicy.SOURCE。这类注解仅保留在 Java 源文件中,编译时即被丢弃,不会进入字节码(.class 文件),因此运行时完全不可见,也无法通过反射获取。

定义 SOURCE 级别注解

使用 @Retention(RetentionPolicy.SOURCE) 即可确保注解只存在于源码阶段。它常用于编译期检查、代码生成提示或 IDE 辅助(如 Lombok 的 @Cleanup 风格,但注意 Lombok 实际依赖编译插件,并非纯 SOURCE)。

  • 必须显式指定 @Retention(RetentionPolicy.SOURCE)
  • 通常搭配 @Target 明确作用位置(如 ElementType.METHOD、ElementType.TYPE 等)
  • 不能添加 @Documented 或 @Inherited(它们对 SOURCE 注解无意义,编译器会忽略或报错)

一个典型示例

下面是一个仅在源码中起标记作用、编译后消失的注解:

@Retention(RetentionPolicy.SOURCE)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface Experimental {
    String value() default "";
}

你可以在方法或类上使用它:

deep-java-review
deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载

立即学习“Java免费学习笔记(深入)”;

@Experimental("v2.0")
public void newFeature() { /* ... */ }

但编译完成后,反编译 .class 文件或用 getAnnotations() 反射调用,都找不到该注解 —— 它已彻底移除。

它能做什么、不能做什么

能做的:

  • 配合编译器插件(如 Annotation Processing Tool,APT)在编译期做静态检查(例如禁止调用某方法)
  • 作为开发约定标记,供 IDE 高亮、警告或代码分析工具识别(如 SonarQube、ErrorProne)
  • 生成文档注释或辅助代码审查(虽不参与运行,但提升可读性)

不能做的:

  • 无法在运行时通过反射读取(method.getAnnotation(Experimental.class) 总是返回 null)
  • 不能被 Spring、Jackson 等运行时框架识别和处理
  • 不能用于 AOP、动态代理等依赖运行时注解的机制

与其它保留策略对比

SOURCE:仅源码 → 编译即丢弃
CLASS:源码 + 字节码 → 类加载时不进 JVM 方法区(默认)
RUNTIME:源码 + 字节码 + 运行时 → 可反射访问

热门AI工具

更多
DeepSeek

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

WorkBuddy

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

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

相关专题

更多
java
java

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

9517

2023.06.15

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

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

6662

2023.07.05

java自学难吗
java自学难吗

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

5932

2023.07.31

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

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

1044

2023.08.01

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

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

868

2023.08.02

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

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

1236

2023.08.02

java有什么用
java有什么用

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

2489

2023.08.02

java在线网站
java在线网站

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

19831

2023.08.03

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

20

2026.09.30

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

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