登录
首页 >  文章 >  java教程

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

时间:2025-12-30 21:38:41 453浏览 收藏

从现在开始,我们要努力学习啦!今天我给大家带来《@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学习网公众号。

相关阅读
更多>
最新阅读
更多>
课程推荐
更多>