如何用假测试模块替换 Guice 模块进行单元测试?
How do I substitute Guice modules with fake test modules for unit tests?
以下是我们在新应用程序中使用 Guice 的方式:
public class ObjectFactory {
private static final ObjectFactory instance = new ObjectFactory();
private final Injector injector;
private ObjectFactory() throws RuntimeException {
this.injector = Guice.createInjector(new Module1());
}
public static final ObjectFactory getInstance() {
return instance;
}
public TaskExecutor getTaskExecutor() {
return injector.getInstance(TaskExecutor.class);
}
}
Module1
定义了 TaskExecutor
需要如何构造。
在代码中我们使用ObjectFactory.getInstance().getTaskExecutor()
获取和TaskExecutor
的实例。
在单元测试中,我们希望能够用 FakeTaskExecutor
替换它,本质上我们希望在调用 ObjectFactory.getInstance().getTaskExecutor()
时获得 FakeTaskExecutor
的实例。
我正在考虑实现一个 FakeModule
,它将被注入器使用,而不是 Module1
。
在 Spring 中,我们将只使用 @Autowired
注释,然后为 Test
和 Production
代码以及 运行 我们的测试定义单独的 beans Spring4JunitRunner
;我们正在尝试对 Guice 做类似的事情。
好的,首先要注意的是:您似乎没有按照预期的方式使用 Guice。一般来说,您想使用 Guice.createInjector()
启动整个应用程序,让它为您创建所有构造函数参数,而无需调用 new
.
一个典型的用例可能是这样的:
public class Foo {
private final TaskExecutor executor;
@Inject
public Foo(TaskExecutor executor) {
this.executor = executor;
}
}
这是有效的,因为 Foo 的实例自身被注入,一直到对象图。参见:Getting started
With dependency injection, objects accept dependencies in their constructors. To construct an object, you first build its dependencies. But to build each dependency, you need its dependencies, and so on. So when you build an object, you really need to build an object graph.
Building object graphs by hand is labour intensive, error prone, and makes testing difficult. Instead, Guice can build the object graph for you. But first, Guice needs to be configured to build the graph exactly as you want it.
因此,通常情况下,您不会创建单例模式并将注入器放入其中,因为您应该很少在主 class 之外调用 Guice.createInstance
;让注射器为您完成所有工作。
综上所述,要解决您实际询问的问题,您需要使用 Jukito。
The combined power of JUnit, Guice and Mockito. Plus it sounds like a cool martial art.
让我们回到上面描述的用例。在 Jukito 中,您可以这样写 FooTest
:
@RunWith(JukitoRunner.class)
public class FooTest {
public static class Module extends JukitoModule {
@Override
protected void configureTest() {
bindMock(TaskExecutor.class).in(TestSingleton.class);
}
}
@Test
public void testSomething(Foo foo, TaskExecutor executor) {
foo.doSomething();
verify(executor, times(2)).someMethod(eq("Hello World"));
}
}
这将通过 Jukito 验证您的 Mock object, generated by Mockito 方法 someMethod
恰好调用了两次,两次都是字符串 "Hello World"
。
这就是为什么您不想以您描述的方式使用 ObjectFactory
生成对象; Jukito 在其单元测试中为您创建了 Injector,而注入 Mock 将非常困难,您必须编写大量样板文件。
以下是我们在新应用程序中使用 Guice 的方式:
public class ObjectFactory {
private static final ObjectFactory instance = new ObjectFactory();
private final Injector injector;
private ObjectFactory() throws RuntimeException {
this.injector = Guice.createInjector(new Module1());
}
public static final ObjectFactory getInstance() {
return instance;
}
public TaskExecutor getTaskExecutor() {
return injector.getInstance(TaskExecutor.class);
}
}
Module1
定义了 TaskExecutor
需要如何构造。
在代码中我们使用ObjectFactory.getInstance().getTaskExecutor()
获取和TaskExecutor
的实例。
在单元测试中,我们希望能够用 FakeTaskExecutor
替换它,本质上我们希望在调用 ObjectFactory.getInstance().getTaskExecutor()
时获得 FakeTaskExecutor
的实例。
我正在考虑实现一个 FakeModule
,它将被注入器使用,而不是 Module1
。
在 Spring 中,我们将只使用 @Autowired
注释,然后为 Test
和 Production
代码以及 运行 我们的测试定义单独的 beans Spring4JunitRunner
;我们正在尝试对 Guice 做类似的事情。
好的,首先要注意的是:您似乎没有按照预期的方式使用 Guice。一般来说,您想使用 Guice.createInjector()
启动整个应用程序,让它为您创建所有构造函数参数,而无需调用 new
.
一个典型的用例可能是这样的:
public class Foo {
private final TaskExecutor executor;
@Inject
public Foo(TaskExecutor executor) {
this.executor = executor;
}
}
这是有效的,因为 Foo 的实例自身被注入,一直到对象图。参见:Getting started
With dependency injection, objects accept dependencies in their constructors. To construct an object, you first build its dependencies. But to build each dependency, you need its dependencies, and so on. So when you build an object, you really need to build an object graph.
Building object graphs by hand is labour intensive, error prone, and makes testing difficult. Instead, Guice can build the object graph for you. But first, Guice needs to be configured to build the graph exactly as you want it.
因此,通常情况下,您不会创建单例模式并将注入器放入其中,因为您应该很少在主 class 之外调用 Guice.createInstance
;让注射器为您完成所有工作。
综上所述,要解决您实际询问的问题,您需要使用 Jukito。
The combined power of JUnit, Guice and Mockito. Plus it sounds like a cool martial art.
让我们回到上面描述的用例。在 Jukito 中,您可以这样写 FooTest
:
@RunWith(JukitoRunner.class)
public class FooTest {
public static class Module extends JukitoModule {
@Override
protected void configureTest() {
bindMock(TaskExecutor.class).in(TestSingleton.class);
}
}
@Test
public void testSomething(Foo foo, TaskExecutor executor) {
foo.doSomething();
verify(executor, times(2)).someMethod(eq("Hello World"));
}
}
这将通过 Jukito 验证您的 Mock object, generated by Mockito 方法 someMethod
恰好调用了两次,两次都是字符串 "Hello World"
。
这就是为什么您不想以您描述的方式使用 ObjectFactory
生成对象; Jukito 在其单元测试中为您创建了 Injector,而注入 Mock 将非常困难,您必须编写大量样板文件。