spring - 将 Mockito 模拟注入 Spring bean

Question

为了使用 JUnit 进行单元测试，我想将 Mockito 模拟对象注入 Spring (3+) bean。@Autowired我的 bean 依赖项当前是通过使用私有成员字段上的注释来注入的。

我考虑过使用ReflectionTestUtils.setField，但我希望注入的 bean 实例实际上是一个代理，因此没有声明目标类的私有成员字段。我不希望为依赖项创建一个公共设置器，因为我将纯粹为了测试目的而修改我的接口。

我遵循了 Spring 社区给出的一些建议，但没有创建模拟并且自动连接失败：

<bean id="dao" class="org.mockito.Mockito" factory-method="mock">
    <constructor-arg value="com.package.Dao" />
</bean>

我目前遇到的错误如下：

...
Caused by: org...NoSuchBeanDefinitionException:
    No matching bean of type [com.package.Dao] found for dependency:
    expected at least 1 bean which qualifies as autowire candidate for this dependency.
    Dependency annotations: {
        @org...Autowired(required=true),
        @org...Qualifier(value=dao)
    }
at org...DefaultListableBeanFactory.raiseNoSuchBeanDefinitionException(D...y.java:901)
at org...DefaultListableBeanFactory.doResolveDependency(D...y.java:770)

如果我将constructor-arg值设置为无效值，则在启动应用程序上下文时不会发生错误。

score 134 · Accepted Answer

最好的方法是：

<bean id="dao" class="org.mockito.Mockito" factory-method="mock"> 
    <constructor-arg value="com.package.Dao" /> 
</bean>

更新
在上下文文件中，这个模拟必须在任何依赖于它的自动装配字段被声明之前列出。

score 117 · Accepted Answer

@InjectMocks
private MyTestObject testObject;

@Mock
private MyDependentObject mockedObject;

@Before
public void setup() {
        MockitoAnnotations.initMocks(this);
}

这会将任何模拟对象注入测试类。在这种情况下，它会将 mockedObject 注入到 testObject 中。这是上面提到的，但这里是代码。

score 65 · Accepted Answer

我有一个使用 Spring Java Config 和 Mockito 的非常简单的解决方案：

@Configuration
public class TestConfig {

    @Mock BeanA beanA;
    @Mock BeanB beanB;

    public TestConfig() {
        MockitoAnnotations.initMocks(this); //This is a key
    }

    //You basically generate getters and add @Bean annotation everywhere
    @Bean
    public BeanA getBeanA() {
        return beanA;
    }

    @Bean
    public BeanB getBeanB() {
        return beanB;
    }
}

score 55 · Accepted Answer

鉴于：

@Service
public class MyService {
    @Autowired
    private MyDAO myDAO;

    // etc
}

您可以通过自动装配加载正在测试的类，使用 Mockito 模拟依赖项，然后使用 Spring 的 ReflectionTestUtils 将模拟注入到正在测试的类中。

@ContextConfiguration(classes = { MvcConfiguration.class })
@RunWith(SpringJUnit4ClassRunner.class)
public class MyServiceTest {
    @Autowired
    private MyService myService;

    private MyDAO myDAOMock;

    @Before
    public void before() {
        myDAOMock = Mockito.mock(MyDAO.class);
        ReflectionTestUtils.setField(myService, "myDAO", myDAOMock);
    }

    // etc
}

请注意，在 Spring 4.3.1 之前，此方法不适用于代理后面的服务（例如@Transactional，使用或注释）。Cacheable这已由SPR-14050修复。

对于早期版本，解决方案是解包代理，如下所述：事务注释避免服务被模拟（这是ReflectionTestUtils.setField现在默认情况下所做的）

score 44 · Accepted Answer

如果您使用的是 Spring Boot 1.4，它有一种很棒的方法。只需@SpringBootTest在您的班级和@MockBean现场使用新品牌，Spring Boot 将创建这种类型的模拟，并将其注入上下文（而不是注入原始的）：

@RunWith(SpringRunner.class)
@SpringBootTest
public class MyTests {

    @MockBean
    private RemoteService remoteService;

    @Autowired
    private Reverser reverser;

    @Test
    public void exampleTest() {
        // RemoteService has been injected into the reverser bean
        given(this.remoteService.someCall()).willReturn("mock");
        String reverse = reverser.reverseSomeCall();
        assertThat(reverse).isEqualTo("kcom");
    }

}

另一方面，如果你没有使用 Spring Boot 或者你使用的是以前的版本，你将不得不做更多的工作：

