当前位置:首页 > 文章列表 > 文章 > java教程 > Java自定义注解详解:@Retention使用教程

Java自定义注解详解:@Retention使用教程

2025-12-30 21:38:41 0浏览 收藏

从现在开始,我们要努力学习啦!今天我给大家带来《@Retention注解用于定义注解的生命周期,是Java中创建自定义注解的重要部分。通过使用@Retention,你可以指定注解在什么阶段有效,比如在源代码中、编译时或运行时。以下是创建自定义注解的基本步骤,其中包含了@Retention的使用:1. 定义注解使用 @interface 关键字来声明一个注解类型。public @interface MyAnnotation { // 注解的属性 }2. 添加 @Retention 注解使用 @Retention 指定注解的保留策略。有三种常见的策略:RetentionPolicy.SOURCE:注解仅在源代码中存在,不会被编译到 .class 文件中。RetentionPolicy.CLASS:注解会被编译到 .class 文件中,但在运行时不可用。RetentionPolicy.RUNTIME:注解会保留在运行时,可以通过反射访问。import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @Retention(RetentionPolicy.RUNTIME) public @interface MyAnnotation { String value() default "default"; }3. 使用注解将注解应用到类、方法、字段等元素上。 @MyAnnotation("Hello, Annotation!") public class MyClass》,感兴趣的朋友请继续看下去吧!下文中的内容我们主要会涉及到等等知识点,如果在阅读本文过程中有遇到不清楚的地方,欢迎留言呀!我们一起讨论,一起学习!

@Retention是Java中指定注解保留策略的元注解,不创建注解而控制其生命周期:SOURCE(仅源码)、CLASS(默认,.class中但运行时不可见)、RUNTIME(.class中且反射可读)。

Java基础@Retention如何创建注解?

@Retention 是 Java 中用来指定注解保留策略的元注解,它**不负责创建注解本身**,而是控制你自定义的注解在什么阶段还“有效”——比如编译期、运行时,还是仅在源码中存在。

先创建一个注解(用 interface + @interface)

Java 注解本质是一个特殊的接口,用 @interface 声明:

public @interface MyLog {
    String value() default "log";
    int level() default 1;
}

这样就定义了一个带两个属性的注解 @MyLog。但此时它默认只保留在源码阶段(RetentionPolicy.SOURCE),运行时 getAnnotation() 拿不到。

用 @Retention 指定注解生命周期

要在运行时通过反射获取该注解,必须显式加上 @Retention(RetentionPolicy.RUNTIME)

@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
    String value() default "log";
    int level() default 1;
}

常用保留策略有三个:

  • SOURCE:只保留在源代码中,编译后丢弃(如 @Override
  • CLASS:保留在 .class 文件中,但运行时不可见(默认值)
  • RUNTIME:保留在 .class 中且可通过反射读取(写框架、AOP、ORM 时必需)

搭配 @Target 明确使用位置(推荐一起用)

单独用 @Retention 不够,你还得告诉编译器这个注解能加在哪儿,比如类、方法、参数等:

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface MyLog { ... }

常见 ElementType 值:

  • TYPE → 类、接口、枚举
  • METHOD → 方法
  • FIELD → 成员变量
  • PARAMETER → 方法参数
  • LOCAL_VARIABLE → 局部变量(很少用)

验证注解是否生效(运行时反射)

加了 @Retention(RUNTIME) 后,就能在运行时读取:

@MyLog(level = 2)
public class UserService {
    @MyLog("update user")
    public void update() { ... }
}

// 反射获取
MyLog anno = UserService.class.getAnnotation(MyLog.class);
System.out.println(anno.level()); // 输出 2

如果没加 @Retention(RUNTIME),这里会返回 null

基本上就这些。@Retention 不是“创建”注解的步骤,而是让注解“活到你需要的时候”的关键配置。

以上就是本文的全部内容了,是否有顺利帮助你解决问题?若是能给你带来学习上的帮助,请大家多多支持golang学习网!更多关于文章的相关知识,也可关注golang学习网公众号。

Flex-basis属性详解:弹性布局核心设置Flex-basis属性详解:弹性布局核心设置
上一篇
Flex-basis属性详解:弹性布局核心设置
2B铅笔是什么?2B与HB区别解析
下一篇
2B铅笔是什么?2B与HB区别解析
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    3500次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    3727次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    3727次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    4871次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    4097次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码