Java單元測試Powermockito和Mockito使用總結

Posted on by

最近公司在推進Java應用的單元測試，要求將單元測試的覆蓋率提高到50%以上，保證上線代碼充分自測。公司單元測試框架選用瞭Junit 4.12，Mock框架選用瞭Mockito和PowerMock，同時選用JaCoCo來做覆蓋率檢測，下面詳細介紹一下我在使用這幾個框架的一些經驗。

依賴引入

<dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-core</artifactId>
    <version>2.8.9</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.powermock</groupId>
    <artifactId>powermock-module-junit4</artifactId>
    <version>1.7.4</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.powermock</groupId>
    <artifactId>powermock-api-mockito2</artifactId>
    <version>1.7.4</version>
    <scope>test</scope>
</dependency>

PowerMockito的使用

Mockito、EasyMock、JMock等比較流行Mock框架有個共同的缺點，都不能mock靜態、final、私有方法等，而PowerMock可以完美解決以上框架的不足，接下來讓我們看看無所不能的PowerMock是如何解決上述問題，我們先從一個實例來看，下面的代碼是需要單測的類，被測類中既有對Spring Bean的調用，同時又包含對Redis的靜態讀取，另外還有getInstance()單例類的使用，現在，我們一一來mock上述的外部類。

被單測類（主要測試queryStudentScoreByKeyword方法） 

@Component
public class StudentService {

    @Resource
    private StudentDao studentDao;

    public List<StudentBo> queryStudentScoreByKeyword(String name) {
        System.out.println("invoke StudentService.queryStudentScoreByKeyword ...");

        List<StudentBo> cacheList = RedisUtils.getArray(name, StudentBo.class);
        if (CollectionUtils.isNotEmpty(cacheList)) {
            return cacheList;
        }
        String keyword = processKeyword(name);
        List<Student> students = studentDao.queryStudentByKeyWord(keyword);
        List<Integer> ids = students.stream().map(Student::getId).collect(Collectors.toList());
        List<Person> personList = SchoolManageProxy.getInstance().queryPerson(ids);

        List<StudentBo> studentBos = CommonUtils.toBo(personList, students);
        // 高亮結果
        highlightResult(studentBos, name);
        // 緩存到Redis
        RedisUtils.setArray(name, studentBos, 10 * 60);
        return studentBos;
    }

    private String processKeyword(String name) {
        System.out.println("invoke StudentService.processKeyword ...");
        String newName = name;
        // do somethings
        return newName;
    }

    private void highlightResult(List<StudentBo> result, String name) {
        System.out.println("invoke StudentService.highlightResult ...");
        // do keyword highlight
    }

}

單測類 

@RunWith(PowerMockRunner.class)
@PrepareForTest({SchoolManageProxy.class, RedisUtils.class, StudentService.class})
// @PowerMockIgnore({"javax.management.*", "javax.net.ssl.*"})
@SuppressStaticInitializationFor({"cn.ganzhiqiang.ares.unittest.SchoolManageProxy"})
public class StudentServiceTest {

    @Mock
    private StudentDao mockStudentDao;

    @InjectMocks
    private StudentService studentServiceUnderTest;

    @Before
    public void setUp() {
        initMocks(this);
    }

    @Test
    public void testQueryStudentScoreByKeyword() throws Exception {
        studentServiceUnderTest = PowerMockito.spy(studentServiceUnderTest);
        PowerMockito.mockStatic(RedisUtils.class);
        PowerMockito.mockStatic(SchoolManageProxy.class);

        // mock單例調用
        SchoolManageProxy mockSchoolManageProxy = PowerMockito.mock(SchoolManageProxy.class);
        PowerMockito.when(SchoolManageProxy.getInstance()).thenReturn(mockSchoolManageProxy);
        when(mockSchoolManageProxy.queryPerson(anyList())).thenReturn(Collections.emptyList());

        // mock掉對Redis的靜態調用
        PowerMockito.when(RedisUtils.getArray(eq("tom"), eq(StudentBo.class))).thenReturn(Collections.emptyList());
        // 顯示的mock掉靜態的void的方法（可以不mock）
        PowerMockito.doNothing().when(RedisUtils.class, "setArray", anyString(), anyList(), anyInt());

        // mock私有方法processKeyword
        PowerMockito.doReturn("tom").when(studentServiceUnderTest, "processKeyword", anyString());

        // 跳過私有方法highlightResult的執行
        PowerMockito.suppress(PowerMockito.method(StudentService.class, "highlightResult"));

        // 使用Mockito來mock服務的調用
        when(mockStudentDao.queryStudentByKeyWord(anyString())).thenReturn(Collections.emptyList());

        // Run the test
        final List<StudentBo> result = studentServiceUnderTest.queryStudentScoreByKeyword("tom");

    }
}

