在单元测试期间填充Spring @Value

时间：2013-06-27 21:14:42

标签： java spring junit spring-annotations

我正在尝试为我的程序中用于验证表单的简单bean编写单元测试。该bean使用@Component进行注释，并具有使用@Value("${this.property.value}") private String thisProperty;初始化的类变量

我想为这个类中的验证方法编写单元测试，但是，如果可能的话，我想在不使用属性文件的情况下这样做。我的理由是，如果我从属性文件中提取的值发生变化，我希望这不会影响我的测试用例。我的测试用例是测试验证值的代码，而不是值本身。

有没有办法在我的测试类中使用Java代码来初始化Java类并在该类中填充Spring @Value属性然后使用它来测试？

我确实发现这个似乎很接近的How To，但仍使用属性文件。我宁愿一切都是Java代码。

由于

10 个答案:

答案 0 :(得分：152)

如果可能，我会尝试在没有Spring Context的情况下编写这些测试。如果你在没有弹簧的测试中创建这个类，那么你可以完全控制它的字段。

要设置@value字段，您可以使用Springs ReflectionTestUtils - 它有一个方法setField来设置私有字段。

@see JavaDoc: ReflectionTestUtils.setField(java.lang.Object, java.lang.String, java.lang.Object)

答案 1 :(得分：130)

从Spring 4.1开始，您可以使用单元测试类级别上的org.springframework.test.context.TestPropertySource注释在代码中设置属性值。即使将属性注入到依赖的bean实例中，也可以使用此方法

例如

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = FooTest.Config.class)
@TestPropertySource(properties = {
    "some.bar.value=testValue",
})
public class FooTest {

  @Value("${some.bar.value}")
  String bar;

  @Test
  public void testValueSetup() {
    assertEquals("testValue", bar);
  }


  @Configuration
  static class Config {

    @Bean
    public static PropertySourcesPlaceholderConfigurer propertiesResolver() {
        return new PropertySourcesPlaceholderConfigurer();
    }

  }

}

注意：在Spring上下文中拥有org.springframework.context.support.PropertySourcesPlaceholderConfigurer的实例是必要的

编辑24-08-2017：如果您使用的是SpringBoot 1.4.0及更高版本，则可以使用@SpringBootTest和@SpringBootConfiguration注释初始化测试。更多信息here

对于SpringBoot，我们有以下代码

@SpringBootTest
@SpringBootConfiguration
@RunWith(SpringJUnit4ClassRunner.class)
@TestPropertySource(properties = {
    "some.bar.value=testValue",
})
public class FooTest {

  @Value("${some.bar.value}")
  String bar;

  @Test
  public void testValueSetup() {
    assertEquals("testValue", bar);
  }

}

答案 2 :(得分：46)

如果需要，您仍然可以在Spring Context中运行测试，并在Spring配置类中设置所需的属性。如果您使用JUnit，请使用SpringJUnit4ClassRunner并为您的测试定义专用配置类：

受测试的课程：

@Component
public SomeClass {

    @Autowired
    private SomeDependency someDependency;

    @Value("${someProperty}")
    private String someProperty;
}

测试类：

@RunWith(SpringJUnit4ClassRunner.class) 
@ContextConfiguration(classes = SomeClassTestsConfig.class)
public class SomeClassTests {

    @Autowired
    private SomeClass someClass;

    @Autowired
    private SomeDependency someDependency;

    @Before
    public void setup() {
       Mockito.reset(someDependency);

    @Test
    public void someTest() { ... }
}

此测试的配置类：

@Configuration
public class SomeClassTestsConfig {

    @Bean
    public static PropertySourcesPlaceholderConfigurer properties() throws Exception {
        final PropertySourcesPlaceholderConfigurer pspc = new PropertySourcesPlaceholderConfigurer();
        Properties properties = new Properties();

        properties.setProperty("someProperty", "testValue");

        pspc.setProperties(properties);
        return pspc;
    }
    @Bean
    public SomeClass getSomeClass() {
        return new SomeClass();
    }

    @Bean
    public SomeDependency getSomeDependency() {
        // Mockito used here for mocking dependency
        return Mockito.mock(SomeDependency.class);
    }
}

话虽如此，我不推荐这种方法，我只是在这里添加它以供参考。在我看来，更好的方法是使用Mockito跑步者。在这种情况下，你根本不在Spring内部运行测试，这更加清晰和简单。

答案 3 :(得分：27)

这似乎有效，虽然仍然有点冗长（我还想要更短的东西）：

@BeforeClass
public static void beforeClass() {
    System.setProperty("some.property", "<value>");
}

// Optionally:
@AfterClass
public static void afterClass() {
    System.clearProperty("some.property");
}

答案 4 :(得分：13)

使您的课程在单一课程和集成课程中都可以测试

要能够为Spring组件类编写普通的单元测试（即没有运行的Spring容器）和集成测试，必须使该类在有或没有Spring的情况下都可用。
不需要在单元测试中运行容器的不良做法会减慢本地构建的速度：您不希望这样做。
我添加了此答案，因为此处似乎没有答案显示出这种区别，因此它们系统地依赖运行中的容器。

所以我认为您应该将此属性定义为类的内部：

@Component
public class Foo{   
    @Value("${property.value}") private String property;
    //...
}

放入Spring将注入的构造函数参数：

@Component
public class Foo{   
    private String property;

    public Foo(@Value("${property.value}") String property){
       this.property = property;
    }

    //...         
}

单元测试示例

由于没有构造函数，您可以在不使用Spring的情况下实例化Foo并为property注入任何值：

public class FooTest{

