快捷導(dǎo)航

使用Jacoco獲取 Java 程序的代碼執(zhí)行覆蓋率的步驟詳解

更新時(shí)間：2021年03月03日 11:13:50 作者：robothy

這篇文章主要介紹了使用Jacoco獲取 Java 程序的代碼執(zhí)行覆蓋率的步驟詳解，幫助大家更好的理解和學(xué)習(xí)使用Java，感興趣的朋友可以了解下

Jacoco是Java Code Coverage的縮寫，顧名思義，它是獲取Java代碼執(zhí)行覆蓋率的一個(gè)工具，通常用它來(lái)獲取單元測(cè)試覆蓋率。它通過(guò)分析Java字節(jié)碼來(lái)得到代碼執(zhí)行覆蓋率，因此它還可以分析任何基于JVM的語(yǔ)言（如Croovy、Kotlin）的覆蓋率。本文不討論如何用Jacoco獲取單元測(cè)試的代碼覆蓋率，而是從Jacoco的原理出發(fā)，介紹如何通過(guò)Jacoco獲取SIT或者UAT的測(cè)試覆蓋率。更準(zhǔn)確來(lái)講，是獲取一個(gè)應(yīng)用執(zhí)行過(guò)的代碼占總代碼的比率。包括字節(jié)碼指令覆蓋率，分支覆蓋率，圈復(fù)雜度覆蓋率，行覆蓋率，方法覆蓋率和類覆蓋率。

Jacoco原理簡(jiǎn)介

Jacoco通過(guò)修改喂給JVM的字節(jié)碼來(lái)達(dá)到獲取那些代碼執(zhí)行了的目的。修改方式有兩種，一種在線（on-the-fly）,是通過(guò)Java agent，在JVM執(zhí)行字節(jié)碼之前動(dòng)態(tài)對(duì)其進(jìn)行修改，這種方式更靈活，也是Jcoco的一大特性。另一種是離線（offline）模式，在Java程序字節(jié)碼文件（.class文件）生成之前進(jìn)行修改，這樣的字節(jié)碼就不純了。一般在無(wú)法使用on-the-fly方式的時(shí)候才使用offline方式。

上面這些概括起來(lái)講，Jacoco最牛X的地方就在于它能夠知道一個(gè)基于JVM的應(yīng)用程序中哪些代碼（指令、分支、行、方法、類）被執(zhí)行了。用它除以總代碼量，就得到了代碼執(zhí)行覆蓋率。

由此，我們可以推斷出Jacoco生成單元測(cè)試覆蓋率報(bào)告的原理：?jiǎn)卧獪y(cè)試代碼會(huì)調(diào)用被測(cè)試代碼，被測(cè)試代碼的字節(jié)碼指令會(huì)被Jacoco截獲，用被截獲的代碼量除以總代碼量，就算出了單元測(cè)試代碼覆蓋率。舉一反三，在SIT或者UT的時(shí)候，也需要執(zhí)行Java應(yīng)用程序中的代碼，因此可以也通過(guò)Jacoco獲取被執(zhí)行過(guò)的代碼，從而計(jì)算出SIT，UT測(cè)試代碼覆蓋率。

使用Jacoco生成代碼執(zhí)行覆蓋率報(bào)告

接下來(lái)通過(guò)一個(gè)實(shí)驗(yàn)介紹如何使用Jacoco獲取一個(gè)Java web應(yīng)用代碼的執(zhí)行率。就拿Tomcat自帶的example應(yīng)用來(lái)做實(shí)驗(yàn)，我們?cè)趩?dòng)Tomcat時(shí)帶上Jacoco的Java agent；然后在頁(yè)面上做一些點(diǎn)擊操作，觸發(fā)后臺(tái)Java代碼的執(zhí)行；再抓取包含執(zhí)行情況數(shù)據(jù)，放到.exec的二進(jìn)制文件中；最后由這些二進(jìn)制文件生成html格式的報(bào)告，驗(yàn)證被覆蓋的代碼是否和我們點(diǎn)擊的內(nèi)容相關(guān)。

下載Jacoco（https://www.jacoco.org），解壓縮。

下載Tomcat（https://mirrors.tuna.tsinghua.edu.cn/apache/tomcat/ 清華mirror），然后解壓縮，進(jìn)入bin目錄，找到catalina.bat文件（Windows）。

修改如下代碼，讓Tomcat在啟動(dòng)時(shí)帶上Javacoco的agent。

set "JAVA_OPTS=%JAVA_OPTS% %JSSE_OPTS%"

修改為

set "JAVA_OPTS=%JAVA_OPTS% %JSSE_OPTS% -javaagent:C:\Users\Robot\Application\jacoco-0.8.5\lib\jacocoagent.jar=destfile=jacoco.exec,output=tcpserver"

其中指定了javaagent是C:\Users\Robot\Application\jacoco-0.8.5\lib\jacocoagent.jar，解壓Jacoco可以得到；指定了output是tcpserver，也就是需要通過(guò)訪問(wèn)一個(gè)地址才能獲取到數(shù)據(jù)。默認(rèn)地址是本地IP地址，端口號(hào)是6300。其它參數(shù)說(shuō)明見(jiàn)：https://www.jacoco.org/jacoco/trunk/doc/agent.html。

設(shè)置完成之后，雙擊Tomcat bin目錄下的startup.bat，啟動(dòng)Tomcat。控制臺(tái)可以看見(jiàn)javaagent設(shè)置生效。此時(shí)Jacoco就可以動(dòng)態(tài)地?cái)r截喂給JVM的字節(jié)碼，并且監(jiān)聽(tīng)6300端口號(hào)和所以本機(jī)地址，等待獲取代碼執(zhí)行情況數(shù)據(jù)（暫且稱為.exec文件數(shù)據(jù)）的請(qǐng)求。

輸入地址http://127.0.0.1:8080/ ，打開(kāi)Tomcat 歡迎頁(yè)面，做一些點(diǎn)擊操作，可以確定它已經(jīng)執(zhí)行了一些字節(jié)碼。

獲取執(zhí)行情況數(shù)據(jù)，在jacococli.jar所在目錄（與jacocoagent.jar目錄一致）執(zhí)行命令：

java -jar jacococli.jar dump --port 6300 --destfile data/jacoco-it.exec

Jacoco會(huì)在當(dāng)前目錄下生成data/jacoco-it.exec文件，這個(gè)文件是一個(gè)二進(jìn)制文件，我們無(wú)法直接查看它，需要用它生成html或者其它格式的文件。

執(zhí)行如下命令生成html報(bào)告。--classfiles制定應(yīng)用程序的class文件所在目錄，--html指定html報(bào)告所在目錄。

java -jar jacococli.jar report data/jacoco-it.exec --classfiles C:/Users/Robot/Application/apache-tomcat-9.0.29/webapps/examples/WEB-INF/classes --html html