使用@SpringBootTest的集成测试不是选择使用spring.factories配置的库的自动配置

Question

我们有一个库，为了自动配置库，我们使用spring.factories文件（src/main/resources/META-INF），它提供了自动配置我的库的类。

参考资料 ： https://docs.spring.io/spring-boot/docs/1.4.0.M3/reference/htmlsingle/#boot-features-custom-starter

我在spring.factories文件中有以下配置：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.x.y.PubSubConfig

我的理解是spring.factories是配置库和服务器用途的替代方法，类似于在普通应用程序中@SpringBootApplication。

我正在使用@SpringBootTest进行集成，我希望我的上下文可以从spring.factories提供的配置类中配置。当我运行这些测试时，spring并不识别spring。工厂并抛出一个错误

java.lang.IllegalStateException：找不到@SpringBootConfiguration，您需要在测试中使用@ContextConfiguration或@SpringBootTest（类=...）

• 如果我用SpringBootApplication注释我的PubSubConfig，那么我的集成测试运行得非常好，但由于它是一个库，我不想这样做。
• 如果我专门使用@SpringBootTest（class=PubSubConfig.class）提供我的配置类，我的测试运行良好。

现在我试图理解为什么我需要专门做上述任何一个，因为spring.factories负责做我的自动配置

Answer 1

在任何Spring Boot自动配置问题中，我建议将debug：true property添加到appplication.yaml。这会导致额外的调试日志，显示哪些自动配置类被选取（具有匹配的条件）和哪些未被选取。在后一种情况下，它显示哪些条件不匹配。

这是一篇关于此的好文章：https://www.baeldung.com/spring-boot-auto-configuration-report

Answer 2

@SpringBootTest旨在测试Spring Boot应用程序。在没有任何其他配置的情况下，它会查找用@SpringBootConfiguration注释或元注释的类。通常，这是您的应用程序的主类，它用@SpringBootApplication注释（它用@SpringBootConfiguration元注释。@SpringBootApplication也用@EnableAutoConfiguration元注释，因此当@SpringBootTest找到@SpringBootApplication-注释的类自动配置为测试启用，就像执行应用程序本身时一样。

当您试图测试您的自动配置时，没有用< code > @ spring boot configuration 注释的类，所以您会看到这个失败:

java.lang.IllegalStateException：找不到@SpringBootConfiguration，您需要在测试中使用@ContextConfiguration或@SpringBootTest（类=...）

正如您所提到的，您可以通过用< code > @ spring boot application 注释< code>PubSubConfig来解决这个问题，但是您不应该这样做，因为它是一个库。< code > @ spring boot test(classes = pubsubonconfig . class)是一个更好的解决方案，因为它避免了更改库的主代码，但是它仍然不理想，因为< code>@SpringBootTest实际上旨在测试Spring Boot应用程序，而不是旨在用于Spring Boot应用程序的库。

与其使用< code>@SpringBootTest，我建议使用< code > ApplicationContextRunner 。顾名思义，它是为运行应用程序上下文而设计的。它为配置自动配置和用户配置提供了构建器方法，应该使用这些方法来创建上下文、设置属性等。它还提供了一个可断言的应用程序上下文，允许您轻松地检查预期的bean是否已经定义。它在Spring Boot自己的自动配置测试中被广泛使用。

这里有一个来自Spring Boot自己的< code>DataSource自动配置测试的例子:

private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
        .withConfiguration(AutoConfigurations.of(DataSourceAutoConfiguration.class))
        .withPropertyValues("spring.datasource.initialization-mode=never",
                "spring.datasource.url:jdbc:hsqldb:mem:testdb-" + new Random().nextInt());

@Test
public void testDefaultDataSourceExists() {
    this.contextRunner.run((context) -> assertThat(context).hasSingleBean(DataSource.class));
}