Java测试框架系列：Mockito使用手册

最新推荐文章于 2024-09-13 22:20:04 发布

阿星君

最新推荐文章于 2024-09-13 22:20:04 发布

阅读量3.2k

点赞数 1

分类专栏： java 软件测试 mockito 文章标签： java mockito 测试测试工程师

本文链接：https://blog.csdn.net/dingyu002/article/details/118306212

版权

本文详细介绍了Mockito测试框架的使用，包括创建mock和spy对象、存根方法调用、验证方法调用等核心概念。通过示例展示了如何使用Mockito注解、Mockito.mock()和Mockito.spy()创建对象，并讲解了mock对象和spy对象的区别以及存根策略。还提到了Mockito的参数匹配器和调用验证方法，是Java测试工程师必备的Mockito指南。

摘要由CSDN通过智能技术生成

Mockito 使用手册（需要源码的加我QQ3177181324）

零：概述

一：创建mock/spy对象

0：概述

Mockito可以帮助我们方便的创建被测对象、mock对象和spy对象。

创建被测对象：
- 先解释一下被测对象：就是单元测试中我们想要测试的那个类。如xxxService、xxxUtils等等。
- 使用@InjectMocks注解创建：
  - 配合@RunWith(MockitoJUnitRunner.class)使用或在@Before方法中使用MockitoAnnotations.openMocks(this)来激活Mockito 注解的相关功能。
  - 如果同时也使用了@Mock注解或者@Spy注解。Mockito可以方便的将这两个注解生成的对象注入到@InjectMocks注解的对象的成员变量中。
- 直接创建：
  - 当然我们可以直接new一个被测对象，但是我们不能方便的使用Mockito为我们提供的自动注入成员变量的功能了。当然我们可以手动的现在这些注入的工作。
创建mock对象：
- mock对象：一般是被测对象依赖的对象（比如被测对象的成员变量）。
- 使用@Mock注解：
  - 配合@RunWith(MockitoJUnitRunner.class)使用或在@Before方法中使用MockitoAnnotations.openMocks(this)来激活Mockito 注解的相关功能。
  - 被@Mock注解的对象会被自动注入到@InjectMocks注解生成的被测对象中。
- 使用Mockito.mock();
  - 生成的mock对象需要手动配置到被测对象中，不推荐。
- 注意：
  - mock对象中的方法被调用时默认会返回对应类型对象的空值。方法实际的代码不会被执行。当前如果我们想要执行实际的代码也是可以的：
    - 我么可以先对此方法进行存根操作，此时使用doCallRealMethod()或者thenCallRealMethod()方法即可。下文会具体描述如何操作。
    - 也可以通过指定返回值策略（Mockito.CALLS_REAL_METHODS）的方式实现。即创建mock对象时指定返回值策略为Mockito.CALLS_REAL_METHODS。
  - mock对象中的方法被调用时默认会返回对应类型对象的空值。许多情况下当我们不对某个方进行存根时那么返回的值就是null，测试过程中就会产生NPE。但是我们可以在创建mock对象时指定返回值生成策略（Answer策略）。下文会具体描述如何操作。
创建spy对象：
- spy对象：部分mock的对象。一般是被测对象依赖的对象（比如被测对象的成员变量）。
- 使用@Spy注解：
  - 配合@RunWith(MockitoJUnitRunner.class)使用或在@Before方法中使用MockitoAnnotations.openMocks(this)来激活Mockito 注解的相关功能。
  - 被@Spy注解的对象会被自动注入到@InjectMocks注解生成的被测对象中。
- 使用Mockito.spy();
  - 生成的spy对象需要手动配置到被测对象中，不推荐。
- 注意：
  - spy对象中的方法被调用时默认情况下方法实际的代码会被执行。当前如果我们想要不执行实际的代码也是可以的：
    - 我么可以先对此方法进行存根操作，此时使用doXXXX()方法即可（注意不要使用或者thenXXXX()方法，会给我们带来麻烦：实际的代码会在此时被调用一次）。下文会具体描述如何操作。

1：创建mock对象

使用Mockito.mock()方法。

        //org.mockito.Mockito.mock(java.lang.Class<T>)
        //org.mockito.Mockito.mock(java.lang.Class<T>, java.lang.String)
        //org.mockito.Mockito.mock(java.lang.Class<T>, org.mockito.stubbing.Answer)
        //org.mockito.Mockito.mock(java.lang.Class<T>, org.mockito.MockSettings)
        
        //方式1
        Foo foo1 = Mockito.mock(Foo.class);
        //方式2：给mock指定名称
        Foo foo2 = Mockito.mock(Foo.class, "mock_1");
        //方式3：给mock指定自定义返回逻辑
        Foo foo3 = Mockito.mock(Foo.class, new Answer() {
            @Override
            public Object answer(InvocationOnMock invocation) throws Throwable {
                //自定义返回逻辑
                return null;
            }
        });
        //方式4：使用MockSettings配置当前mock
        Foo foo4 = Mockito.mock(Foo.class, Mockito.withSettings().defaultAnswer(Mockito.RETURNS_SMART_NULLS));

