321

我正在尝试为我的程序中用于验证表单的简单 bean 编写单元测试。bean 带有注释，@Component并具有一个使用初始化的类变量

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

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

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

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

4

10 回答 10

261

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

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

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

于 2013-06-28T00:55:06.853 回答
233

org.springframework.test.context.TestPropertySource从 Spring 4.1 开始，您可以通过在单元测试类级别上使用注释在代码中设置属性值。您甚至可以使用这种方法将属性注入依赖的 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();
    }

  }

}

注意：必须org.springframework.context.support.PropertySourcesPlaceholderConfigurer在 Spring 上下文中有实例

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

在 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);
  }

}
于 2017-01-31T17:54:30.403 回答
127

不要通过反射滥用私有字段获取/设置

在这里的几个答案中使用反射是我们可以避免的。
它在这里带来了很小的价值，同时也带来了多个缺点：

  • 我们仅在运行时检测反射问题（例如：不再存在的字段）
  • 我们想要封装，而不是一个不透明的类，它隐藏了应该可见的依赖项，并使类更不透明且更难测试。
  • 它鼓励糟糕的设计。今天你声明一个@Value String field. 明天你可以在那个类中声明它们，你5甚至10可能不会直接意识到你减少了类的设计。使用更直观的方法来设置这些字段（例如构造函数），您在添加所有这些字段之前会三思而后行，您可能会将它们封装到另一个类中并使用@ConfigurationProperties.

使您的课程在统一和集成方面都可测试

为了能够为您的 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(){
      ...
   }
}

集成测试示例

由于以下属性，您可以使用 Spring Boot 以这种简单的方式在上下文中注入properties属性@SpringBootTest ：

@SpringBootTest(properties="property.value=dummyValue")
public class FooTest{
    
   @Autowired
   Foo foo;
     
   @Test
   public void doThat(){
       ...
   }    
}

您可以使用作为替代方案 @TestPropertySource，但它添加了一个额外的注释：

@SpringBootTest
@TestPropertySource(properties="property.value=dummyValue")
public class FooTest{ ...}

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

附带说明：如果您@Value要设置许多字段，则将它们提取到带有注释的类@ConfigurationProperties中更为相关，因为我们不希望构造函数具有太多参数。

于 2018-08-12T16:27:27.623 回答
56

如果需要，您仍然可以在 Spring 上下文中运行测试并在 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 runner。在这种情况下，您根本不需要在 Spring 中运行测试，这更加清晰和简单。

于 2014-11-20T11:53:03.420 回答
32

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

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

// Optionally:
@AfterClass
public static void afterClass() {
    System.clearProperty("some.property");
}
于 2015-08-10T06:03:13.123 回答
5

在配置中添加 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());
    }
}
于 2015-09-14T21:30:43.783 回答
3 
@ExtendWith(SpringExtension.class)    // @RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(initializers = ConfigDataApplicationContextInitializer.class)

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

于 2021-02-07T20:46:31.117 回答
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 而自己创建所有对象。

于 2020-12-30T14:02:42.207 回答
0

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

我使用@ExtendWith({SpringExtension.class})and@ContextConfiguration(classes = {RabbitMQ.class, GenericMapToObject.class, ModelMapper.class, StringUtils.class})用于外部配置

于 2021-01-14T04:05:12.633 回答
-6

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 文档，您会发现数以千计的操作系统方法可以做到这一点。

于 2020-07-24T12:53:35.250 回答