使用mockito來mock實例

首選我們先用Mockito來mock對Spring Bean的調用，Mockito.mock可以mock一個實例，我們這裡選用@Mock註解，效果是一樣的。 

// 使用Mockito來mock服務的調用 
when(mockStudentDao.queryStudentByKeyWord(anyString())).thenReturn(Collections.emptyList());

mock對Redis的靜態調用

接下來我們使用PowerMock來mock對靜態方法的調用，註意需要將RedisUtils類，加入@PrepareForTest註解中，我們既mock瞭getArray方法，也mock瞭setArray方法，其實setArray不需要mock這裡顯式的mock瞭 

PowerMockito.mockStatic(RedisUtils.class);
// mock掉對Redis的靜態調用
PowerMockito.when(RedisUtils.getArray(eq("tom"), eq(StudentBo.class))).thenReturn(Collections.emptyList());
// 顯式的mock掉靜態的void的方法（可以不mock）
PowerMockito.doNothing().when(RedisUtils.class, "setArray", anyString(), anyList(), anyInt());

mock單例類

mock單例類相對來說復雜一點，邏輯上先用Powermock mock出單例類，然後再給單例類的getInstance方法打樁，返回之前mock，再對mock類實際調用的方法打樁即可，代碼如下 

PowerMockito.mockStatic(SchoolManageProxy.class);
// Powermock mock出單例類
SchoolManageProxy mockSchoolManageProxy = PowerMockito.mock(SchoolManageProxy.class);
// 給單例類的getInstance方法打樁

PowerMockito.when(SchoolManageProxy.getInstance()).thenReturn(mockSchoolManageProxy);
// 對mock類queryPerson的方法打樁
when(mockSchoolManageProxy.queryPerson(anyList())).thenReturn(Collections.emptyList());

mock私有方法

可以看到queryStudentScoreByKeyword方法調用瞭該類的私有方法processKeyword，如果該方法耗時過長，使用powermock也可以mock該私有方法，需要註意的studentServiceUnderTest需要用spy()來mock 

// mock 實例
// spy的標準是：如果不打樁，默認執行真實的方法，如果打樁則返回樁實現。
studentServiceUnderTest = PowerMockito.spy(studentServiceUnderTest);
// mock私有方法processKeyword
// doReturn(...) when(...)不做真實調用，但是when(...) thenReturn(...)還是會真實調用原方法，隻是返回瞭指定的結果
PowerMockito.doReturn("tom").when(studentServiceUnderTest, "processKeyword", anyString());

PowerMock跳過方法執行

使用PowerMock也可以跳過私有方法的執行 

// 跳過私有方法highlightResult的執行
PowerMockito.suppress(PowerMockito.method(StudentService.class, "highlightResult"));

總結

筆者之前寫代碼很少會寫單測，自從公司強制要求提高單測覆蓋率之後，雖然開發效率變慢瞭，但是確實引起我對單測的重視，進而研究瞭一下PowerMockito、Mokcito等Mock框架。Powermock之所以無所不能，是因為它使用瞭自定義的加載器和字節碼操作技術，與此同時，它還十分簡單易用，確實是個很優秀的框架。

Demo地址：https://github.com/LJWLgl/mock-data

參考文檔

PowerMock
powermockito單元測試之深入實踐
淺談測試之PowerMock
無所不能的PowerMock，mock私有方法，靜態方法，測試私有方法，final類
Mock和Spy的區別

到此這篇關於Java單元測試Powermockito和Mockito使用總結的文章就介紹到這瞭,更多相關Java Powermockito和Mockito 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：