Spring Cloud Contract自定义Pact Broker客户端Stub生成器无法运行排查

我之前也碰到过类似的坑，Pact的StubGenerator加载机制有时候容易因为细节没做好导致失效，结合你的场景，咱们一步步排查和解决：

1. 检查spring.factories的配置准确性 #

Pact是通过Spring SPI机制发现自定义StubGenerator实现的，所以这个文件的路径和内容必须丝毫不差：

• 路径要放在**src/main/resources/META-INF/**下（如果是测试代码则放在src/test/resources/META-INF/），别写错路径层级
• 文件内容必须严格遵循格式，接口全类名不能写错：

  au.com.dius.pact.provider.stubgenerator.StubGenerator=你的自定义生成器全类名，比如com.xxx.stub.CustomPactStubGenerator
  

  很多人栽在包名拼写错误上，一定要核对Pact版本对应的接口全类名（如果是Pact 4.x以前的版本，接口包名可能是au.com.dius.pact.core.stubgenerator）

2. 确保自定义生成器的类路径被Gradle任务识别 #

如果你的自定义生成器是在单独模块或测试模块里，要保证generateClientStubs任务能访问到这个类：

• 若在主模块，确认sourceSets.main.output已被包含在任务类路径中
• 若在测试模块，需要手动调整Gradle任务的类路径：

  pact {
    generateClientStubs {
      classpath += sourceSets.test.output
    }
  }
  

3. 显式指定Gradle任务使用自定义生成器 #

有时候默认的SPI扫描可能会有遗漏，你可以在build.gradle里强制指定生成器：

pact {
  generateClientStubs {
    // 单个生成器
    generator = 'com.xxx.stub.CustomPactStubGenerator'
    // 多个生成器（比如保留默认的WireMock生成器+自定义生成器）
    generators = ['com.xxx.stub.CustomPactStubGenerator', 'au.com.dius.pact.provider.stubgenerator.DslToWireMockClientConverter']
  }
}

这种方式能绕过SPI扫描的不确定性，直接让任务加载你的实现。

4. 检查Pact插件版本与接口兼容性 #

不同版本的Pact Gradle插件对StubGenerator的方法签名要求可能不同：

• 确认你的实现类完全匹配当前插件版本的接口方法，比如最新版本的核心方法是：

  void generate(Map<String, Object> context, File outputDir, Pact pact) throws IOException;
  

• 如果是旧版本插件，接口的方法参数或返回值可能有差异，需要对应调整实现逻辑

5. 调试SPI加载过程 #

如果以上都没解决，可以加日志排查SPI是否加载到了你的类：

• 创建一个logging.properties文件，开启ServiceLoader的调试日志：

  handlers=java.util.logging.ConsoleHandler
  java.util.logging.ConsoleHandler.level=FINE
  au.com.dius.pact.provider.stubgenerator.level=FINE
  

• 运行任务时带上日志参数：./gradlew generateClientStubs -Djava.util.logging.config.file=logging.properties
• 查看日志里是否有加载你自定义生成器的记录，如果没有，回到第一步检查spring.factories的配置

6. 确认自定义生成器的实现无初始化问题 #

最后，确保你的生成器类是public的，且构造方法无参（SPI加载要求），可以在构造方法里加个日志输出，验证是否被实例化：

public class CustomPactStubGenerator implements StubGenerator {
  public CustomPactStubGenerator() {
    System.out.println("自定义Stub生成器已初始化！");
  }

  @Override
  public void generate(Map<String, Object> context, File outputDir, Pact pact) throws IOException {
    // 你的自定义Stub生成逻辑
  }
}

如果运行任务时能看到这个输出，说明生成器已被加载，只是业务逻辑需要调整；如果看不到，还是加载环节的问题。

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