如何为Spock测试添加AAA模式合规检查的最优方案？

核心方案：利用Spock原生扩展机制 #

不用折腾正则或复杂AST分析，直接基于Spock提供的生命周期监听接口，就能精准实现AAA规则校验，同时支持豁免注解。

具体实现步骤 #

1. 定义豁免注解 #

先写一个简单的运行时注解，用于标记不需要校验的测试方法：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@interface AAAPatternViolation {
    String reason() default ""
}

2. 实现Spock扩展类 #

通过IGlobalExtension和ISpecListener接口，在测试执行前解析每个测试方法的块结构：

class AAAEnforcementExtension implements IGlobalExtension, ISpecListener {
    @Override
    void visitSpec(SpecInfo spec) {
        spec.allFeatures.each { feature ->
            // 跳过标记豁免注解的测试
            if (feature.featureMethod.getAnnotation(AAAPatternViolation)) {
                return
            }
            
            def blocks = feature.blocks
            // 校验块数量和类型顺序：必须是given(setup)、when、then
            if (blocks.size() != 3 || 
                blocks[0].kind != BlockKind.SETUP || 
                blocks[1].kind != BlockKind.WHEN || 
                blocks[2].kind != BlockKind.THEN) {
                throw new IllegalArgumentException(
                    "测试方法 ${feature.name} 违反AAA规则：必须仅包含given、when、then三个区段"
                )
            }
            
            // 校验when块恰好一行代码
            if (blocks[1].statements.size() != 1) {
                throw new IllegalArgumentException(
                    "测试方法 ${feature.name} 的when区段必须恰好一行代码"
                )
            }
        }
    }
}

3. 注册扩展 #

在测试资源目录下创建META-INF/services/org.spockframework.runtime.extension.IGlobalExtension文件，添加扩展类的全限定名：

com.yourteam.extensions.AAAEnforcementExtension

遗留测试迁移方案 #

• 对暂时无法重构的遗留测试，直接在方法上添加@AAAPatternViolation(reason = "遗留代码，待Q3重构")即可跳过校验
• 可以通过静态代码扫描工具统计带该注解的方法，跟踪重构进度

方案优势 #

• 比正则/文本分析靠谱：直接基于Spock内部的SpecInfo和Block模型，能准确识别Spock的块结构，不会因为格式缩进、注释等误判
• 比Groovy AST分析简单：不需要处理复杂的AST节点，借助Spock已封装好的API，实现成本低，代码易维护

内容的提问来源于stack exchange，提问作者Michael