其實(shí)基于jacoco來(lái)做Android端代碼覆蓋率的難點(diǎn)主要是各個(gè)項(xiàng)目的gradle插件依賴跟jacoco版本直接的兼容性問(wèn)題砰逻，特別是在以及開(kāi)發(fā)很多年的多模塊項(xiàng)目下颂砸，這個(gè)問(wèn)題尤為明顯蕴侣，另外網(wǎng)上雖然有很多相關(guān)的文章資料躏将，但是要么是gradle插件依賴版本太低京闰，要么就是jacoco版本、配置文件以及項(xiàng)目的開(kāi)發(fā)環(huán)境沒(méi)有說(shuō)清楚或者寫的有問(wèn)題掖肋，導(dǎo)致最終很難按照說(shuō)明完成接入仆葡。
我用的是gradle8.0.1版本比較新，應(yīng)該是目前gradle最新的版本志笼。

gradle插件版本：classpath 'com.android.tools.build:gradle:8.0.1'
gradle依賴版本：distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-bin.zip

我這里直接以多模塊項(xiàng)目為例沿盅，單模塊項(xiàng)目修改jacoco.gradle配置文件中的源碼路徑和class文件路徑即可。

第一步

在app模塊下新建一個(gè)jacoco.gradle文件纫溃，具體代碼如下所示：

apply plugin: 'jacoco'

android {
    buildTypes {
        debug {
            /**打開(kāi)覆蓋率統(tǒng)計(jì)開(kāi)關(guān)**/
            testCoverageEnabled = true
        }
    }
}

//源代碼路徑腰涧，有多少個(gè)module，就在這里寫多少個(gè)路徑紊浩，如果你只有app一個(gè)module窖铡，那么就寫一個(gè)就可以
def coverageSourceDirs = [
        '../app/src/main/java',
//        '../common/src/main/java',
]

//class文件路徑，如果你只有app一個(gè)module坊谁，那么就寫一個(gè)就可以
def coverageClassDirs = [
        '/app/build/intermediates/javac/debug/classes',
//       '/common/build/intermediates/javac/debug/classes',
]

//Jacoco 版本费彼，建議用這個(gè)版本兼容性比較好
jacoco {
    toolVersion = "0.8.2"
}

//生成報(bào)告task
task jacocoTestReport(type: JacocoReport) {
    group = "JacocoReport"
    description = "Generate Jacoco coverage reports after running tests."
    reports {
        //xml.enabled = true
        //html.enabled = true
        xml.required = true
        html.required = true
    }
    classDirectories.from = files(files(coverageClassDirs).files.collect {
        println("$rootDir" + it)
        fileTree(dir: "$rootDir" + it,
                // 過(guò)濾不需要統(tǒng)計(jì)的class文件
                excludes: ['**/R*.class',
                           '**/*$InjectAdapter.class',
                           '**/*$ModuleAdapter.class',
                           '**/*$ViewInjector*.class'
                ])
    })
    sourceDirectories.from = files(coverageSourceDirs)
    executionData.from = files("$buildDir/outputs/code-coverage/coverage.ec")

    doFirst {
        coverageClassDirs.each { path ->
            println("$rootDir" + path)
            new File("$rootDir" + path).eachFileRecurse { file ->
                if (file.name.contains('$$')) {
                    file.renameTo(file.path.replace('$$', '$'))
                }
            }
        }
    }
}

//初始化Jacoco Task
task jacocoInit() {
    group = "JacocoReport"
    doFirst {
        File file = new File("$buildDir/outputs/code-coverage/")
        if (!file.exists()) {
            file.mkdir();
        }
    }
}

其中class的文件路徑，具體跟gradle的版本有關(guān)口芍，需要查看你自己實(shí)際的路徑箍铲，如下圖：

然后在你的app模塊下的build.gradle文件中依賴這個(gè)jacoco.gradle，如下所示：

apply plugin: "com.android.application"

apply from: "$rootDir/gradle/base.gradle"
apply from: "../gradle/exported.gradle"

apply from: 'jacoco.gradle'

android {
  ...
}

我們?cè)僬硪粋€(gè)jacoco.gradle放在項(xiàng)目的根目錄作為通用配置阶界，內(nèi)容如下：

