天天看點

Spring boot項目內建jacoco代碼覆寫率測試

1. 将Springboot項目打包

将需要做代碼覆寫率測試的子產品打成jar包

本例的打包位置

D:\Java\IDEA_WorkSpace\gitee\myweb\target\web.jar

2. 通路jacoco官網下載下傳并解壓最新包

http://www.eclemma.org/jacoco/

Spring boot項目內建jacoco代碼覆寫率測試

本例以jacoco-0.8.7版本為例,存放路徑

D:\jacoco-0.8.7\

3. 下載下傳并配置ant

  1. ant下載下傳位址::https://ant.apache.org/bindownload.cgi
Spring boot項目內建jacoco代碼覆寫率測試

下載下傳完解壓縮即可使用。

  1. 配置環境變量
    Spring boot項目內建jacoco代碼覆寫率測試

加上

D:\apache-ant-1.10.10\bin

,具體路徑根據你自己的ant檔案夾位置來定。

4. 進入ant/bin目錄,建立build.xml檔案

本文以apache-ant-1.10.10為例,位置放在

D:\apache-ant-1.10.10\

,在win10系統做的測試。

build.xml

<?xml version="1.0" encoding="UTF-8"?>
<project name="test" xmlns:jacoco="antlib:org.jacoco.ant" >
    <!--Jacoco的安裝路徑-->
  <property name="jacocoantPath" value="D:\jacoco-0.8.7\lib\jacocoant.jar"/>
  <!--最終生成.exec檔案的路徑,Jacoco就是根據這個檔案生成最終的報告的-->
  <property name="jacocoexecPath" value="D:\jacoco-0.8.7\target\jacoco.exec"/>
    <!--生成覆寫率報告的路徑-->
  <property name="reportfolderPath" value="D:\jacoco-0.8.7\report"/>
  <!--遠端tomcat服務的ip位址-->
  <property name="server_ip" value="127.0.0.1"/>
  <!--前面配置的遠端tomcat服務打開的端口,要跟上面配置的一樣-->
  <property name="server_port" value="6300"/>
  <!--源代碼路徑可以包含多個源代碼-->  
  <property name="webSrcpath" value="D:\Java\IDEA_WorkSpace\gitee\myweb\src\main\java" />  
 
  <!--.class檔案路徑可以包含多個-->
  <property name="webClasspath" value="D:\Java\IDEA_WorkSpace\gitee\myweb\target\classes"/>
 
 
  <!--讓ant知道去哪兒找Jacoco-->
  <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
      <classpath path="${jacocoantPath}" />
  </taskdef>
 
  <!--dump任務:
      根據前面配置的ip位址,和端口号,
      通路目标tomcat服務,并生成.exec檔案。-->
 
  <target name="dump">
      <jacoco:dump address="${server_ip}" reset="true" destfile="${jacocoexecPath}" port="${server_port}" append="false"/>
  </target>
 
  <!--jacoco任務:
      根據前面配置的源代碼路徑和.class檔案路徑,
      根據dump後,生成的.exec檔案,生成最終的html覆寫率報告。-->
 
  <target name="report">
      <delete dir="${reportfolderPath}" />
      <mkdir dir="${reportfolderPath}" />
 
      <jacoco:report>
          <executiondata>
              <file file="${jacocoexecPath}" />
          </executiondata>
 
          <structure name="JaCoCo Report">
              <group name="Launch related">  
             <!--此處配置classes檔案位址 -->       
                  <classfiles>
                      <fileset dir="${webClasspath}" />
                  </classfiles>
                  <!--此處配置源碼位址-->
                    <sourcefiles encoding="utf-8">
                      <fileset dir="${webSrcpath}" />
                  </sourcefiles>
              </group>
 
          </structure>
 
          <html destdir="${reportfolderPath}" encoding="utf-8" />        
      </jacoco:report>
  </target>
</project>
           

配置解釋

注意:其中幾個重要配置

jacocoexecPath:Jacoco的安裝路徑,這個很好了解就是Jacoco的包解壓縮的位置,注意文檔寫的是window路徑如果linux則要相應修改;

jacocoexecPath:最終生成.exec檔案的路徑,之後Jacoco就是根據這個檔案生成最終的報告;

reportfolderPath:生成報告的路徑,html格式報告;

server_ip:遠端tomcat服務的ip位址或spring boot啟動的伺服器位址;

server_port:伺服器端口,跟啟動tomcat或jar時的端口号相同即可;

webSrcpath:源代碼路徑,這裡就是demo的java檔案位址;

webClasspath:class檔案路徑,這裡就是demo編譯後的classes目錄。

5. 啟動Springboot jar包

java -javaagent:D:\jacoco-0.8.7\lib\jacocoagent.jar=includes=*,output=tcpserver,port=6300,address=127.0.0.1 -jar D:\Java\IDEA_WorkSpace\gitee\myweb\target\web.jar

6. 執行相應的測試用例

通過POSTMAN或頁面進行第五步啟動的項目的測試。

7. dump資訊

打開cmd控制台,執行

cd D:\apache-ant-1.10.10\bin\
ant dump
           

8. 生成報告

再執行

cd D:\apache-ant-1.10.10\bin
ant report
           

9. 檢視報告内容

進入目錄

D:\jacoco-0.8.7\report

打開index.html,如下圖:Missed是未覆寫的數量

Spring boot項目內建jacoco代碼覆寫率測試

注:如果出現亂碼可能因為build.xml配置檔案中字元集設定有問題,檢查 sourcefiles encoding 和 destdir="${reportfolderPath}" encoding,建議全部為

utf-8

點選進入可以檢視詳情

Spring boot項目內建jacoco代碼覆寫率測試

一路點選,進入代碼,可以看到哪些代碼使用了那些沒有使用

Spring boot項目內建jacoco代碼覆寫率測試