单元测试 Mockito + Junit使用和总结、PowerMock

(目录)

单元测试之Mockito+Junit使用和总结

一、什么是MOCK测试

Mock 测试就是在测试过程中，对于某些不容易构造（如 HttpServletRequest 必须在Servlet 容器中才能构造出来）或者不容易获取比较复杂的对象（如 JDBC 中的ResultSet 对象），用一个虚拟的对象（Mock 对象）来创建以便测试的测试方法。 Mock 最大的功能是帮你把单元测试的耦合分解开，如果你的代码对另一个类或者接口有依赖，它能够帮你模拟这些依赖，并帮你验证所调用的依赖的行为。

mock中的必知概念：

• 桩函数(stub)：桩函数实际上是白盒测试中的概念，意思是使用一些自己定义的测试函数来替换当前需要测试的函数。被替换的函数可能是目前还没写完的，这样能够加速开发，或更好的找错误源。
• 打桩（存根）：模拟要调用的函数（打桩对象），给它提供桩函数，给桩函数返回一个值。简单的说自定义输入输出，不打桩默认返回null。
• mock和stub： 相同点：Stub和Mock对象都是用来模拟外部依赖，使我们能控制。 不同点：而stub完全是模拟一个外部依赖，用来提供测试时所需要的测试数据。而mock对象用来判断测试是否能通过，也就是用来验证测试中依赖对象间的交互能否达到预期。在mocking框架中mock对象可以同时作为stub和mock对象使用，两者并没有严格区别。

相信做过开发的同学，都多多少少写过下面的代码，很长一段时间我一直以为这就是单元测试...

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

    @Autowired
    private UnitService unitService;

    @Test
    public void test() {
        System.out.println("----------------------");
        System.out.println(unitService.sayHello());
        System.out.println("----------------------");
    }
}

但这是单元测试嘛？unitService 中可能还依赖了 Dao 的操作；如果是微服务，可能还要起注册中心。那么这个“单元”也太大了吧！如果把它称为集成测试，可能更恰当一点，那么有没有可能最小粒度进行单元测试嘛？

单元测试应该是一个带有隔离性的功能测试。在单元测试中，应尽量避免其他类或系统的副作用影响。

单元测试的目标是一小段代码，例如方法或类。方法或类的外部依赖关系应从单元测试中移除，而改为测试框架创建的 mock 对象来替换依赖对象。

单元测试一般由开发人员编写，通过验证或断言目标的一些行为或状态来达到测试的目的。

JUnit 框架

JUnit 是一个测试框架，它使用注解来标识测试方法。JUnit 是 Github 上托管的一个开源项目。

一个 JUnit 测试指的是一个包含在测试类中的方法，要定义某个方法为测试方法，请使用 @Test 注解标注该方法。该方法执行被测代码，可以使用 JUnit 或另一个 Assert 框架提供的 assert 方法来检查预期结果与实际结果是否一致，这些方法调用通常称为断言或断言语句。

public class UnitTest2 {

    @Test
    public void test() {
        String sayHello = "Hello World";
        Assert.assertEquals("Hello World", sayHello);
    }
}

以下是一些常用的 JUnit 注解：

以下是一些常用的 Assert 断言：

二、Mockito使用

本文用maven作例子，导入jar包

        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-api</artifactId>
            <version>5.9.2</version>
            <scope>test</scope>
        </dependency>
            <!-- https://mvnrepository.com/artifact/org.mockito/mockito-core -->
            <dependency>
                <groupId>org.mockito</groupId>
                <artifactId>mockito-core</artifactId>
                <version>4.3.1</version>
                <scope>test</scope>
            </dependency>

1.声明mockito对象

有两种方式，但首先都得导入import static org.mockito.Mockito.*; 最好用静态导入，可以直接调用方法

• 通过@Mock注解声明mock对象。MockitoJUnitRunner（或者MockitoAnnotations.initMocks(this);）为@mock，@spy等注解提供了初始化作用，所以用到注解时，一般都要使用它。 @Mock: 创建一个Mock. @InjectMocks: 创建一个实例，简单的说是这个Mock可以调用真实代码的方法，其余用@Mock（或@Spy）注解创建的mock将被注入到用该实例中。可以调用类中的真实方法。

//让注解生效的第一种方法
@RunWith(MockitoJUnitRunner.class)
public class TestMocks {
	//@Mock注解会自动mock一个list对象
    @Mock
    List mock;
    
	//让注解生效的第二种方法，二选一即可
 	@Before
    public void setup() {
        MockitoAnnotations.initMocks(this);
    }
    
    @Test
    public void testMethod(){
    mock.add("firstTime");
    mock.add("secondTime");
    }
}

• 静态方法声明mock对象

public class TestMock {
    //声明一个List的mock对象
    List mock=mock(List.class);

    @Test
    public void testMethod(){
    mock.add("firstTime");
    mock.add("secondTime");
    }
}

