Java Mockito 快速入门指南

在软件开发中,单元测试对于确保代码的正确性和可靠性至关重要。Mockito是一个强大的Java测试框架,它提供了丰富的功能和方法,使得编写模拟测试变得简单而高效。本文将介绍Mockito的基础使用方法,包括常用的方法和注解,并通过两个简单到困难的示例演示其用法。

常用方法

当使用Mockito进行单元测试时,以下是几个常用的Mockito方法和概念:

  • mock()/@Mock

    • Mock是指使用Mockito创建的模拟对象,它模拟真实对象的行为,用于替代真实对象的依赖项,以便进行独立的单元测试。
  • spy()/@Spy

    • Spy是指使用Mockito创建的部分模拟对象,它保留了真实对象的部分行为。Spy对象既可以模拟方法的返回值,也可以保留方法的实际行为。
  • @InjectMocks

    • @InjectMocks是一个Mockito注解,用于自动将模拟对象注入到被测对象中的相应字段中。
  • doReturn()

    • doReturn()方法用于为模拟对象设置方法调用的返回值,可以覆盖默认行为。
  • when()

    • when()方法用于指定模拟对象的方法调用,并设置相应的操作,例如返回值、异常等。
  • verify()

    • verify()方法用于验证模拟对象的方法是否被调用,并可以进一步验证方法的调用次数和参数。
  • Stub

    • Stub翻译成打桩,是指为模拟对象设置预定义的行为或返回值,使其在测试过程中按照期望的方式运行。

调用方式

在Mockito中,可以通过函数调用和注解两种方式来应用模拟对象。这两种方式在语法和使用上略有不同,下面将介绍它们的应用区别:

函数调用方式

使用函数调用方式,需要手动创建和管理模拟对象。
通过调用Mockito.mock()方法创建模拟对象,并使用各种when()、thenReturn()、verify()等函数来定义模拟对象的行为和验证。
函数调用方式更加灵活,可以在测试方法的任意位置创建和配置模拟对象。
示例代码:

List<String> mockedList = Mockito.mock(List.class);
Mockito.when(mockedList.get(0)).thenReturn("Mocked Value");
String result = mockedList.get(0);
Mockito.verify(mockedList).get(0);

注解方式

使用注解方式,可以通过注解来自动创建和注入模拟对象。
使用@Mock注解在测试类中声明模拟对象的字段,然后使用@InjectMocks注解将模拟对象自动注入到被测对象中。
注解方式更加简洁和便捷,省去了手动创建和配置模拟对象的步骤。

  • 需要注意,通过注解的方式,需要在 @Before test前显示声明 MockitoAnnotations.initMocks(this);

示例代码:

public class MyTestClass {
    @Mock
    private List<String> mockedList;
    
    @InjectMocks
    private MyClass myClass;
    
    @Before
    public void setup() {
        MockitoAnnotations.initMocks(this);
    }
    
    @Test
    public void testMethod() {
        Mockito.when(mockedList.get(0)).thenReturn("Mocked Value");
        String result = myClass.myMethod();
        Mockito.verify(mockedList).get(0);
    }
}

使用方法1

上面只是做了一个简单的介绍,下面我们结合一些例子来看看如何使用。

我们将创建一个示例来测试一个银行应用中的账户服务。假设我们有一个AccountService类,它依赖于AccountRepositoryNotificationService来执行一些操作。我们将使用Mockito来模拟这些依赖项,并测试AccountService的方法。

首先,让我们创建一个名为AccountService的类:

public class AccountService {
    private AccountRepository accountRepository;
    private NotificationService notificationService;

    public AccountService(AccountRepository accountRepository, NotificationService notificationService) {
        this.accountRepository = accountRepository;
        this.notificationService = notificationService;
    }

    public void deposit(String accountId, double amount) {
        Account account = accountRepository.findById(accountId);
        account.deposit(amount);
        accountRepository.save(account);
        notificationService.sendNotification("Deposit successful");
    }
}

接下来,我们将创建一个名为AccountRepository的接口和一个名为NotificationService的接口作为依赖项:

public interface AccountRepository {
    Account findById(String accountId);

    void save(Account account);
}

public interface NotificationService {
    void sendNotification(String message);
}

然后,我们编写一个测试类AccountServiceTest,使用Mockito来模拟AccountRepositoryNotificationService,并测试AccountServicedeposit()方法。

import org.junit.Assert;
import org.junit.Test;
import org.mockito.Mockito;

public class AccountServiceTest {
    
