Android代码静态检查（lint、Checkstyle、ktlint、Detekt）

最新推荐文章于 2024-04-03 09:31:02 发布

敢嗣先锋

最新推荐文章于 2024-04-03 09:31:02 发布

阅读量412

点赞数

本文链接：https://blog.csdn.net/Maniu_666/article/details/129962882

版权

本文介绍了在Android开发中，如何使用Lint、Checkstyle、ktlint和Detekt这四个静态代码分析工具进行代码质量检查。它们能够帮助开发者发现潜在错误、优化代码性能，并遵循编码规范。其中，Lint是Android Studio内置的工具，Checkstyle专注于编码规范，ktlint和Detekt是针对Kotlin的检查工具，且Detekt支持高度自定义规则。这些工具可以结合Git钩子使用，提升代码质量。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在Android项目开发过程中，开发团队往往要花费大量的时间和精力发现并修改代码缺陷。

静态代码分析工具能够在代码构建过程中帮助开发人员快速、有效的定位代码缺陷并及时纠正这些问题，从而极大地提高软件可靠性

节省软件开发和测试成本。

Android目前主要使用的语言为kotlin、java，所以我们需要尽可能支持这两种语言。

Lint

Android Studio 提供的代码扫描工具。通过进行 lint 检查来改进代码

能检测什么？是否包含潜在错误，以及在正确性、安全性、性能、易用性、便利性和国际化方面是否需要优化改进，帮助我们发现代码结/质量问题，同时提供一些解决方案。每个问题都有信息描述和等级。

支持【300+】检测规则，支持Manifest文件、XML、Java、Kotlin、Java字节码、Gradle文件、Proguard文件、Propetty文件和图片资源；

基于抽象语法树分析，经历了LOMBOK-AST、PSI、UAST三种语法分析器；

主要包括以下几个方面

Correctness：不够完美的编码，比如硬编码、使用过时 API 等;
Performance：对性能有影响的编码，比如：静态引用，循环引用等;
Internationalization：国际化，直接使用汉字，没有使用资源引用等;
Security：不安全的编码，比如在 WebView 中允许使用 JavaScriptInterface 等

在module下的build.gradle中添加以下代码:

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'
    }
}