使用@InjectMocks和@Mock注解。

被@InjectMocks注解的对象就是要被我们测试的对象，它会被自动的实例化。且其包含的成员变量会被相应的@Mock注解的对象自动赋值。注意观察下面的示例：
注意使用了@RunWith(MockitoJUnitRunner.class)注解。

public class Foo {

    private Bar bar;

    public int sum(int a, int b) {
        return bar.add(a, b);
    }
}

public class Bar {

    public int add(int a, int b) {
        return a + b;
    }
}

//注意我们使用了MockitoJUnitRunner
@RunWith(MockitoJUnitRunner.class)
public class MockitoTest {
  	//foo 对象内部的成员变量会自动被 @Mock 注解的生成的对象注入。
    @InjectMocks
    private Foo foo;

  	//bar 对象会自动的注入到 @InjectMocks 注解的对象的成员变量中去。
    @Mock
    private Bar bar;

    @Test
    public void mockTest() {
      	//先对mock对象的待测方法进行存根，当真正执行到mock对象的此方法时
      	//会直接返回存根的结果而不会调用mock对象的实际代码
        Mockito.when(bar.add(1, 2)).thenReturn(7);
        
      	int result = foo.sum(1, 2);
      	//验证是否是存根返回的值
        Assert.assertEquals(7, result);
    }
}

注意事项:
- 默认情况下，对于所有方法的返回值，mock 视情况而定将返回 null、原始/原始包装值或空集合。例如 int/Integer 返回0，布尔值/布尔值返回false。我们可以在创建mock时通过指定默认的Answer策略来更改此返回。支持的Answer策略：
  - Mockito.RETURNS_DEFAULTS;
    - 这个实现首先尝试全局配置，如果没有全局配置，那么它将使用一个返回0、空集合、空值等的默认Answer。
  - Mockito.RETURNS_DEEP_STUBS;
    - 链式调用避免空指针。
  - Mockito.RETURNS_MOCKS;
    - 首先尝试返回普通值(0、空集合、空字符串等)，然后尝试返回mock。如果返回类型不能被mock(例如final)，则返回普通的null。
  - Mockito.RETURNS_SELF;
    - 允许Builder 的mock在调用方法时返回其本身，该方法返回的Type等于类或父类。请记住，这个Answer使用方法的返回类型。如果此类型可分配给mock类，则它将返回mock。因此，如果您有一个返回超类(例如Object)的方法，它将匹配并返回mock。
  - Mockito.RETURNS_SMART_NULLS;
    - 此实现在处理遗留代码时很有帮助。非存根方法通常返回null。如果代码使用非存根调用返回的对象，则会得到NullPointerException。这个Answer的实现返回SmartNull而不是null。SmartNull给出了比NPE更好的异常消息，因为它指出了调用无存根方法的那一行。您只需单击堆栈即可跟踪。 SmartNull首先尝试返回普通值(0，空集合，空字符串等)，然后尝试返回SmartNull。如果返回类型是final，则返回纯null。在Mockito 4.0.0中，ReturnsSmartNulls可能是默认的返回值策略。
  - Mockito.CALLS_REAL_METHODS
    - 一个调用实际方法(用于部分mock)的Answer。

2：创建spy对象

使用Mockito.spy()方法

    {
        //org.mockito.Mockito.spy(java.lang.Class<T>)
        //org.mockito.Mockito.spy(T)

        //方式1：spy一个具体的类型
        List spy1 = Mockito.spy(List.class);
        //方式2：spy一个已存在的对象
        List spy2 = Mockito.spy(new ArrayList<>());

        //便利的 API, 新的重载的 spy() 方法:
        SomeAbstract spy = spy(SomeAbstract.class);

        //Mocking 抽象, spy 接口的默认方法(从2.7.13可用)
        Function function = spy(Function.class);

        //健壮的 API, 来自 settings builder:
        OtherAbstract spy = mock(OtherAbstract.class, withSettings()
            .useConstructor().defaultAnswer(CALLS_REAL_METHODS));

        //Mock一个抽象类，使用构造函数(从 2.7.14 可用)
        SomeAbstract spy = mock(SomeAbstract.class, withSettings()
            .useConstructor("arg1", 123).defaultAnswer(CALLS_REAL_METHODS));

        //mock一个非静态内部抽象类
        InnerAbs