@导入vs@ContextConfiguration用于在单元测试中导入bean

Question

我能够使用SpringBoot 1.5设置并成功运行三种不同的测试配置。3.

方法#1。使用注释导入Bean

@RunWith(SpringJUnit4ClassRunner.class)
@Import({MyBean.class})
public class MyBeanTest() {
    @Autowired
    private MyBean myBean;
}

方法#2。使用@ContextConfiguration注释导入Bean

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {MyBean.class})
public class MyBeanTest() {
    @Autowired
    private MyBean myBean;
}

方法#3（带内部类配置；基于官方博文）

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(loader=AnnotationConfigContextLoader.class)
public class MyBeanTest() {

    @Configuration
    static class ContextConfiguration {
        @Bean
        public MyBean myBean() {
            return new MyBean();
        }
    }

    @Autowired
    private MyBean myBean;

}

考虑到@Import注释文档

指示要导入的一个或多个{@link Configuration@Configuration}类。

事实上，MyBean不是一个配置类，而是一个用@Component注释注释的bean类，它看起来像方法1，这是不正确的。

从@ContextConfiguration留档

{@code@ContextConfiguration}定义用于确定如何加载和配置集成测试的{@linkorg.springframework.context.Application ationContext Application ationContext}的类级元数据。

听起来它更适用于单元测试，但仍然应该加载一种配置。

方法#1和#2更短更简单。方法#3看起来是正确的方法。

我说得对吗？我应该使用方法#3还有其他标准吗，比如性能或其他什么？

Answer 1

这实际上取决于您使用的是Spring Boot提供的测试注释之一，还是从头开始构建上下文。Spring框架中的核心支持要求您通过@ContextConfiguration提供“根配置”。如果您使用的是SpringBoot，它有自己的方法来检测要使用的根上下文。默认情况下，它找到的第一个@SpringBootConfiguration-注释类型。在典型的应用程序结构中，这是位于应用程序包根目录下的@springbootplication。

考虑到这一点，在设置中使用@ContextConfiguration不是一个好主意，因为它会禁用查找，并且不仅仅是“导入bean”。

假设已经为您创建了上下文，并且您希望添加其他bean，那么有两种主要方法：

如果您需要有选择地导入组件（除了检测要使用的正确上下文的默认行为之外），那么@import绝对可以。与此同时，@Import的Javadoc经过了润色，提到导入组件是绝对好的，它不是特定于@Configuration类的：

指示要导入的一个或多个组件类-通常为@Configuration类。

所以，方法#1绝对是正确的。

如果组件是测试的本地组件，并且您不需要与其他测试共享它，那么可以使用内部@TestConfiguration。参考指南中也记录了这一点。

Answer 2

如果使用选项3，实际上不需要指定加载器。从文档中，除了文档中的示例之外，您还可以覆盖环境。如果需要在环境中注入属性而不使用真实属性，请使用@TestPropertySource。

@RunWith(SpringRunner.class)
// ApplicationContext will be loaded from the
// static nested Config class
@ContextConfiguration
@TestPropertySource(properties = { "timezone = GMT", "port: 4242" })
public class OrderServiceTest {

    @Configuration
    static class Config {

        // this bean will be injected into the OrderServiceTest class
        @Bean
        public OrderService orderService() {
            OrderService orderService = new OrderServiceImpl();
            // set properties, etc.
            return orderService;
        }
    }

    @Autowired
    private OrderService orderService;

    @Test
    public void testOrderService() {
        // test the orderService
    }

}