使用Android Studio Lint静态分析(三)

主要内容

1. 在终端通过Gradle命令执行Lint检查。
2. 在编译时进行lint检查。

• Android Studio中Project目录下有两个文件gradlew和gradlew.bat分别是在Mac/Linux系统和Windows系统上的Gradle命令工具。在Mac系统Project目录下执行./gradlew -p ${module_dir} lint命令，就可以执行对指定module按照Android Studio默认支持的扫描规则进行Lint检查。

• Gradle提供了名为lintOptions的插件对Lint扫描进行个性化配置。

Gradle文件中的Lint配置

在${module_dir}/build.gradle文件android块内使用DSL对象lintOptions对Lint进行配置，配置项可以参考Android Plugin DSL Reference: LintOptions。

android {
    lintOptions {
        // true--关闭lint报告的分析进度
        quiet true
        // true--错误发生后停止gradle构建
        abortOnError false
        // true--只报告error
        ignoreWarnings true
        // true--忽略有错误的文件的全/绝对路径(默认是true)
        //absolutePaths true
        // true--检查所有问题点，包含其他默认关闭项
        checkAllWarnings true
        // true--所有warning当做error
        warningsAsErrors true
        // 关闭指定问题检查
        disable 'TypographyFractions','TypographyQuotes'
        // 打开指定问题检查
        enable 'RtlHardcoded','RtlCompat', 'RtlEnabled'
        // 仅检查指定问题
        check 'NewApi', 'InlinedApi'
        // true--error输出文件不包含源码行号
        noLines true
        // true--显示错误的所有发生位置，不截取
        showAll true
        // 回退lint设置(默认规则)
        lintConfig file("default-lint.xml")
        // true--生成txt格式报告(默认false)
        textReport true
        // 重定向输出；可以是文件或'stdout'
        textOutput 'stdout'
        // true--生成XML格式报告
        xmlReport false
        // 指定xml报告文档(默认lint-results.xml)
        xmlOutput file("lint-report.xml")
        // true--生成HTML报告(带问题解释，源码位置，等)
        htmlReport true
        // html报告可选路径(构建器默认是lint-results.html )
        htmlOutput file("lint-report.html")
        //  true--所有正式版构建执行规则生成崩溃的lint检查，如果有崩溃问题将停止构建
        checkReleaseBuilds true
        // 在发布版本编译时检查(即使不包含lint目标)，指定问题的规则生成崩溃
        fatal 'NewApi', 'InlineApi'
        // 指定问题的规则生成错误
        error 'Wakelock', 'TextViewEdits'
        // 指定问题的规则生成警告
        warning 'ResourceAsColor'
        // 忽略指定问题的规则(同关闭检查)
        ignore 'TypographyQuotes'
    }
}

部分配置项的说明

下面前三条所涉及的配置项，后面跟的参数都是issue_id，这些ID值跟lint.xml文件中使用的ID是同一个集合。

1. 检查结果警报级别四个：fatal、error、warning、ignore。
2. 检查结果输出方式三种：textReport、htmlReport、xmlReport，每一种都有开关并可以指定输出位置。后两种默认放在${module_dir}/build/reports/目录下。
3. enable、disable是对某些检查做临时的开关设置。
4. lintConfig指定一个lint文件，文件的内容格式与使用Android Studio Lint静态分析(二)中的lint.xml一样，文件名不必指定为lint.xml，文件路径传给lintConfig的file做参数。

配置本地编译时执行lint检查

配置Gradle脚本可实现编译Android工程时执行Lint检查：好处是既可以尽早发现问题，又可以有强制性；缺点是对编译速度有一定的影响。

编译Android工程执行的是assemble任务，让assemble依赖lint任务，即可在编译时执行Lint检查；同时配置LintOptions，发现Error级别问题时中断编译。

• 在Application模块的gradle中加入配置

android.applicationVariants.all { variant ->
    variant.outputs.each { output ->
        def lintTask = tasks["lint${variant.name.capitalize()}"]
        output.assemble.dependsOn lintTask
    }
}

• 在library模块的gradle中加入配置

android.libraryVariants.all { variant ->
    variant.outputs.each { output ->
        def lintTask = tasks["lint${variant.name.capitalize()}"]
        output.assemble.dependsOn lintTask
    }
}

参考文章

• Android Plugin DSL Reference: LintOptions
• Gradle配置lintOptions