创建一个@Configuration将你的模拟注入 Spring 上下文的 bean：

@Configuration
@Profile("useMocks")
public class MockConfigurer {

    @Bean
    @Primary
    public MyBean myBeanSpy() {
        return mock(MyBean.class);
    }
}

使用@Primary注释告诉spring 如果没有指定限定符，这个bean 具有优先级。

确保使用注释类@Profile("useMocks")以控制哪些类将使用模拟以及哪些将使用真实 bean。

最后，在您的测试中，激活userMocks配置文件：

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = {Application.class})
@WebIntegrationTest
@ActiveProfiles(profiles={"useMocks"})
public class YourIntegrationTestIT {

    @Inject
    private MyBean myBean; //It will be the mock!


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

如果您不想使用模拟但真正的 bean，请不要激活useMocks配置文件：

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = {Application.class})
@WebIntegrationTest
public class AnotherIntegrationTestIT {

    @Inject
    private MyBean myBean; //It will be the real implementation!


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

score 20 · Accepted Answer

自1.8.3 Mockito 以来@InjectMocks- 这非常有用。我的 JUnit 测试是@RunWith并且MockitoJUnitRunner我构建的@Mock对象满足被测试类的所有依赖项，这些对象都是在私有成员被注释时注入的@InjectMocks。

我@RunWith现在SpringJUnit4Runner只用于集成测试。

我会注意到它似乎无法List<T>以与 Spring 相同的方式注入。它只查找满足的 Mock 对象List，并且不会注入 Mock 对象列表。我的解决方法是@Spy对手动实例化的列表使用 a ，然后手动将模拟对象添加到该列表中以进行单元测试。也许这是故意的，因为它确实迫使我密切关注一起被嘲笑的东西。

score 14 · Accepted Answer

更新：现在有更好、更清洁的解决方案来解决这个问题。请先考虑其他答案。

我最终在他的博客上找到了 ronen 的答案。我遇到的问题是由于Mockito.mock(Class c)声明返回类型为Object. 因此 Spring 无法从工厂方法返回类型推断 bean 类型。

Ronen 的解决方案是创建一个FactoryBean返回模拟的实现。该FactoryBean接口允许 Spring 查询工厂 bean 创建的对象的类型。

我的模拟 bean 定义现在看起来像：

<bean id="mockDaoFactory" name="dao" class="com.package.test.MocksFactory">
    <property name="type" value="com.package.Dao" />
</bean>

score 12 · Accepted Answer

从 Spring 3.2 开始，这不再是问题。Spring 现在支持自动装配通用工厂方法的结果。请参阅此博客文章中标题为“通用工厂方法”的部分：http: //spring.io/blog/2012/11/07/spring-framework-3-2-rc1-new-testing-features/。

关键点是：

在 Spring 3.2 中，工厂方法的通用返回类型现在可以正确推断，并且模拟的按类型自动装配应该可以按预期工作。因此，可能不再需要 MockitoFactoryBean、EasyMockFactoryBean 或 Springockito 等自定义解决方法。

这意味着这应该开箱即用：

<bean id="dao" class="org.mockito.Mockito" factory-method="mock">
    <constructor-arg value="com.package.Dao" />
</bean>

score 9 · Accepted Answer

下面的代码适用于自动装配 - 它不是最短的版本，但当它只适用于标准 spring/mockito jar 时很有用。

<bean id="dao" class="org.springframework.aop.framework.ProxyFactoryBean">
   <property name="target"> <bean class="org.mockito.Mockito" factory-method="mock"> <constructor-arg value="com.package.Dao" /> </bean> </property>
   <property name="proxyInterfaces"> <value>com.package.Dao</value> </property>
</bean>

score 9 · Accepted Answer

如果您使用的是spring >= 3.0，请尝试使用 Springs@Configuration注释来定义部分应用程序上下文

@Configuration
@ImportResource("com/blah/blurk/rest-of-config.xml")
public class DaoTestConfiguration {

    @Bean
    public ApplicationService applicationService() {
        return mock(ApplicationService.class);
    }

}

如果您不想使用@ImportResource，也可以反过来：

<beans>
    <!-- rest of your config -->