   Foo foo = new Foo("dummyValue");

   @Test
   public void doThat(){
      ...
   }
}

集成测试示例

借助于properties的{​​{1}}属性，您可以通过Spring Boot以这种简单的方式在上下文中注入属性：

@SpringBootTest

您可以使用@SpringBootTest(properties="property.value=dummyValue") public class FooTest{ @Autowired Foo foo; @Test public void doThat(){ ... } } 作为替代，但它会添加一个附加注释：

@TestPropertySource

在使用Spring（没有Spring Boot）的情况下，它应该稍微复杂一些，但是由于很长一段时间以来我一直没有使用没有Spring Boot的Spring，所以我不喜欢说愚蠢的话。

答案 5 :(得分：4)

在配置中添加PropertyPlaceholderConfigurer对我有用。

@Configuration
@ComponentScan
@EnableJpaRepositories
@EnableTransactionManagement
public class TestConfiguration {
    @Bean
    public DataSource dataSource() {
        EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder();
        builder.setType(EmbeddedDatabaseType.DERBY);
        return builder.build();
    }

    @Bean
    public LocalContainerEntityManagerFactoryBean entityManagerFactory() {
        LocalContainerEntityManagerFactoryBean entityManagerFactoryBean = new LocalContainerEntityManagerFactoryBean();
        entityManagerFactoryBean.setDataSource(dataSource());
        entityManagerFactoryBean.setPackagesToScan(new String[] { "com.test.model" });
        // Use hibernate
        JpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();
        entityManagerFactoryBean.setJpaVendorAdapter(vendorAdapter);
        entityManagerFactoryBean.setJpaProperties(getHibernateProperties());
        return entityManagerFactoryBean;
    }

    private Properties getHibernateProperties() {
        Properties properties = new Properties();
        properties.put("hibernate.show_sql", "false");
        properties.put("hibernate.dialect", "org.hibernate.dialect.DerbyDialect");
        properties.put("hibernate.hbm2ddl.auto", "update");
        return properties;
    }

    @Bean
    public JpaTransactionManager transactionManager() {
        JpaTransactionManager transactionManager = new JpaTransactionManager();
         transactionManager.setEntityManagerFactory(
              entityManagerFactory().getObject()
         );

         return transactionManager;
    }

    @Bean
    PropertyPlaceholderConfigurer propConfig() {
        PropertyPlaceholderConfigurer placeholderConfigurer = new PropertyPlaceholderConfigurer();
        placeholderConfigurer.setLocation(new ClassPathResource("application_test.properties"));
        return placeholderConfigurer;
    }
}

在测试课程中

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = TestConfiguration.class)
public class DataServiceTest {

    @Autowired
    private DataService dataService;

    @Autowired
    private DataRepository dataRepository;

    @Value("${Api.url}")
    private String baseUrl;

    @Test
    public void testUpdateData() {
        List<Data> datas = (List<Data>) dataRepository.findAll();
        assertTrue(datas.isEmpty());
        dataService.updateDatas();
        datas = (List<Data>) dataRepository.findAll();
        assertFalse(datas.isEmpty());
    }
}

答案 6 :(得分：2)

这是一个很老的问题，我不确定当时它是否是一个选项，但这就​​是为什么我总是更喜欢构造函数而不是值的DependencyInjection的原因。

我可以想象你的类可能是这样的：

class ExampleClass{

   @Autowired
   private Dog dog;

   @Value("${this.property.value}") 
   private String thisProperty;

   ...other stuff...
}

您可以将其更改为：

class ExampleClass{

   private Dog dog;
   private String thisProperty;

   //optionally @Autowire
   public ExampleClass(final Dog dog, @Value("${this.property.value}") final String thisProperty){
      this.dog = dog;
      this.thisProperty = thisProperty;
   }

   ...other stuff...
}

有了这个实现，spring 就知道要自动注入什么了，但是对于单元测试，你可以做任何你需要的。例如使用 spring 自动装配每个依赖项，并通过构造函数手动注入它们以创建“ExampleClass”实例，或者只使用带有测试属性文件的 spring，或者根本不使用 spring 并自己创建所有对象。

答案 7 :(得分：2)

@ExtendWith(SpringExtension.class)    // @RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(initializers = ConfigDataApplicationContextInitializer.class)

可能会有所帮助。关键是 ConfigDataApplicationContextInitializer 获取所有道具数据

答案 8 :(得分：0)

在 springboot 2.4.1 中，我刚刚在我的测试中添加了注释 @SpringBootTest，显然，在我的 spring.profiles.active = test 中设置了 src/test/resources/application.yml

我使用 @ExtendWith({SpringExtension.class}) 和 @ContextConfiguration(classes = {RabbitMQ.class, GenericMapToObject.class, ModelMapper.class, StringUtils.class}) 进行外部 confs

答案 9 :(得分：-4)

Spring Boot对我们执行了许多自动操作，但是当我们使用注释@SpringBootTest时，我们认为Spring Boot将自动解决所有问题。

有很多文档，但是最少的是选择一个引擎（@RunWith(SpringRunner.class)）并指出将用于创建上下文的类。加载配置（resources/applicationl.properties）。

以简单的方式，您需要引擎和上下文：

@RunWith(SpringRunner.class)
@SpringBootTest(classes = MyClassTest .class)
public class MyClassTest {

    @Value("${my.property}")
    private String myProperty;

    @Test
    public void checkMyProperty(){
        Assert.assertNotNull(my.property);
    }
}

当然，如果您查看Spring Boot文档，您会发现成千上万种操作方法。

相关问题
最新问题