如何编写ArchUnit规则校验@ComponentInterface接口方法的@Input参数注解
原规则错误根因
- 原实现调用的
haveRawParameterTypes方法,校验对象是方法形参对应的Java类型类对象,而非形参本身,传入的注解判断逻辑最终会落到校验String这类参数所属的类上,与我们要校验「形参本身是否带@Input注解」的目标完全错位。 - 该逻辑最终会试图校验JDK提供的
String类是否标注了@Input,自然会触发校验失败。
正确实现方案
通用兼容写法(适配所有ArchUnit 0.15+版本)
ArchRule rule = methods() .that() // 保持原有筛选逻辑:仅抓取标注了@ComponentInterface的接口内声明的方法 .areDeclaredInClassesThat() .areInterfaces() .and() .areDeclaredInClassesThat() .areAnnotatedWith(ComponentInterface.class) .should(new ArchCondition<>("所有方法参数必须标注@Input注解") { @Override public void check(JavaMethod method, ConditionEvents events) { // 遍历方法的每一个形参 method.getParameters().forEach(param -> { // 直接判断形参本身是否标注@Input,而非检查参数类型 if (!param.isAnnotatedWith(Input.class)) { String message = String.format( "方法%s的参数「%s %s」未标注@Input注解", method.getFullName(), param.getRawType().getName(), param.getName() ); events.add(SimpleConditionEvent.violated( method, message, method.getSourceCodeLocation() )); } }); } });
这种实现的优势:
- 完全绕开类型维度的校验,直接对准形参本身的注解进行检查,匹配实际校验目标
- 违规提示会明确定位到具体方法、具体缺失注解的参数,排查问题更高效
简化流式写法(适配ArchUnit 0.22+版本)
如果使用的是较新版本的ArchUnit,可借助内置的参数遍历能力简化代码,无需手动编写自定义条件类:
ArchRule rule = methods() .that() .areDeclaredIn(classes() .that().areAnnotatedWith(ComponentInterface.class) .and().areInterfaces() ) .should(conditions() .haveParametersThat(DescribedPredicate .describe("标注@Input注解", param -> param.isAnnotatedWith(Input.class) ) ) );
该写法的校验逻辑与通用兼容版本完全一致,代码更简洁易维护。
核心误区提醒:
@Input是加在方法形参上的标记注解,而非加在参数对应的业务类上,选择校验维度时必须对准JavaParameter对象,不能使用参数类型(JavaClass)维度的校验接口。
内容的提问来源于stack exchange,提问作者manuna
相关产品推荐
相关产品推荐

