怎么用 @interface 语法正式声明一个标准的自定义业务注解

酷磊君_3056

酷磊君_3056

2026-05-30

506人浏览

原创

自定义业务注解需用@interface声明,必须搭配@target和@retention元注解,支持@documented和@inherited;属性仅限特定类型、无参无异常、建议设default值;命名宜体现业务意图,如@riskcheck,且注解仅为元数据容器。

怎么用 @interface 语法正式声明一个标准的自定义业务注解

用 @interface 声明自定义业务注解,核心是模仿 Java 内置注解的语法规范,同时明确其作用范围、生命周期和使用场景。

基础结构:必须包含元注解

一个标准的业务注解需至少搭配 @Target 和 @Retention 两个元注解,否则编译器无法识别其适用位置和保留策略:

  • @Target 指定注解能用在哪些程序元素上(如类、方法、参数等),常用值:ElementType.TYPE(类/接口)、ElementType.METHOD、ElementType.PARAMETER
  • @Retention 控制注解存活时间,业务注解通常选 RetentionPolicy.RUNTIME,确保运行时可通过反射读取
  • 可选加 @Documented(生成 Javadoc 时包含该注解)、@Inherited(允许子类继承)

定义注解成员:按需声明属性

注解中的方法声明即为“属性”,有固定规则:

  • 返回类型只能是基本类型、String、Class、枚举、其他注解,或以上类型的数组
  • 不能有参数,不能抛异常,不能有方法体(即不能写 {})
  • 建议为每个属性提供默认值(用 default 关键字),避免使用者强制赋值
  • 常用属性名如 value()(当注解主要只接收一个值时,调用可省略名称)、description()、order() 等

典型示例:一个订单校验业务注解

比如声明一个用于标记订单处理方法是否需风控校验的注解:

@Target({ElementType.METHOD, ElementType.TYPE})<br>
@Retention(RetentionPolicy.RUNTIME)<br>
@Documented<br>
public @interface RiskCheck {<br>
    String value() default "DEFAULT";<br>
    String description() default "";<br>
    int level() default 1;<br>
    Class extends RiskChecker> checker() default DefaultRiskChecker.class;<br>
}

这个注解可用于类或方法,运行时有效,支持指定校验级别、描述和自定义校验器实现。

注意事项与最佳实践

  • 注解名建议用名词或形容词+Check/Validator/Handler 等后缀,体现业务意图,如 @InventoryLock、@Idempotent
  • 避免定义过多属性;若逻辑复杂,考虑拆分为多个专注单一职责的注解
  • 如果注解需要被 Spring 等框架识别并自动处理,后续还需配合 AOP 或 BeanPostProcessor 实现增强逻辑
  • 不要在注解中放业务逻辑或可变状态——它只是元数据容器
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

9917

6

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

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

2023.07.05

7042

9

java自学难吗
java自学难吗

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

2023.07.31

6232

8

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

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

2023.08.01

1084

3

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

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

2023.08.02

888

3

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

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

2023.08.02

1296

5

java有什么用
java有什么用

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

2023.08.02

2609

5

java在线网站
java在线网站

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

2023.08.03

19931

3

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

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

2023.08.03

1175

8

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133.4万人学习