    <!-- the container recognize this as a Configuration and adds it's beans 
         to the container -->
    <bean class="com.package.DaoTestConfiguration"/>
</beans>

有关更多信息，请查看 spring-framework-reference ：基于 Java 的容器配置

score 8 · Accepted Answer

也许不是完美的解决方案，但我倾向于不使用 spring 为单元测试做 DI。单个 bean（被测类）的依赖关系通常不会过于复杂，所以我只是直接在测试代码中进行注入。

score 7 · Accepted Answer

我可以使用 Mockito 执行以下操作：

<bean id="stateMachine" class="org.mockito.Mockito" factory-method="mock">
    <constructor-arg value="com.abcd.StateMachine"/>
</bean>

score 6 · Accepted Answer

基于上述方法发布一些示例

带弹簧：

@ContextConfiguration(locations = { "classpath:context.xml" })
@RunWith(SpringJUnit4ClassRunner.class)
public class TestServiceTest {
    @InjectMocks
    private TestService testService;
    @Mock
    private TestService2 testService2;
}

没有弹簧：

@RunWith(MockitoJUnitRunner.class)
public class TestServiceTest {
    @InjectMocks
    private TestService testService = new TestServiceImpl();
    @Mock
    private TestService2 testService2;
}

score 2 · Accepted Answer

看看Springockito 的开发速度和未解决问题的数量，我现在有点担心将它引入我的测试套件堆栈。事实上，上一个版本是在 Spring 4 发布之前完成的，这会引发诸如“是否可以轻松地将其与 Spring 4 集成？”之类的问题。我不知道，因为我没试过。如果我需要在集成测试中模拟 Spring bean，我更喜欢纯 Spring 方法。

可以选择仅使用普通 Spring 功能来伪造 Spring bean。您需要使用@Primary,@Profile和@ActiveProfiles注释。我写了一篇关于这个主题的博客文章。

score 2 · Accepted Answer

更新- 这里的新答案：https ://stackoverflow.com/a/19454282/411229 。此答案仅适用于 3.2 之前的 Spring 版本。

我已经寻找了一段时间来寻找更明确的解决方案。这篇博文似乎涵盖了我的所有需求，并且不依赖于 bean 声明的顺序。所有功劳归功于马蒂亚斯·塞弗森。 http://www.jayway.com/2011/11/30/spring-integration-tests-part-i-creating-mock-objects/

基本上，实现一个 FactoryBean

package com.jayway.springmock;

import org.mockito.Mockito;
import org.springframework.beans.factory.FactoryBean;

/**
 * A {@link FactoryBean} for creating mocked beans based on Mockito so that they 
 * can be {@link @Autowired} into Spring test configurations.
 *
 * @author Mattias Severson, Jayway
 *
 * @see FactoryBean
 * @see org.mockito.Mockito
 */
public class MockitoFactoryBean<T> implements FactoryBean<T> {

    private Class<T> classToBeMocked;

    /**
     * Creates a Mockito mock instance of the provided class.
     * @param classToBeMocked The class to be mocked.
     */
    public MockitoFactoryBean(Class<T> classToBeMocked) {
        this.classToBeMocked = classToBeMocked;
    }

    @Override
    public T getObject() throws Exception {
        return Mockito.mock(classToBeMocked);
    }

    @Override
    public Class<?> getObjectType() {
        return classToBeMocked;
    }

    @Override
    public boolean isSingleton() {
        return true;
    }
}

接下来使用以下内容更新您的 spring 配置：

<beans...>
    <context:component-scan base-package="com.jayway.example"/>

    <bean id="someDependencyMock" class="com.jayway.springmock.MockitoFactoryBean">
        <constructor-arg name="classToBeMocked" value="com.jayway.example.SomeDependency" />
    </bean>
</beans>

score 1 · Accepted Answer

<bean id="mockDaoFactory" name="dao" class="com.package.test.MocksFactory">
    <property name="type" value="com.package.Dao" />
</bean>

如果在 XML 文件中首先/早期声明，这个 ^ 工作得很好。Mockito 1.9.0/Spring 3.0.5

score 1 · Accepted Answer

我找到了一个与 teabot 类似的答案来创建一个提供模拟的 MockFactory。我使用以下示例创建模拟工厂（因为指向 narkisr 的链接已失效）： http ://hg.randompage.org/java/src/407e78aa08a0/projects/bookmarking/backend/spring/src/test/java/ org/randompage/bookmarking/backend/testUtils/MocksFactory.java

<bean id="someFacade" class="nl.package.test.MockFactory">
    <property name="type" value="nl.package.someFacade"/>
</bean>

这也有助于防止 Spring 想要解决来自模拟 bean 的注入。

score 1 · Accepted Answer

我结合了 Markus T 在回答中使用的方法和一个简单的帮助器实现，ImportBeanDefinitionRegistrar它寻找一个自定义注释 ( @MockedBeans)，可以在其中指定要模拟哪些类。我相信这种方法会产生一个简洁的单元测试，其中删除了一些与模拟相关的样板代码。

以下是使用该方法的示例单元测试的外观：

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

