Java单元测试实践-19.Mockito与PowerMock的其他功能

最新推荐文章于 2024-05-17 18:29:08 发布

原创最新推荐文章于 2024-05-17 18:29:08 发布 · 3.8k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#java #单元测试 #mockito #powermock

Java 同时被 2 个专栏收录

85 篇文章

订阅专栏

单元测试

29 篇文章

订阅专栏

本文详细介绍Java单元测试中Mockito与PowerMock的高级功能，包括Mock对象的详细信息获取、私有成员变量操作、构造函数调用、定时任务禁止等，提供丰富的示例代码。

Java单元测试实践-00.目录（9万多字文档+700多测试示例）
https://blog.youkuaiyun.com/a82514921/article/details/107969340

1. Mockito与PowerMock的其他功能

1.1. 获取Mock对象详细信息

Mockito提供了用于获取Mock对象详细信息的API，可参考 https://static.javadoc.io/org.mockito/mockito-core/latest/org/mockito/Mockito.html#mocking_details 。

1.1.1. 判断指定对象是否为Mock/Spy对象

使用Mockito.mockingDetails()方法，可以获取指定对象对应的MockingDetails实例，可以获得Mock的相关信息。

MockingDetails.isMock()、isSpy()方法分别可以判断指定的对象是否为Mock对象或Spy对象。

使用MockingDetails.isMock()、isSpy()方法可以准确地判断指定的对象是Mock对象、Spy对象还是原始对象，使用示例如下，可参考示例TestSpringMockDetailIs1类。

assertFalse(Mockito.mockingDetails(new TestServiceA1Impl()).isMock());
assertFalse(Mockito.mockingDetails(new TestServiceA1Impl()).isSpy());

assertTrue(Mockito.mockingDetails(Mockito.mock(TestServiceA1.class)).isMock());
assertTrue(Mockito.mockingDetails(Mockito.spy(TestServiceA1.class)).isSpy());

1.1.1.1. 将对象中的成员变量替换为Mock/Spy对象公共方法

在替换成员变量时，为了防止覆盖原有Stub操作，可以使用MockingDetails.isMock()、isSpy()方法来准确地判断指定成员变量是否已经是Mock/Spy对象。

使用MockingDetails.isMock()、isSpy()方法判断对象是否为Mock/Spy对象的功能，将替换成员变量的操作整理为公共方法，能够实现将指定对象的指定类型成员变量替换为Mock/Spy对象，可以简化操作，并避免将现有Mock/Spy对象的Stub操作覆盖。

在示例代码中，提供了将成员变量替换为Mock/Spy对象，且可以避免覆盖原有Stub的简化公共方法。可使用示例TestReplaceUtil类的replaceMockMember、replaceSpyMember方法。

示例如下，返回的对象为testServiceB1对象中的TestServiceA1类的Mock/Spy对象：

TestServiceA1 testServiceA1InB1 = TestReplaceUtil.replaceMockMember(testServiceB1, TestServiceA1.class);

TestServiceA1 testServiceA1InB1 = TestReplaceUtil.replaceSpyMember(testServiceB1, TestServiceA1.class);

以上公共方法的使用可参考示例TestSpMockMemberOfMCommRun、TestSpMockMemberOfMCommMock、TestSpSpyMemberOfMCommRun、TestSpSpyMemberOfMCommSpy类。

1.1.2. 获取Mock对象原始类型及默认Answer等详细信息

使用MockingDetails.getMockCreationSettings()方法，可以获取对应的MockCreationSettings实例，可以获得Mock在创建时的设置。

获取Mock对象原始类型

使用MockCreationSettings.getTypeToMock()方法可以获取Mock对象原始类型，使用示例如下，可参考示例TestSpringMockDetailMock1类。

assertEquals(RuntimeException.class,
        Mockito.mockingDetails(Mockito.mock(RuntimeException.class)).getMockCreationSettings().getTypeToMock());

获取默认Answer

使用MockCreationSettings.getDefaultAnswer()方法可以获取Mock对象的默认Answer，使用示例如下，可参考示例TestSpringMockDetailMock1类。

assertSame(Mockito.RETURNS_DEFAULTS,
        Mockito.mockingDetails(Mockito.mock(RuntimeException.class)).getMockCreationSettings().getDefaultAnswer());

获取Spy对象的以上信息可参考示例TestSpringMockDetailSpy1类。

1.1.3. 获取Mock对象的Stub设置及方法调用情况

获取Mock对象的Stub设置

