Spring Boot单元测试无法加载application-local.yml配置的环境变量如何解决

问题根因 #

单元测试默认不会主动激活local配置文件，且如果测试未启动Spring上下文时，@Value注解不会触发注入逻辑，哪怕你配置了默认值，对应的属性仍然是null，调用时就会抛出空指针异常。

可选解决方案 #

方案1：启动Spring测试上下文并激活local配置（适合集成测试场景） #

在测试类上添加如下注解，加载Spring上下文同时激活local配置，自动注入@Value修饰的属性：

• JUnit5 写法：

@SpringBootTest
@ActiveProfiles("local")
@ExtendWith(SpringExtension.class)
public class ServiceTest {
    @Autowired
    private Service service;

    @Test
    public void testFunctionA() {
        Assertions.assertEquals(25, service.FunctionA());
    }
}

• JUnit4 写法将@ExtendWith(SpringExtension.class)替换为@RunWith(SpringRunner.class)即可。

方案2：轻量单元测试手动赋值（不需要启动Spring上下文，执行速度更快） #

如果只是做单纯的单元测试，不需要加载Spring容器，可以直接用ReflectionTestUtils给属性赋值，跳过配置读取的步骤：

public class ServiceTest {
    private Service service = new Service();

    @Test
    public void testFunctionA() {
        // 手动给@Value修饰的属性赋值
        ReflectionTestUtils.setField(service, "maxima", 24);
        Assertions.assertEquals(25, service.FunctionA());
    }
}

方案3：通过@TestPropertySource指定测试配置 #

如果不想激活local配置，也可以在测试类上直接指定测试用的属性：

@SpringBootTest
@TestPropertySource(properties = {"variables.maxVal=24"})
@ExtendWith(SpringExtension.class)
public class ServiceTest {
    // 测试逻辑同方案1
}

注意事项 #

你当前代码的@Value中已经配置了默认值24，但该默认值只有在Spring上下文启动、且没有找到对应配置的情况下才会生效。如果没有启动Spring上下文，@Value注解不会被处理，属性默认值不会自动赋值，仍然会是null。

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