Junit Mockito 的使用记录

以下内容不会涉及其中原理，只使用简单的、可能不正确的叙述来帮助理解方法的表现作用。

1. Mockito.mock 和 Mockito.spy 的不同

Mockito.mock 通常的用法是：A obj = Mockito.mock(A.class);
Mockito.spy 通常的用法是：A obj = Mockito.spy(new A());

Mockito.spy()与new的区别在于，spy()包装后的对象，可以使用Mockito.when()、Mockito.verify()对此对象的方法调用进行设定与验证

Mockito.mock() 创建出来的对象，在调用该对象中的某个方法时，不会执行其它方法。
Mockito.spy() 创建出来的对象，在调用该对象中的某个方法时，会执行其它方法。

  • 结合示例说明使用效果：
1. UserService service = Mockito.mock(UserServiceImpl.class);
2. service.deleteById(1);

3. UserService service = Mockito.spy(new UserServiceImpl());
4. service.deleteById(1);

class UserService {
  public int deleteById(long id) {
    User u = this.selectById(id);
    if (u != null) {
      return this.mapper.deleteById(id);
    }
    // do something
  }
  
  public User selectById(long id) {
        // do something
    }
}

对于 Mockito.mock 而言
第1行代码，使用Mockito.mock()创建出一个UserService对象。
第2行代码，对于deleteById()中涉及到的对this.selectById、this.mapper.deleteById的调用不会执行内部的逻辑，且不会有返回值。

对于 Mockito.spy 而言
第3行代码，使用Mockito.spy()包装了一下开发者自己创建的UserService对象。
第4行代码，对于deleteById()中涉及到的对this.selectById、this.mapper.deleteById的调用会执行内部的逻辑。

基于单元测试的基本思想——自扫门前雪，被测试的方法不应该因为外部方法的逻辑报错而测试失败。
因此 Mockito.mock() 是常用的。

但Mockito框架不能完成对private方法的测试（被认为具有破坏性），而为了达到测试private方法的目的，可以使用一个public方法作为引子，再结合 Mockito.spy() 完成此目的。
Mockito.spy() 不常用但会用到，
它引发的整个方法链路的调用，这破坏了单元测试的基本思想，但也弥补了 Mockito.mock() 做不到的事情。

2. @Mock 与 @Spy 的不同

这两个注解是Mockito.mock 和 Mockito.spy的注解版，可以像使用依赖注入一样在类中定义为类属性。
达到的作用是一样的。

public class UserServiceImplTest {
  @Mock / @Spy
  UserServiceImpl userService;
}

@InjectMocks 的作用类似于Spring中的@Autowired

@Spy
@InjectMocks
private CommandManager commandManager;

CommandManager 构造函数中需要的参数，会从其它@Mock、@Spy的对象中自动选取。

3. Mockito.when().thenXX() 的使用（作用：模拟方法调用）

这个方法对于 Mockito.mock()、Mockito.spy() 没有区别，都能起到一样的作用。

这里还是要基于 标题1 中的示例进行使用说明

class UserService {
  public int deleteById(long id) {
    User u = this.selectById(id);
    if (u != null) {
      return this.mapper.deleteById(id);
    }
    // do something
  }
  
  public User selectById(long id) {
        // do something
    }
}

回到单元测试的基本思想——自扫门前雪上，
开发者A测试deleteById()时，不想关注外部方法的逻辑，只想保证内部的判断、步骤的执行顺序正确，
但判断的执行条件需要其它方法的返回值（如：u != null）,
为了能不受外部方法牵连、扯后腿，又能够模拟外部方法的执行结果，就需要用到Mockito.when().thenXX()

  • 结合使用示例进行说明
1. UserService userService = Mockito.mock(UserService.class);
2. Mockito.when(userService.selectById(1)).thenReturn(new User()); // 声明：当调用目标方法的行为发生后，执行指定的return行为。
3. Mockito.when(userService.selectById(2)).thenReturn(new User());
4. userService.deleteById(1);

第4行代码，在运行到方法内部，需要去执行User u = this.selectById(id)时，会触发第2行代码声明的行为（不会触发第3行的声明，因为参数不对应）

因此，灵活地使用Mockito.when().thenXX()，对于目标方法的单元测试，就能够起到忽视外部因素影响的作用，专心擦自己的屁股。
when().thenReturn()、when().thenThrow()、when().thenAnswer() 都是类似的效果，
即：当when()声明的行为发生后，执行自定义的then操作

4. Mockito.doXXX().when().xxx() 的使用（作用：模拟方法调用）

其使用思路与 Mockito.when().thenXX() 一致
Mockito.when().thenXX() 要求目标测试方法不能使用 void 作为方法返回值；
Mockito.doXXX().when().xxx() 没有这个要求，如果目标测试方法的返回void，使用doNothing()即可。

  • 使用示例
1. UserService userService = Mockito.mock(UserService.class);
2. Mockito.doReturn(new User()).when(userService).selectById(1);
3. userService.deleteById(1);

此示例的执行效果与 标题3 中的示例，是一样的执行效果。