使用MockingDetails.getStubbings()方法，可以获取指定Mock对象的Stub设置，类型为Collection<Stubbing>，Mock对象初始的Stub设置数量为0，每设置一个Stub条件，数量加1。

Stubbing对象的toString()方法会返回Stub的详细信息。设置以下Stub条件后，通过MockingDetails.getStubbings()方法获取Stubbing对象并打印，如下所示。可参考示例TestSpringMockDetailMock2类。

Mockito.when(testServiceA1Mock.test1(Mockito.anyString())).thenReturn(TestConstants.MOCKED);

Mockito.doAnswer(invocation -> null).when(testServiceA1Mock).test2(Mockito.any(StringBuilder.class));

Mockito.when(testServiceA1Mock.test3(Mockito.anyString())).thenThrow(new RuntimeException(TestConstants.MOCKED));

testServiceA1.test1(<any string>); stubbed with: [Returns: MOCKED]

testServiceA1.test2(
    <any java.lang.StringBuilder>
); stubbed with: [adrninistrator.test.testmock.detail.TestSpringMockDetailMock2$$Lambda$1/1692381981@4300e240]

testServiceA1.test3(<any string>); stubbed with: [org.mockito.internal.stubbing.answers.ThrowsException@5f409872]

获取Mock对象的方法调用情况

使用MockingDetails.getInvocations()方法，可以获取指定Mock对象的方法调用情况，类型为Collection<Invocation>，初始数量为0，每调用一次方法，数量加1。

Invocation对象的toString()方法会返回Invocation的详细信息。调用以下方法后，通过MockingDetails.getInvocations()方法获取Invocation对象并打印，如下所示：

testServiceA1Mock.test1(TestConstants.FLAG1);

testServiceA1Mock.test2(new StringBuilder().append(TestConstants.FLAG2));

testServiceA1.test1("flag1");

testServiceA1.test2(flag2);

MockingDetails.printInvocations()，以友好的方式展示指定Mock对象已发生的的调用信息。此外，该方法还会打印Stub信息，包括未使用的Stub。该方法返回类型为String。以上Mock对象的MockingDetails.printInvocations()返回结果如下所示。可参考示例TestSpringMockDetailMock2类。

[Mockito] Interactions of: Mock for TestServiceA1, hashCode: 800722348
 1. testServiceA1.test1("flag1");
  -> at adrninistrator.test.testmock.detail.TestSpringMockDetailMock2.test(TestSpringMockDetailMock2.java:51)
   - stubbed -> at adrninistrator.test.testmock.detail.TestSpringMockDetailMock2.init(TestSpringMockDetailMock2.java:32)
 2. testServiceA1.test2(flag2);
  -> at adrninistrator.test.testmock.detail.TestSpringMockDetailMock2.test(TestSpringMockDetailMock2.java:54)
   - stubbed -> at adrninistrator.test.testmock.detail.TestSpringMockDetailMock2.init(TestSpringMockDetailMock2.java:35)

[Mockito] Unused stubbings of: Mock for TestServiceA1, hashCode: 800722348
 1. testServiceA1.test1("");
  - stubbed -> at adrninistrator.test.testmock.detail.TestSpringMockDetailMock2.init(TestSpringMockDetailMock2.java:32)
 2. testServiceA1.test2(null);
  - stubbed -> at adrninistrator.test.testmock.detail.TestSpringMockDetailMock2.init(TestSpringMockDetailMock2.java:35)
 3. testServiceA1.test3("");
  - stubbed -> at adrninistrator.test.testmock.detail.TestSpringMockDetailMock2.init(TestSpringMockDetailMock2.java:38)

获取Spy对象的以上信息可参考示例TestSpringMockDetailSpy2类。

1.2. 使用@InjectMocks注解实现Mock/Spy对象的自动注入

使用@InjectMocks注解可以实现Mock/Spy对象的自动注入。例如使用@InjectMocks注解指定C类的实例，再使用@Mock/@Spy注解指定C类中包含的成员变量A、B类的实例，可以实现将A、B类的Mock/Spy对象自动注入至C类实例中。示例如下：

@InjectMocks
private C c;

@Spy
private B b = new B();

@Mock
private A a;

@InjectMocks注解需要指定实现类对象，不能指定接口对象，否则会出现类似以下异常：

org.mockito.exceptions.base.MockitoException: 
Cannot instantiate @InjectMocks field named 'testServiceC1'! Cause: the type 'TestServiceC1' is an interface.
You haven't provided the instance at field declaration so I tried to construct the instance.