2.mock对象的when存根方法

就是前面提到的打桩，一般用于给mock对象的函数指定自己需要的输入输出值，示例：

    List mock=mock(List.class);
    @Test
    public void testMethod(){
    mock.add("firstTime");
    mock.add("secondTime");
    //打桩
    when(mock.get(0)).thenReturn(1);
    //如果是没有返回值的void方法，直接
    when(method).notify();
    }

表示mock.get(0)返回值为1，这个地方的0也可以替换成anyInt()函数，代表获取任意数字返回都为0，不打桩默认返回为null。

注意：

对于 static 和 final 方法， Mockito 无法对其 when(…).thenReturn(…) 操作。 , 静态方法需要使用mockStatic()方法

3.@InjectMocks注入mock对象

我们要单元测试的内容，常常包含着对数据库的访问等等，那么我们要如何 mock 掉这部分调用呢？我们可以使用 @InjectMocks 注解创建实例并使用 mock 对象进行依赖注入。

@Service
public class UnitServiceImpl implements UnitService {

    @Autowired
    private UnitDao unitDao;

    @Override
    public String sayHello() {
        Integer delete = unitDao.delete(1L);
        System.out.println(delete);
        return "hello unit";
    }
}

Mock InjectMocks测试：

@RunWith(MockitoJUnitRunner.class)
public class UnitTest2 {
    
    @Mock
    private UnitDao unitDao;
    @InjectMocks
    private UnitServiceImpl unitService;

    @Test
    public void unitTest() {
        // mock 调用
        when(unitDao.delete(anyLong())).thenReturn(1);
        Assert.assertEquals("hello unit", unitService.sayHello());
    }
}

4.mock的verify方法

一般用于检查是否调用了某些指定的方法。简单来说, 它可以验证一次测试中发生的某些行为。在测试代码的底部使用它来确保调用定义的方法。同时也可以测试方法的调用次数，当不使用times函数试，默认为检查一次，times(num)，num为调用检查的次数。

 List mock=mock(List.class);
 @Test
    public void testMethod(){
        //打桩，返回值为1
        when(mock.get(0)).thenReturn(1);
        //此处调用了mock.get(0)方法一次
        assertEquals("测试一下",mock.get(0),1);
        //验证是否调用一次
        verify(mock).get(0);
        //加上times(num)函数，检查是否调用num次
        verify(mock,times(2)).get(0);
    }

mock除了times(num)方法以外，还提供了几种更加方便的方法：

never() 没有被调用，相当于 times(0) atLeast(N) 至少被调用 N 次 atLeastOnce() 相当于 atLeast(1) atMost(N) 最多被调用 N 次

随后我们可以使用verifyNoMoreInteractions方法来验证是否该mock对象所有的交互都得到验证

verifyNoMoreInteractions(mock);

如果有哪一次的调用没有验证，会报错提示

5.mock的thenThrow方法

用于存根void方法以引发异常时使用。

它为每个方法调用创建一个新的异常实例。

 List mock=mock(List.class);
 @Test
    public void testMethod(){
        //打桩，返回值为1
        when(mock.get(0)).thenReturn(1);
        //调用get(0)时自定义异常
        doThrow(new Exception("出错啦")).when(mock).get(0);
    }

注意：

thenThrow和doThrow作用都是抛出异常，用 doThrow 可以让返回void的函数抛出异常，而thenThrow不可以，因为when的参数是非void，

doThrow语法：

  doThrow(new RuntimeException("异常")).when(mock).hello();

6.mock的spy函数

spy 的意思是你可以修改某个真实对象的某些方法的行为特征。

List list = new LinkedList();  
List spy = spy(list);  
  
//optionally, you can stub out some methods:  
when(spy.size()).thenReturn(100);  
   
//using the spy calls <b>real</b> methods  
spy.add("one");  
spy.add("two");  
   
//prints "one" - the first element of a list  
System.out.println(spy.get(0));  
   
//size() method was stubbed - 100 is printed  
System.out.println(spy.size());  
   
//optionally, you can verify  
verify(spy).add("one");  
verify(spy).add("two");  

这里改掉了list的size方法，如果我们再声明对象spy后添加when(spy.get(0)).thenReturn(“foo”); 就会抛出空指针异常，因为用spy之后，在我们的原始对象中，list.get(0)是没有值的，不能直接存根，所以使用spy的时候打桩我们尽量使用doReturn方法，如果用mock的话，都是虚假函数，不会执行真正的函数部分。

7.mock的thenAnswer函数

