自定义注解定义全流程_自定义注解如何声明属性及默认值实现灵活配置

风芳大大_5925

风芳大大_5925

2026-05-12

193人浏览

原创

自定义注解需三步:用@target和@retention声明作用位置与生命周期,用接口语法定义属性(支持string、基本类型、class、枚举、注解及数组),再通过反射或框架(如spring aop)读取并执行逻辑。

自定义注解定义全流程_自定义注解如何声明属性及默认值实现灵活配置

自定义注解不是“写个标签”就完事,它需要明确作用位置、生命周期和可配置项。核心在于三步:用元注解定范围与时机,用接口语法声明属性,再通过反射或框架机制读取并生效。

必须声明的两个元注解

每个自定义注解都得带上 @Target 和 @Retention,否则编译不通过。

  • @Target 指明能贴在哪——比如只允许标注方法,就写 @Target(ElementType.METHOD);若支持类、方法、字段,可写 @Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
  • @Retention 决定能活多久——业务逻辑需在运行时读取(如AOP拦截、日志打印),必须选 RetentionPolicy.RUNTIME;仅用于编译检查(如自定义 @NotNull),可用 SOURCE

属性声明规则与默认值写法

注解里的“属性”本质是接口中的抽象方法,类型受限,但支持常见业务需求。

  • 允许的类型包括:String、基本类型(int、boolean等)、Class>、枚举、其他注解,以及这些类型的数组
  • 每个属性后必须跟括号 (),有默认值就加 default 值;无默认值则使用时必须显式赋值
  • 若唯一需填的属性名为 value,调用时可省略名字,直接写 @MyLog("保存用户")
  • 数组属性单元素可不写花括号,例如 roles = "ADMIN" 等价于 roles = {"ADMIN"}

一个带多属性的日志注解示例

假设要标记方法是否记录入参、操作类型和级别:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
    String value() default "";                    // 主描述,value名可省略
    LogLevel level() default LogLevel.INFO;      // 枚举类型属性
    boolean recordParams() default true;         // 布尔开关
    String[] excludeFields() default {};         // 字符串数组,默认空
}

使用时可灵活组合:
@Log("创建订单") —— 用默认值
@Log(value = "删除缓存", recordParams = false) —— 显式覆盖部分值
@Log(value = "权限校验", excludeFields = {"password", "token"}) —— 数组赋值

后续生效的关键:不只是定义,还要解析

定义完注解只是第一步。它本身不执行任何逻辑,必须配合反射或框架机制触发行为:

  • 在 Spring 中,常结合 @Aspect 切面,在 @Around 或 @Before 中用 method.getAnnotation(Log.class) 获取配置
  • 手动反射解析时,先获取目标方法对象,再调用 getDeclaredAnnotation() 或 getAnnotation()
  • 注意:只有 @Retention(RetentionPolicy.RUNTIME) 的注解才能被反射读到
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

10237

6

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

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

2023.07.05

7362

9

java自学难吗
java自学难吗

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

2023.07.31

6472

8

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

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

2023.08.01

1124

3

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

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

2023.08.02

928

3

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

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

2023.08.02

1356

5

java有什么用
java有什么用

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

2023.08.02

2689

5

java在线网站
java在线网站

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

2023.08.03

20011

3

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

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

2023.08.03

1195

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习