Android使用acoco统计代码行覆盖率介绍

来源：jb51　　时间：2021/12/9 18:02:40　　对本文有异议

前言

jacoco是Java Code Coverage的缩写，是Java代码覆盖率统计的主流工具之一。关于jacoco的原理介绍，在网上有很多文章，感兴趣的同学可以去找别的博客看看，这里不做赘述。
最近接到这个需求，需要提升代码单测覆盖率并统计上传，了解到的实现方式是jacoco+Squaretest插件，在网上查了不少的资料，不得不说网上大部分的资料都非常老了，gradle插件一般都是2.3的，导致很多类文件路径错误，浪费了我很多时间，就算有比较新的博文，也大都是需要安装运行之后从手机存储再提取相应的ec文件来执行分析才能得出结果，我们这边目标是有脚本直接可以执行获取相应的文件来统计并自动上传，所以那种需要运行之后再提取相应的文件解析不是很方便，而且这种方案在不同手机上可能还会带来各种问题，于是，在我经过一番实践后终于实现了无需运行只需执行gradle task便可得到覆盖率文件，决定分享一下，为日后有需求的同学节省一些时间！

正文

请根据以下步骤细心耐心进行配置，中间如果出现任何错误都会影响到最后覆盖率文件的生成！

1、项目 build.gradle

在项目的 build.gradle 中引入 jacoco core 依赖：

、、、
 
buildscript {
    repositories {
       、、、
        maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
    }
 
    dependencies {
        、、、
        classpath 'com.android.tools.build:gradle:3.2.1' //可具体配置 本教程务必使用3.2以上
        classpath "org.jacoco:org.jacoco.core:0.8.5"
    }
}
、、、

2、jacoco-report.gradle

在项目根目录新建一个 jacoco-report.gradle 文件，其中主要定义了一个 Gradle 任务：jacocoCoverageTestReport。代码如下：

apply plugin: 'jacoco'
 
tasks.withType(Test) {
    jacoco.includeNoLocationClasses = true
}
 
ext {
    getFileFilter = { ->
        def jacocoSkipClasses = null
        if (project.hasProperty('jacocoSkipClasses')) {
            jacocoSkipClasses = project.property('jacocoSkipClasses')
        }
        //忽略类文件配置
        def fileFilter = ['**/R.class', '**/R$*.class', '**/BuildConfig.*', '**/Manifest*.*', '**/*$ViewInjector*.*']
        if (jacocoSkipClasses != null) {
            fileFilter.addAll(jacocoSkipClasses)
        }
        return fileFilter
    }
}
 
task jacocoTestReport(type: JacocoReport, dependsOn: ['testCoverageDebugUnitTest', 'createCoverageDebugCoverageReport']) {
    group = "Reporting"
    description = "Generate Jacoco coverage reports"
    reports {
        xml {
            enabled = true
            xml.destination file("build/reports/jacoco/jacoco.xml")
        }
        html {
            enabled = true
            html.destination file("build/reports/jacoco")
        }
    }
 
    def fileFilter = project.getFileFilter()
    //检测覆盖率的class所在目录(以项目class所在目录为准)
    //gradle2.3 class所在目录
    def coverageDebugTree = fileTree(dir: "$project.buildDir/intermediates/classes/coverageDebug", excludes: fileFilter)
    //gradle3.2 class所在目录
    def coverageDebugTreeNewGradle = fileTree(dir: "$project.buildDir/intermediates/javac/debug/compileDebugJavaWithJavac/classes", excludes: fileFilter)
    def mainSrc = "$project.projectDir/src/main/java"
 
    //设置需要检测覆盖率的目录
    sourceDirectories = files([mainSrc])
    //兼容gradle版本
    classDirectories = files([coverageDebugTree, coverageDebugTreeNewGradle])
    //以下路径也需要检查
    executionData = fileTree(dir: project.buildDir, includes: [
            'jacoco/testCoverageDebugUnitTest.exec', 'outputs/code-coverage/debugAndroidTest/connected/coverage.ec'
    ])
}

注意以上注释的位置，每一个配置务必仔细检查路径是否正确且存在！

3、 app/*module的build.gradle

在你需要统计的 app或者某 module 对应的 build.gradle 中进行 jacoco 任务配置：

引入上面新建的 jacoco-report.gradle；
添加 coverageDebug BuildType。
代码如下：

apply plugin: 'com.android.library'
apply from: '../jacoco-report.gradle'
 
android {
   、、、
 
    defaultConfig {
        、、、
 
        testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
    }
    lintOptions {
        、、、
        abortOnError false
    }
 
    buildTypes {
        、、、
        coverageDebug {
            minifyEnabled false
            testCoverageEnabled true
        }
    }
    testOptions {
        unitTests.all {
            jvmArgs '-noverify'
        }
        unitTests {
            includeAndroidResources = true
        }
 
        unitTests.returnDefaultValues = true
    }
  、、、
}
 
dependencies {
    、、、
    testImplementation 'junit:junit:4.12'
 
    //单元测试
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
    testImplementation 'org.robolectric:robolectric:4.3.1'
    testImplementation "org.robolectric:shadows-multidex:4.3"
    testImplementation 'org.hamcrest:hamcrest-all:1.3'
 
    // power mockito
    testImplementation 'org.mockito:mockito-core:2.8.9'
    testImplementation "org.powermock:powermock-api-mockito2:1.7.4"
    testImplementation "org.powermock:powermock-module-junit4:1.7.4"
    testImplementation "org.powermock:powermock-module-junit4-rule:1.7.4"
    testImplementation "org.powermock:powermock-classloading-xstream:1.7.4"
}

4、测试用例

在需要测试的对应 module 的 src/test/ 目录下编写对应的代码测试用例，建议使用 Squaretest插件生成，使用方式请自行搜索，基本没什么坑，这里不再赘述。

5、运行 task jacocoTestReport

task路径

在 Android Studio 的 Gradle 任务窗格中，找到 project/module/Tasks/reporting/jacocoTestReport 这个任务，双击运行，即可生成代码行覆盖率报告。

5、查看报告

打开 project/module/build/reports/jacoco/index.html文件，即可查看各个代码文件的行覆盖率。

报告路径

覆盖率报告用浏览器打开后一般如下：

覆盖率报告

6、小花招：快速提升代码覆盖率

根据覆盖率报告将覆盖率低的类忽略，具体可查看步骤2代码的第一个注释处

、、、
//忽略类文件配置
def fileFilter = ['**/R.class', '**/R$*.class', '**/BuildConfig.*', '**/Manifest*.*', '**/*$ViewInjector*.*'
//继续添加想要被忽略的低覆盖率的类
'**/ClassA.class','**/ClassB.class'、、、
]
、、、