我想将Mockito模拟对象注入到Spring (3+) bean中，以便使用JUnit进行单元测试。我的bean依赖项目前是通过在私有成员字段上使用@Autowired注释注入的。
我考虑过使用ReflectionTestUtils。setField，但是我希望注入的bean实例实际上是一个代理，因此没有声明目标类的私有成员字段。我不希望为依赖项创建公共setter，因为我将纯粹为了测试目的而修改我的接口。
我遵循了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值设置为无效的值，那么在启动应用程序上下文时就不会出现错误。
更新:现在有更好、更清洁的解决方案来解决这个问题。请先考虑其他答案。
我最终在ronen的博客上找到了答案。我遇到的问题是由于Mockito方法。mock(类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>
如果您正在使用spring >= 3.0，请尝试使用spring @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的容器配置
更新-新的答案在这里:https://stackoverflow.com/a/19454282/411229。这个答案只适用于3.2之前的Spring版本。
我一直在寻找一个更明确的解决方案。这篇博客文章似乎涵盖了我的所有需求，并且不依赖于bean声明的顺序。这一切都要归功于Mattias Severson。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>
考虑到:
@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注释)。sprr -14050已经修复了这个问题。
对于早期版本，一种解决方案是打开代理，如文中所述:事务性注释避免模拟服务(这就是ReflectionTestUtils。setField现在默认执行)
我使用了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需要在它的registerBeanDefinitions方法中将模拟bean定义添加到配置中。
如果你喜欢这种方法，你可以在我的博客上找到示例实现。
如果您正在使用Spring Boot 1.4，它有一种很棒的方式来实现这一点。只需要在你的类上使用新品牌@SpringBootTest，在字段上使用@MockBean, SpringBoot就会创建一个这种类型的mock，并将它注入到上下文中(而不是注入原来的那个):
@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 bean，将模拟对象注入Spring上下文:
@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() {
....
}
}
如果你不想使用mock而是真正的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() {
....
}
}