使用@InjectMocks注解指定的生成的对象为原始类的对象，不是Mock/Spy对象。以上可参考示例TestInjectMocks1、TestInjectMocks2类。

当使用@InjectMocks注解指定某类的实例时，对于未使用@Mock/@Spy注解指定的成员变量，不会被自动注入，即值为null。可参考示例TestInjectMocks3类。

1.2.1. 不推荐使用@InjectMocks注解

不推荐使用@InjectMocks注解实现Mock/Spy对象的自动注入，当需要使用与@InjectMocks注解类似的功能时，可以使用Whitebox.setInternalState()等方法通过反射的方式对成员变量进行替换。不推荐的原因如下：

使用不方便

对于@InjectMocks注解指定的类的实例，需要使用@Mock/@Spy注解指定每个成员变量，未指定的成员变量值会为null；

执行成员变量的真实方法不方便

对于@InjectMocks注解指定的类的实例，注入的成员变量为Mock/Spy对象，当需要执行成员变量的真实方法时不方便。

1.3. MockitoAnnotations.initMocks()方法

在测试类级别使用@PrepareForTest注解时，若未执行MockitoAnnotations.initMocks()方法，测试代码执行时使用了@InjectMocks、@Mock注解的对象为null，使用@Spy注解的对象不是null；在测试代码中执行MockitoAnnotations.initMocks()方法后，@InjectMocks、@Mock注解对应的对象会变为非null。若未在测试类中使用@InjectMocks、@Mock注解，则不需要调用MockitoAnnotations.initMocks()方法。

示例如下，可参考示例TestInitMocksNoPrepare、TestInitMocksWithPrepare1、TestInitMocksWithPrepare2类。

// 在测试类级别指定
@PrepareForTest({})

@InjectMocks
private TestServiceC1Impl testServiceC1Impl;

@Mock
private TestServiceA1 testServiceA1Mock;

@Before
public void init() {
	assertNull(testServiceC1Impl);

	assertNull(testServiceA1Mock);

	MockitoAnnotations.initMocks(this);

	assertNotNull(testServiceC1Impl);

	assertNotNull(testServiceA1Mock);
}

1.4. Mockito.reset()方法

Mockito.reset()方法可以对Mock进行重置。参考 https://static.javadoc.io/org.mockito/mockito-core/latest/org/mockito/Mockito.html#resetting_mocks 。良好的单元测试代码几乎不需要使用该功能。通常，不需要对Mock进行重置，只需要为每个测试方法创建新的Mock即可。

1.5. Mockito的Stub操作支持的对象

Mockito的Stub操作（Mockito.when()、Mockito.do…().when()等方法），只支持Mock/Spy对象，不支持原始对象。可参考示例TestStubSupport类。

1.6. 获取私有成员变量

当需要获取私有成员变量时，可使用Whitebox.getInternalState()方法，支持指定变量类型（对应类型的变量只存在一个）或变量名称获取。

也可以使用PowerMockito.field().get()方法获取私有成员变量，但不如Whitebox.getInternalState()方法简单。

示例如下，可参考示例TestGetPrivateField类。

@Autowired
private TestPublicNonVoidService1 testPublicNonVoidService1;
	
TestTableMapper testTableMapper1 = (TestTableMapper) PowerMockito.field(TestPublicNonVoidService1Impl.class,
		"testTableMapper").get(testPublicNonVoidService1);

TestTableMapper testTableMapper2 = Whitebox.getInternalState(testPublicNonVoidService1, TestTableMapper.class);

TestTableMapper testTableMapper3 = Whitebox.getInternalState(testPublicNonVoidService1, "testTableMapper");

1.6.1. 检查对象字段值是否等于预期值的简化方法

以下方法使用了Whitebox.getInternalState()方法。

示例代码中提供了检查对象字段值是否等于预期值的简化方法：TestCommonUtil.checkObjectValue()，支持对字符串、int、long、BigDecimal、Date等类型进行比较，可以避免对需要检查的对象的每个字段值逐个进行assertEquals等判断，通过数组指定需要比较的字段名称及预期值，可以减少代码量。

以上方法参数1为需要检查的对象，参数2为Object数组，内容为需要检查的信息，元素应为偶数个，下标为奇数的元素为key，下标为偶数的元素为value，使用示例如下：

Date date = new Date();