虽然doReturn函数可以帮助我们返回想要的值，但是有时候根据业务逻辑，我们需要对参数进行判断，返回不同的值，怎么办呢。这时候就可以用thenAnswer函数。此接口允许通过InvocationOnMock参数与参数进行交互.此外,answer方法的返回值将是模拟方法的返回值。

  List mock=mock(List.class);
 @Test
    public void testMethod(){
        when(mock.get(anyInt())).thenAnswer(new Answer<Object>() {
            public Object answer(InvocationOnMock invocationOnMock) throws Throwable {
            //获取参数值
                Object[] args = invocationOnMock.getArguments();
                Integer a= (Integer) args[0];
                //根据参数值返回不同的数值
                if(a == 1){
                    return 99;
                }else {
                    return 10;
                }
            }
        });

注意： thenAnswer和doAnswer作用是一样的，只是使用方法（语法）不同，doAnswer语法：

 doAnswer(new Answer.....//方法和上面一样).when(mock).method();

8.mock的doCallRealMethod方法

thenCallRealMethod 可以用来重置 spy 对象的特定方法特定参数调用。例如我们声明了一个spy对象，但是spy对象调用的是函数的真实的方法，如果我们给spy对象赋了新的值，但是我们又想要原来对象真实的值，这时候用doCallRealMethod方法重置spy对象，恢复真实值。示例： 调用类：

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

测试方法：

    @Spy
    TestClass test;
    @Before
    public void setup() {
        //让注解生效
        MockitoAnnotations.initMocks(this);
    }
 	@Test
    public void testMethods(){
    assertEquals(3,test.add(1,2));
    //给1+2赋值为100
    when(test.add(1,2)).thenReturn(100);
    System.out.println(test.add(1,2));
    //调用真实值
    doCallRealMethod().when(test).add(1,2);
    System.out.println(test.add(1,2));
    }

输出结果：

注意：：和thenCallMethod用法一样，只不过语法有不同：

when(mock.method).thenCallMethod();

9.mock的reset方法

使用 reset 方法，可以重置之前自定义的返回值和异常。 用法：reset(对象)

例子：

@Test
    public void test() {
        List list= mock(List.class);
         // mock 对象方法的默认返回值是返回类型的默认值,默认值为null
        assertEquals(null, list.get(0));
        when(list.get(0)).thenReturn(100);
        // 设置让 list.get(0)返回 100
        // 重置 mock 对象，list.get(0)返回 null
        reset(list);
        assertEquals(null, list.get(0));
    }

这里注意，如果reset(spy对象)的话，其实和doCallRealMethod方法有异曲同工之妙，最后都会调用真实的方法，即重置spy对象。

10.使用 PowerMock mock 静态方法。

Mockito 也有一些局限性。例如：不能 mock 静态方法和私有方法。有关详细信息，请参阅 Mockito限制的常见问题解答。这个时候我们就要用到 PowerMock，PowerMock 支持 JUnit 和 TestNG，扩展了 EasyMock 和 Mockito 框架，增加了mock static、final 方法的功能。

首先需要引入 PowerMock 的依赖：

        <!-- PowerMock -->
        <dependency>
            <groupId>org.powermock</groupId>
            <artifactId>powermock-module-junit4</artifactId>
            <version>2.0.7</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.powermock</groupId>
            <artifactId>powermock-api-mockito2</artifactId>
            <version>2.0.7</version>
        </dependency>

接下来就能愉快的 mock 静态方法了。

@RunWith(PowerMockRunner.class)
@PrepareForTest({StringUtils.class})
public class UnitTest4 {

    @Test
    public void test() {
        mockStatic(StringUtils.class);
        when(StringUtils.getFilename(anyString())).thenReturn("localhost");
        Assert.assertEquals("localhost", StringUtils.getFilename(""));
    }
}

带参数的静态方法的Mocktio.mockStatic使用方法

    try (MockedStatic<需要模拟的静态方法的类名> mb = Mockito
            .mockStatic(需要模拟的静态方法的类名)) {
        mb.when(()->需要模拟的静态方法的类名.方法名(参数)).thenReturn(返回值);
        //注意：调用待测试方法的时候一定要在try里面写
    }

无参数的静态方法

    try (MockedStatic<需要模拟的静态方法的类名> mb = Mockito
            .mockStatic(需要模拟的静态方法的类名)) {
        mb.when(需要模拟的静态方法的类名::方法名).thenReturn(返回值);
        //注意：调用待测试方法的时候一定要在try里面写
    }

三、总结

通过以上使用，我们大致可以了解到mock对我们测试的具体帮助是什么，还有它的基本使用，当然它还有其它方法，只了解了一些最常用的测试方法，需要更深入了解还需要我们在写代码的过程中去探索，mock大大简化了我们写单元测试的复杂度，一些难引用的对象都可以通过mock来模拟。

小结：mock中doMethod和thenMethod区别，例如doThrow和thenThrow(当然这两个不止语法有区别，用法也有点区别，详情看上面的doThrow，其它方法基本就是语法上的差异比如doReturn和thenReturn等)： 语法：

List list=mock(List.class);
when(list.get(0)).thenThrow(new Exception());
//等同于(这两个稍有区别)
doThrow(new Exception()).when(list).get(0);