5. Mockito.anyXX() 的使用（作用：模拟参数）

在上面的 标题3、标题4 的实例中，方法的参数都是指定的常量，但系统在上线使用时参数约等于随机的，
因此指定常量作为参数的测试，是容易有测试盲点的。

而 Mockito.anyXX() 可以解决这个问题

Mockito.doReturn(new User()).when(userService).selectById(1);
变更为
Mockito.doReturn(new User()).when(userService).selectById(Mock.anyLong());

这样的变更，表示只要调用了selectById，不管selectById的传入参数是什么，都会触发之前声明的行为。

6. Mockito.verify().xxx() 的使用（作用：验证设想）

类似于Assertions.assertXXX()，只不过是对方法调用层面的验证。
通常用于验证程序是否按要求退出、条件判断是否写反、条件判断的逻辑是否如预期那样执行。

通常用法为：
Mockito.verify(userService, Mockito.never()).selectById(Mockito.any()); // 目标方法在测试中是否从来没执行
Mockito.verify(userService, Mockito.times(1)).selectById(Mockito.any()); // 目标方法在测试中是否只执行了1次
  • 结合使用示例进行说明
// 基础类结构
class ServiceA {
  public void a(int i) {
    if (i == 1) {
      this.b()
    }
    // do something
  }

  public void b() {
    // do something
  }
}

// 测试代码的编写
@Test
void testA() {
  ServiceA service = Mockito.mock(ServiceA.class);

  service.a(1);
  Mockito.verify(service, Mockito.times(1)).b(); // 当a方法的传入值为1时，是否执行了一次b方法

  service.a(2);
  Mockito.verify(service, Mockito.never()).b(); // 当a方法的传入值为2时，是否从不执行b方法
}

7. Mockito.mockStatic() 的使用（作用：模拟静态方法调用）

类似于 Mockito.mock() + Mock.when() 或 Mockito.mock() + Mock.verify() 的用法

Mockito.mockStatic()在使用后必须调用close()方法关闭，因此最好以try(xx) {}的方式使用;
Mockito.mockStatic()使用when()须在后面跟thenXXX();
目标静态方法无返回值时, when()后不能用thenReturn()，但可以用thenThrow();
Mockito.mockStatic()是范围工作的 ，因此，调用此静态方法的目标代码必须在其生效范围内编写;

  • 示例1 - 有返回值的静态方法
try (MockedStatic<NettyChannelMap> mockStatic = Mockito.mockStatic(NettyChannelMap.class)) {
  mockStatic.when(() -> NettyChannelMap.getEquipmentChannel(Mockito.anyString())).thenReturn(new NioSocketChannel());

  southboundDataService.handleCommandRequest1(equipmentCode, reboot); // 要测试的目标方法
}
  • 示例2 - 无返回值的静态方法
try (MockedStatic<ProtocolDataHandler> mockStatic = Mockito.mockStatic(ProtocolDataHandler.class);) {
  commandManager.control(cc);
  
  mockStatic.verify(() -> ProtocolDataHandler.sendDown(Mockito.any(), Mockito.anyInt()), Mockito.times(1));
}

8. 模拟内部类的对象 与 类内部的属性的使用

public class  A {
  @Getter
  public B b = new B();
 
  public void a() {
    this.getB().b();
  } 

  public static class B {
    public void b() {}
  }
}

在如上的代码中，想要模拟b.b()的调用需要使用如下的测试代码

@Spy / @Mock
private A a;

@Test
public void testA() {
  A.B b = Mockito.mock(A.B.class);

  Mockito.when(a.getB()).thenReturn(b);
  Mockito.doNothing().when(b).b();

  a.a();

  Mockito.verify(b, Mockito.time(1)).b();
}

9. Mockito 模拟与忽略 Thread.sleep() 或 TimeUtil.XXX.sleep()

默认情况下，Mockito是不允许模拟Thread的，因此需要增设一个自己的类来包裹Thread.sleep()操作

public class Sleeper {

    public static void sleep(TimeUnit timeUnit, long val) throws InterruptedException {
        timeUnit.sleep(val);
    }
}

在业务代码需要使用 sleep 的地方，替换为使用Sleeper.sleep()来完成目的。
再测试时，使用Mockito.mockStatic(Sleeper.class)的操作来代替对Thread或者TimeUtil的模拟。

try (MockedStatic<Sleeper> mockStatic = Mockito.mockStatic(Sleeper.class)) {
  // ... 测试逻辑
  
  mockStatic.verify(() -> Sleeper.sleep(Mockito.any(), Mockito.anyLong()), Mockito.never());
}

10. 不要模拟无限循环

对于无限循环，应该将循环内部的代码放入单独的方法中，测试时，使用Mockito对这个单独出来的方法进行测试。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 212,542评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,596评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 158,021评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,682评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,792评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,985评论 1赞 291
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,107评论 3赞 410
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,845评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,299评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,441评论 4赞 333
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,072评论 3赞 317
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1赞 267
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2赞 362
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2赞 350