如何使用 @ConfigurationProperties 和 @Autowired 测试类

Question

我想测试依赖于加载有@Autowired 和@ConfigurationProperties 的属性的应用程序的一小部分。我正在寻找一种仅加载所需属性而不总是加载整个ApplicationContext 的解决方案。 这里作为简化示例：

@TestPropertySource(locations = "/SettingsTest.properties")
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {TestSettings.class, TestConfiguration.class})
public class SettingsTest {
    @Autowired
    TestConfiguration config;

    @Test
    public void testConfig(){
        Assert.assertEquals("TEST_PROPERTY", config.settings().getProperty());
    }
}

配置类：

public class TestConfiguration {
    @Bean
    @ConfigurationProperties(prefix = "test")
    public TestSettings settings (){
        return new TestSettings();
    }
}

设置类：

public class TestSettings {
    private String property;

    public String getProperty() {
        return property;
    }

    public void setProperty(String property) {
        this.property = property;
    }
}

资源文件夹中的属性文件包含条目：

test.property=TEST_PROPERTY

在我当前的设置中，配置不为空，但没有可用的字段。 字段不是字段的原因应该与我没有使用 Springboot 而是使用 Spring 的事实有关。 那么 Springboot 的运行方式是什么？

编辑： 我想这样做的原因是：我有一个解析文本文件的解析器，使用的正则表达式存储在一个属性文件中。 为了对此进行测试，我只想加载此解析器所需的属性，这些属性位于 TestSettings 上方的示例中。

在阅读 cmets 时，我已经注意到这不再是单元测试了。然而，为这个小测试使用完整的 Spring 引导配置对我来说似乎有点太多了。这就是为什么我问是否有可能只加载一个具有属性的类。

Answer 1

您需要使用 @EnableConfigurationProperties 注释您的 TestConfiguraion，如下所示：

@EnableConfigurationProperties
public class TestConfiguration {

    @Bean
    @ConfigurationProperties(prefix = "test")
    public TestSettings settings (){
        return new TestSettings();
    }
}

另外你只需要在@ContextConfigurationSettingsTest类中包含TestConfiguration.class：

@TestPropertySource(locations = "/SettingsTest.properties")
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = TestConfiguration.class)
public class SettingsTest {
...

Answer 2

几点：

1. 您的主包中不需要“TestConfiguration”类，因为它所做的只是配置“TestSettings”bean。您可以简单地通过注释 TestSettings 类本身来做到这一点。

2. 通常您会使用 @SpringApplicationConfiguration 注释加载测试所需的上下文，并传递您的应用程序类的名称。但是，您说您不想加载整个 ApplicationContext（尽管不清楚为什么），因此您需要创建一个特殊的配置类来仅为测试加载。下面我将其称为“TestConfigurationNew”，以避免与您最初拥有的 TestConfiguration 类混淆。

3. 在Spring Boot的世界里，所有的属性一般都保存在“application.properties”文件中；但可以将它们存储在其他地方。下面，我指定了您建议的“SettingsTest.properties”文件。请注意，您可以拥有此文件的两份副本，一份在 main/resources 文件夹中，一份在 test/resources 文件夹中用于测试。

修改代码如下：

TestSettings.java（在主包中）

@Configuration
@ConfigurationProperties(prefix="test", locations = "classpath:SettingsTest.properties")
public class TestSettings {

    private String property;

    public String getProperty() {
        return property;
    }

    public void setProperty(String property) {
        this.property = property;
    }
}

SettingsTest.java（在测试包中）

@TestPropertySource(locations="classpath:SettingsTest.properties")
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = TestConfigurationNew.class)
public class SettingsTest {

    @Autowired
    TestSettings settings;

    @Test
    public void testConfig(){
        Assert.assertEquals("TEST_PROPERTY", settings.getProperty());
    }
}

TestConfigurationNew.java（在测试包中）：

@EnableAutoConfiguration
@ComponentScan(basePackages = { "my.package.main" })
@Configuration
public class TestConfigurationNew {
}

现在应该可以按照您想要的方式工作了。

Answer 3

您实际上可以直接将@EnableConfigurationProperties 添加到您的@SpringBootTest。
例如：

@ActiveProfiles("test")
@RunWith(SpringRunner.class)
@SpringBootTest(classes = TestConfiguration.class)
@EnableConfigurationProperties
...

Answer 4

如果你使用 Spring Boot，现在你只需要：

@RunWith(SpringRunner.class)
@SpringBootTest

没有额外的@ContextConfiguration，没有额外的课程只用于EnableAutoConfiguration和EnableConfigurationProperties的测试。您不必指定要加载的配置类，它们都会被加载。

但是，请确保您要在main/resources/application.yml 中读取的属性条目也存在于test/resources/application.yml 中。重复是不可避免的。

---

另一种方式是：

1. 在同一级别定义一个仅用于测试的配置类以及MyApplicationTest.java。此类可以为空。

喜欢：

@EnableAutoConfiguration
@EnableConfigurationProperties(value = {
        ConnectionPoolConfig.class
})
public class MyApplicationTestConfiguration {
}

1. 并且，在类中加载自动装配的配置。

喜欢：

@RunWith(SpringRunner.class)
//@SpringBootTest // the first, easy way
@ContextConfiguration(classes = MyApplicationTestConfiguration.class,
        initializers = ConfigFileApplicationContextInitializer.class)
public class ConnectionPoolConfigTest {

    @Autowired
    private ConnectionPoolConfig config;

基本上，你：

• 对@EnableConfigurationProperties和@EnableAutoConfiguration使用特定配置，列出你要加载的所有@ConfigurationProperties文件
• 在测试类中，加载这个测试配置文件，使用Spring定义的初始化类加载application.yml文件。

然后，将要加载的值放入test/resources/application.yml。重复是不可避免的。如果您需要加载另一个文件，请使用带有位置的@TestProperties()。 注意：@TestProperties 仅支持.properties 文件。

---

两种方式都适用于配置类加载值

• 来自application.yml/application.properties
• 或来自另一个属性文件，由PropertySource 指定，如@PropertySource(value = "classpath:threadpool.properties")

---

重要

Spring 文档的最后注释，根据 here

有些人使用 Project Lombok 来自动添加 getter 和 setter。确保 Lombok 不会为此类类型生成任何特定的构造函数，因为容器会自动使用它来实例化对象。

最后，只考虑标准 Java Bean 属性，不支持绑定静态属性。

这意味着，如果你有lombok.@Builder 没有@NoArgsConstructor 或@AllArgsConstructor，属性注入将不会发生，因为它只看到@Builder 创建的不可见构造函数。因此，请务必不使用或全部使用这些注释！

Answer 5

单元测试

为了避免加载 Spring 上下文，我们可以使用 Binder 类，它也是 Spring 的 used internally。

// A map of my properties.
Map<String, String> properties = new HashMap<>();
properties.put("my-prefix.first-property", "foo");
properties.put("my-prefix.second-property", "bar");

// Creates a source backed by my map, you can chose another type of source as needed.
ConfigurationPropertySource source = new MapConfigurationPropertySource(properties)

// Binds my properties to a class that maps them.
Binder binder = new Binder(source);
BindResult<MyConfiguration> result = binder.bind("my-prefix", MyConfiguration.class);

// Should return true if bound successfully.
Assertions.assertTrue(result.isBound);

// Asserts configuration values.
MyConfiguration config = result.get();
Assertions.assertEquals("foo", config.getFirstProperty());
Assertions.assertEquals("bar", config.getSecondProperty());