TestTable2 testTable2 = new TestTable2();
testTable2.setId(TestConstants.FLAG1);
testTable2.setChar1(TestConstants.FLAG1);
testTable2.setChar2(TestConstants.FLAG1);
testTable2.setText2(TestConstants.FLAG1);
testTable2.setInt1(1);
testTable2.setInt2(2);
testTable2.setDecimal1(100L);
testTable2.setDecimal2(BigDecimal.TEN);
testTable2.setDatetime1(date);
testTable2.setDatetime2(date);
testTable2.setTimestamp1(date);
testTable2.setTimestamp2(date);

TestCommonUtil.checkObjectValue(testTable2, new Object[]{"id", TestConstants.FLAG1, "char1", TestConstants.FLAG1,
		"char2", TestConstants.FLAG1, "text2", TestConstants.FLAG1, "int1", 1, "int2", 2, "decimal1", 100L, "decimal2", BigDecimal.TEN,
		"datetime1", date, "datetime2", date, "timestamp1", date, "timestamp2", date});

可参考示例TestCheckObjectValue类。

1.7. 替换私有成员变量

当需要替换私有成员变量时，可使用Whitebox.setInternalState()方法，支持指定变量类型，或变量名称对变量进行替换，或直接指定变量进行替换（不需要指定变量类型或名称，需要满足对应类型的变量只存在一个）；当直接指定变量进行替换时，支持一次替换多个变量。

也可以使用PowerMockito.field().set()方法替换私有成员变量，但不如Whitebox.setInternalState()方法简单。

示例如下，可参考示例TestSetPrivateField类。

TestNonStatic2 testNonStatic2 = new TestNonStatic2();

PowerMockito.field(TestNonStatic2.class, "flag").set(testNonStatic2, TestConstants.FLAG1);

Whitebox.setInternalState(testNonStatic2, String.class, TestConstants.FLAG2);

Whitebox.setInternalState(testNonStatic2, TestConstants.FLAG3);

Whitebox.setInternalState(testNonStatic1, "str1", TestConstants.FLAG1);

1.8. 创建构造函数为私有的类的实例

对于构造函数为私有的类，当需要创建实例时，可以调用Whitebox.newInstance()或Whitebox.invokeConstructor()方法，示例如下：

TestPrivateConstructor2 testPrivateConstructor2 = Whitebox.newInstance(TestPrivateConstructor2.class);
TestPrivateConstructor2 testPrivateConstructor2 = Whitebox.invokeConstructor(TestPrivateConstructor2.class);

以上方法的区别在于，Whitebox.newInstance()方法不会调用构造函数，Whitebox.invokeConstructor()方法会调用构造函数。可参考示例TestNewPrivateConstructor1、TestNewPrivateConstructor2类。

1.9. 执行私有方法

当需要执行私有方法时，可使用Whitebox.invokeMethod()方法，支持执行静态私有方法及非静态私有方法。

也可以使用PowerMockito.method().invoke()方法执行私有方法，但不如Whitebox.invokeMethod()方法简单。

示例如下，可参考示例TestInvokePrivateMethod类。

@Autowired
private TestPrivateNonVoidService1 testPrivateNonVoidService1;
	
String str = Whitebox.invokeMethod(TestStaticPrivateNonVoid1.class, TestStaticPrivateNonVoid1.NAME_TEST3);

String str = Whitebox.invokeMethod(testPrivateNonVoidService1, TestPrivateNonVoidService1Impl.NAME_TEST1, "");

String str = (String) PowerMockito.method(TestPrivateNonVoidService1Impl.class, TestPrivateNonVoidService1Impl
		.NAME_TEST1).invoke(testPrivateNonVoidService1, "");

2. 使用Mock禁止Spring定时任务

在执行单元测试用例时，若满足了定时任务的执行时间要求，会使定时任务执行，可能对测试造成干扰，可以使用Mock禁止定时任务。

以下以使用Mock禁止Spring定时任务为例，若使用其他的定时任务框架，也可以参考。

Spring定时任务的初始化在ScheduledTaskRegistrar.scheduleTasks()方法中完成，在该方法中会分别完成triggerTasks、cronTasks、fixedRateTasks、fixedDelayTasks等定时任务的初始化。

使用Mock禁止Spring定时任务，需要使用@PrepareForTest注解指定ScheduledTaskRegistrar类，在@BeforeClass注解对应的方法中禁止ScheduledTaskRegistrar.scheduleTasks()方法，如下所示：

@PrepareForTest({ScheduledTaskRegistrar.class})

@BeforeClass
public static void beforeClass() {
    PowerMockito.suppress(PowerMockito.method(ScheduledTaskRegistrar.class, "scheduleTasks"));
}