SpringBoot接入JaCoCo實踐教程

靜態接入和動態接入

SpingBoot可以通過2種方式接入JaCoCo：Maven和Agent。Maven方式是靜態接入，在編譯時計算代碼覆蓋率。Agent方式是動態接入，服務啟起來以后，能實時根據代碼命中情況計算代碼覆蓋率。

教程代碼已上傳開源項目：https://github.com/dongfanger/mini

Maven

pom.xml添加依賴：

<dependency>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.7</version>
</dependency>

添加配置：

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${project.parent.version}</version>
            </plugin>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.8.7</version>
                <executions>
                    <execution>
                        <id>default-prepare-agent</id>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>default-report</id>
                        <goals>
                            <goal>report</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

點擊maven的install：

target/site/jacoco目錄下就生成了覆蓋率報告：

Agent

下載jacoco文件后解壓，提取2個文件：

使用命令啟動SpringBoot，啟動參數添加-javaagent：

java -javaagent:jacoco/jacocoagent.jar -jar target/mini-0.0.1-SNAPSHOT.jar

此時會生成1個jacoco.exec文件，這個文件就是覆蓋率數據文件，采用以下命令根據數據文件生成HTML報告：

java -jar jacoco/jacococli.jar report jacoco.exec --classfiles ./target/classes/ --sourcefiles ./src/main/java/ --html ./report

接下來就來驗證動態特性。把report目錄和jacoco.exec都刪了，因為jacoco每次部署只能分析一次。把服務停掉后，重新啟動。這一次不直接分析，而是先用postman調一下接口：

然后再分析一把：

可以看到覆蓋率變成100%，說明postman調接口這個操作，命中了代碼，被jacoco統計到了。javaagent相當於是個代理，在服務運行期間，所有調用都會經過javagent，這樣就能實時統計代碼覆蓋率。換句話說，只要服務運行起來以后，只要你能命中代碼，無論是跑單元測試還是調接口，或者是手工測試，都能生成代碼覆蓋率數據。