apply plugin: 'jacoco'
android {
    buildTypes {
        debug {
            /**打開(kāi)覆蓋率統(tǒng)計(jì)開(kāi)關(guān)**/
            testCoverageEnabled = true
        }
    }
}

如果需要統(tǒng)計(jì)子module中的代碼覆蓋率虹钮，那么需要在子module的build.gradle文件中添加如下依賴：

apply from: rootProject.file('jacoco.gradle')

第二步

定義一個(gè)JacocoHelper類，主要是用來(lái)生成ec文件膘融，根據(jù)使用場(chǎng)景可以放在你需要的地方芙粱，比如在APP內(nèi)提供一個(gè)按鈕，點(diǎn)擊觸發(fā)生成ec文件氧映，也可以通過(guò)命令行的方式觸發(fā)春畔，具體代碼如下：

package com.example.helper;

import android.os.Environment;
import android.util.Log;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;


public class JacocoHelper {

    private static final String TAG = "JacocoHelper";

    //ec文件的路徑
    private static final String DEFAULT_COVERAGE_FILE_PATH = Environment.getExternalStorageDirectory()
        .getPath() + "/coverage.ec";

    /**
     * 生成ec文件
     *
     * @param isNew 是否重新創(chuàng)建ec文件
     */
    public static void generateEcFile(boolean isNew) {
        OutputStream out = null;
        File mCoverageFilePath = new File(DEFAULT_COVERAGE_FILE_PATH);
        try {
            if (isNew && mCoverageFilePath.exists()) {
                Log.d(TAG, "清除舊的ec文件");
                mCoverageFilePath.delete();
            }
            if (!mCoverageFilePath.exists()) {
                mCoverageFilePath.createNewFile();
            }
            out = new FileOutputStream(mCoverageFilePath.getPath(), true);
            Object agent = Class.forName("org.jacoco.agent.rt.RT")
                .getMethod("getAgent")
                .invoke(null);
            if (agent != null) {
                out.write((byte[]) agent.getClass().getMethod("getExecutionData", boolean.class)
                    .invoke(agent, false));
            }
        } catch (Exception e) {
            Log.d(TAG, e.toString());
        } finally {
            try {
                if (out != null) {
                    out.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

}

在需要生成ec文件的地方調(diào)用下面的方法：

JacocoHelper.generateEcFile(true);

第三步 生成測(cè)試報(bào)告

通過(guò)上面的兩個(gè)步驟，我們就完成了Android項(xiàng)目的Jacoco配置，下面是如何使用它來(lái)獲取我們手工或者自動(dòng)化測(cè)試的代碼覆蓋率律姨。

首先我們可以通過(guò)Android Studio直接編譯安裝集成了Jacoco的Debug包振峻，然后再在項(xiàng)目的根目錄執(zhí)行下面的命令完成初始化：

./gradlew jacocoInit

接著我們就可以通過(guò)執(zhí)行自動(dòng)化測(cè)試腳本或者手工來(lái)開(kāi)始我們的用例測(cè)試了，測(cè)試完成后執(zhí)行下面的命令：

adb pull /storage/emulated/0/coverage.ec .

最后我們?cè)陧?xiàng)目根目錄執(zhí)行下面的命令來(lái)生成報(bào)告：

./gradlew jacocoTestReport

第四步 報(bào)告分析

第五步 落地場(chǎng)景

我們既然可以根據(jù)執(zhí)行的用例拿到代碼的覆蓋情況利诺，那么我們就可以基于這個(gè)數(shù)據(jù)來(lái)做度量和精準(zhǔn)測(cè)試了，比如：

1. 可以讓業(yè)務(wù)QA或者外包使用覆蓋率包來(lái)完成功能模塊的測(cè)試工作剩燥，這樣就可以根據(jù)生成的覆蓋率數(shù)據(jù)來(lái)度量測(cè)試效果了慢逾；

2. 另外在做精準(zhǔn)測(cè)試的時(shí)候，我們都需要維護(hù)用例和代碼的關(guān)系庫(kù)灭红，那么如何得到這個(gè)關(guān)系呢侣滩，這時(shí)候我們就可以通過(guò)在手工或者UI自動(dòng)化的方式執(zhí)行用例的過(guò)程中把每個(gè)用例跟對(duì)應(yīng)覆蓋的代碼類文件建立映射關(guān)系來(lái)完成初期的關(guān)系庫(kù)；