    @Test
    public void testDeposit() {
        // 创建模拟对象
        AccountRepository accountRepositoryMock = Mockito.mock(AccountRepository.class);
        NotificationService notificationServiceMock = Mockito.mock(NotificationService.class);
        
        // 创建被测对象并注入模拟对象
        AccountService accountService = new AccountService(accountRepositoryMock, notificationServiceMock);
        
        // 创建模拟账户
        Account account = new Account("1234567890", 1000.0);
        
        // 设置模拟对象的行为
        Mockito.when(accountRepositoryMock.findById("1234567890")).thenReturn(account);
        
        // 调用被测方法
        accountService.deposit("1234567890", 500.0);
        
        // 验证结果
        Assert.assertEquals(1500.0, account.getBalance(), 0.01);
        
        // 验证模拟对象的方法是否被调用
        Mockito.verify(accountRepositoryMock).save(account);
        Mockito.verify(notificationServiceMock).sendNotification("Deposit successful");
    }
}

在这个示例中,我们首先使用Mockito.mock()方法创建了一个名为accountRepositoryMock的模拟对象和一个名为notificationServiceMock的模拟对象。然后,我们创建了AccountService的实例,并使用模拟对象进行依赖项注入。

接下来,我们创建了一个名为account的模拟账户,并使用Mockito.when().thenReturn()方法为模拟对象的findById()方法设置了存根,以返回模拟账户。然后,我们调用accountService.deposit()方法进行测试,并使用Assert.assertEquals()方法验证账户的余额是否正确更新。

最后,我们使用Mockito.verify()方法验证模拟对象的save()方法和sendNotification()方法是否被调用。

通过这个示例,我们演示了如何使用Mockito的函数调用方式进行复杂的模拟测试。使用Mockito的各种函数,我们可以方便地设置模拟对象的行为、验证方法的调用,并确保被测代码的正确性。

使用方法2

当使用Spring Boot进行开发时,我们经常会使用 @Component 或者 @Autowired 的方式进行开发,下面介绍如何使用Mockito和注解的方式来对带有依赖注入的Spring组件进行测试。

下面是一个示例,展示了如何使用Mockito和注解对带有依赖注入的AccountService进行测试。

首先,让我们定义AccountService类并添加@Component注解:

@Component
public class AccountService {
    @Autowired
    private AccountRepository accountRepository;
    @Autowired
    private NotificationService notificationService;

    public void deposit(String accountId, double amount) {
        Account account = accountRepository.findById(accountId);
        account.deposit(amount);
        accountRepository.save(account);
        notificationService.sendNotification("Deposit successful");
    }
}

接下来,我们将编写一个名为AccountServiceTest的测试类,使用Mockito和注解对AccountService进行测试。

import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;

@RunWith(MockitoJUnitRunner.class)
public class AccountServiceTest {
    @Mock
    private AccountRepository accountRepositoryMock;
    
    @Mock
    private NotificationService notificationServiceMock;

    @InjectMocks
    private AccountService accountService;

    @Test
    public void testDeposit() {
        // 创建模拟账户
        Account account = new Account("1234567890", 1000.0);
        
        // 设置模拟对象的行为
        Mockito.when(accountRepositoryMock.findById("1234567890")).thenReturn(account);
        
        // 调用被测方法
        accountService.deposit("1234567890", 500.0);
        
        // 验证结果
        Assert.assertEquals(1500.0, account.getBalance(), 0.01);
        
        // 验证模拟对象的方法是否被调用
        Mockito.verify(accountRepositoryMock).save(account);
        Mockito.verify(notificationServiceMock).sendNotification("Deposit successful");
    }
}

在这个示例中,我们使用了@RunWith(MockitoJUnitRunner.class)注解来启用Mockito框架的支持。这个注解会为我们自动初始化模拟对象和被测对象。

使用@Mock注解,我们创建了名为accountRepositoryMocknotificationServiceMock的模拟对象。使用@InjectMocks注解,我们将这些模拟对象注入到accountService对象中。

然后,我们使用Mockito.when().thenReturn()方法设置模拟对象的行为,并调用accountService.deposit()方法进行测试。最后,我们使用Assert.assertEquals()方法验证结果,并使用Mockito.verify()方法验证模拟对象的方法是否被调用。

通过这个示例,我们展示了如何使用Mockito和注解的方式对带有依赖注入的Spring组件进行测试。Mockito和注解的结合可以方便地创建和注入模拟对象,使测试更加简洁和可读。

以上就是一些Java Mockito的简单使用方法啦~ 如有问题,欢迎来交流~

Reference

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,923评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,154评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,775评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,960评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,976评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,972评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,893评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,709评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,159评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,400评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,552评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,265评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,876评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,528评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,701评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,552评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,451评论 2 352

推荐阅读更多精彩内容