Springboot单元测试无法读取配置文件的解决方案

当我们进行SpringBoot单元测试时，可能遇到读取配置文件的问题。这是因为测试程序并非完全模拟真实环境，需要特殊处理才能读取我们在配置文件中设置的值。下面，我将提供两种解决方案。

方案一：使用@ActiveProfiles注解

问题描述

在测试类中，我们使用注解 @SpringBootTest 和 @RunWith(SpringRunner.class) 来指定测试注入的环境。在项目中，我们通常会在 src/main/resources 中存放应用程序的配置文件，如 application.yml 或 application.properties。然而，当我们尝试在测试类中读取这些文件中的配置信息时，可能会遇到无法读取的情况。

解决方案

这时，我们可以使用 @ActiveProfiles 注解来激活测试环境或者指定加载的配置文件。

1. 激活测试环境

如果你采用了默认的文件名 application.yml 或 application.properties，那么只需要在测试类上添加 @ActiveProfiles 注解即可：

@RunWith(SpringRunner.class)
@SpringBootTest
@ActiveProfiles("test")
public class MyServiceTest {

    // ...
}

这里，我们传递了 "test" 参数给 @ActiveProfiles 注解，表示使用 application-test.yml 或 application-test.properties 中的配置信息。

1. 指定配置文件

如果你自定义了文件名，可以将文件名作为参数传递给 @ActiveProfiles 注解：

@RunWith(SpringRunner.class)
@SpringBootTest
@ActiveProfiles("test-db-config")
public class MyServiceTest {

    // ...
}

这里，我们假设有一个 application-test-db-config.yml 文件存放了测试数据库的相关配置信息。

在使用 @ActiveProfiles 注解时，要注意文件名和注解的参数需要对应，否则测试程序并不能正确读取相应的配置文件。

方案二：使用@PropertySource注解

问题描述

有时，@ActiveProfiles 注解无法满足我们的需求，比如，我们可能希望在一个单独的 Spring 上下文中加载更多的配置文件。例如，在单元测试中同时读取多个配置文件。

解决方案

针对这种情况，我们可以使用 @PropertySource 注解，从而加载指定的配置文件。例如：

@RunWith(SpringRunner.class)
@SpringBootTest
@PropertySource(value = {"classpath:test-application.properties"})
public class MyServiceTest {

    // ...
}

这里，我们使用 @PropertySource 注解，指向了项目中 src/test/resources 目录下的 test-application.properties 配置文件。需要注意的是，文件名和注解的参数一定要对应，否则我们的测试程序也无法正确读取配置信息。

总结

无论选择哪种方案，我们需注意其应用范围和使用方法。一般情况下，我们应先尝试使用 @ActiveProfiles 注解，如果无法满足需求，再考虑使用 @PropertySource 注解。

另外，有时我们也可以通过直接通过系统环境变量或者 Spring 的 SystemProperties 系统属性读取配置信息，具体方式可以参考官方文档。