如何实现仅可作用于递归方法的自定义@recurisve注解
自定义
@Recursive注解编译期校验实现方案 要实现和Java内置@Override一致的误用即编译报错的效果,核心方案是基于**编译期注解处理器(APT)**做静态代码扫描,不需要运行时逻辑介入,具体实现步骤如下:
1. 先修正注解的基础配置
首先调整你自定义注解的元注解参数,对齐@Override的配置逻辑:
// 提示:你当前命名的@recurisve存在拼写笔误,正确拼写为recursive,建议修正避免后续歧义 @Target(ElementType.METHOD) // 强制注解仅可作用于方法 @Retention(RetentionPolicy.SOURCE) // 注解仅保留在源码阶段,编译后不写入字节码,无运行时开销 public @interface Recursive { }
2. 实现注解处理器完成递归逻辑校验
在APT处理器中实现核心校验逻辑,流程如下:
- 编译阶段触发处理器,扫描所有源码中被
@Recursive标注的方法 - 解析每个方法对应的抽象语法树(AST),遍历方法体内的所有方法调用节点
- 按以下规则做合法性判定:
- 若方法体内存在对当前方法自身的直接调用(即直接递归场景),判定为合法使用
- 若需要覆盖同签名重载递归的场景,可以额外增加对同类同名、参数匹配方法调用的校验
- 对于A调B、B调A的间接递归、反射调用递归、Lambda间接递归等边缘场景,静态扫描无法100%精准识别,不需要强行覆盖,覆盖显式直接递归场景即可解决绝大多数手动标注误用问题
- 若遍历完整棵方法语法树都未找到符合要求的自调用逻辑,直接通过APT提供的
Messager接口抛出编译错误,阻断构建流程,错误信息可以明确提示「当前方法非递归方法,不可使用@Recursive注解」
3. 可选体验优化
如果需要实现和IDE原生@Override检查一致的编码实时飘红提示,可以基于你常用IDE的插件开发接口,复用上述校验逻辑做实时语法检查,不需要等到执行编译操作才提示错误。
常见避坑点
- 不要使用运行时反射实现校验:反射逻辑只能在程序启动运行后触发检查,无法实现编译期阻断的效果,和
@Override的使用体验差距极大 - 如果项目中已经引入Lombok,可以直接基于Lombok的AST扩展能力实现校验逻辑,不需要单独注册注解处理器,配置成本更低
- 不需要追求100%覆盖所有递归场景,只要能覆盖日常开发中最常见的显式直接递归场景,就可以彻底解决手动标注错漏的问题
内容的提问来源于stack exchange,提问作者Michel Beṭar
相关产品推荐
相关产品推荐