    //our service under test, with mocked dependencies injected
    @Autowired
    ExampleService exampleService;

    //we can autowire mocked beans if we need to used them in tests
    @Autowired
    DependencyBeanA dependencyBeanA;

    @Test
    public void testSomeMethod() {
        ...
        exampleService.someMethod();
        ...
        verify(dependencyBeanA, times(1)).someDependencyMethod();
    }

    /**
     * Inner class configuration object for this test. Spring will read it thanks to
     * @ContextConfiguration(loader=AnnotationConfigContextLoader.class) annotation on the test class.
     */
    @Configuration
    @Import(TestAppConfig.class) //TestAppConfig may contain some common integration testing configuration
    @MockedBeans({DependencyBeanA.class, DependencyBeanB.class, AnotherDependency.class}) //Beans to be mocked
    static class ContextConfiguration {

        @Bean
        public ExampleService exampleService() {
            return new ExampleService(); //our service under test
        }
    }
}

要做到这一点，您需要定义两个简单的帮助类 - 自定义注解 ( @MockedBeans) 和自定义 ImportBeanDefinitionRegistrar实现。@MockedBeans注释定义需要进行注释，@Import(CustomImportBeanDefinitionRegistrar.class)并且ImportBeanDefinitionRgistrar需要在其方法中将模拟 bean 定义添加到配置中registerBeanDefinitions。

如果您喜欢这种方法，您可以在我的博文中找到示例实现。

score 1 · Accepted Answer

我根据 Kresimir Nesek 的提议开发了一个解决方案。我添加了一个新注解@EnableMockedBean以使代码更简洁和模块化。

@EnableMockedBean
@SpringBootApplication
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes=MockedBeanTest.class)
public class MockedBeanTest {

    @MockedBean
    private HelloWorldService helloWorldService;

    @Autowired
    private MiddleComponent middleComponent;

    @Test
    public void helloWorldIsCalledOnlyOnce() {

        middleComponent.getHelloMessage();

        // THEN HelloWorldService is called only once
        verify(helloWorldService, times(1)).getHelloMessage();
    }

}

我写了一篇文章来解释它。

score 1 · Accepted Answer

我建议将您的项目迁移到 Spring Boot 1.4。之后，您可以使用新注释@MockBean来伪造您的com.package.Dao

score 0 · Accepted Answer

今天我发现我在 Mockito bean 之前声明的 spring 上下文无法加载。移动 AFTER 模拟后，应用程序上下文已成功加载。小心：）

score 0 · Accepted Answer

作为记录，我所有的测试都通过使夹具延迟初始化来正确工作，例如：

<bean id="fixture"
      class="it.tidalwave.northernwind.rca.embeddedserver.impl.DefaultEmbeddedServer"
      lazy-init="true" /> <!-- To solve Mockito + Spring problems -->

<bean class="it.tidalwave.messagebus.aspect.spring.MessageBusAdapterFactory" />

<bean id="applicationMessageBus"
      class="org.mockito.Mockito" factory-method="mock">
    <constructor-arg value="it.tidalwave.messagebus.MessageBus" />
</bean>

<bean class="org.mockito.Mockito" factory-method="mock">
    <constructor-arg value="javax.servlet.ServletContext" />
</bean>

我想基本原理是 Mattias在这里解释的（在帖子的底部），一种解决方法是改变声明 bean 的顺序 - 延迟初始化“有点”在最后声明了夹具。

score 0 · Accepted Answer

如果您使用的是 spring boot 2.2+，您可以使用@MockInBean作为替代@MockBean并保持您的 Spring 上下文干净：

@SpringBootTest
public class MyServiceTest {

    @MockInBean(MyService.class)
    private ServiceToMock serviceToMock;

    @Autowired
    private MyService myService;

    @Test
    public void test() {
        Mockito.when(serviceToMock.returnSomething()).thenReturn(new Object());
        myService.doSomething();
    }
}

免责声明：我创建这个库是为了避免由 @MockBean/@SpringBean 引起的 Spring Context 重新创建，这会导致构建测试阶段缓慢（请参阅在测试中使用 @MockBean 强制重新加载应用程序上下文或@MockBean 的问题）

spring - 将 Mockito 模拟注入 Spring bean

23 回答 23

Related

Reference