Android代码检查规则Lint的自定义与应用

已于 2024-01-17 17:56:41 修改
阅读量1.7k 收藏 1
点赞数 1
分类专栏： Android开发 文章标签： android android studio android-studio
于 2022-06-13 21:26:10 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/bugyinyin/article/details/125267890
版权

前言：

在日常的代码开发中，此处相信每个开发人员对代码质量都是高要求，有自己的一套代码规范，但是我们不是单独作战，往往大家都是团队作战，人是最大的变量，各人各异，如何保证团队的代码质量和代码规范呢？靠开发者自觉吗？也许有的团队有严格的CR机制，在MR阶段会进行CR，CR不通过的MR是不允许合入的，但是这样会使Reviewer花费较多的时间去校验，那么这时候我们就需要在编码过程中提供一种代码检测机制。

例如：期望表现的效果就是在编码时可以展示异常检测的方法，高亮或者标红，当鼠标悬停在高亮的代码上时，会提供问题的描述和解决方法。需要这种效果，就需要自定义lint了。

image-20220311150938420.png

什么是Lint

在Android Studio中提供的代码扫描工具Lint，可在无需实际执行该应用，也不必编写测试用例的情况下帮助开发者发现代码质量问题和提出一些改进建议。

Lint工具可检查您的 Android 项目源文件是否包含潜在错误，以及在正确性、安全性、性能、易用性、便利性和国际化方面是否需要优化改进。在使用 Android Studio 时，配置的 Lint 和 IDE 检查会在您每次构建应用时运行。不过，您可以手动运行检查或从命令行运行 Lint。

android studio内置了较多的lint规则，但内置的lint规则无法满足直观的适合我们时，就需要我们自定义lint了。

image-20220311151335437.png

自定义Lint流程：

1. 新创建module，Module类型选择Java or Kotlin Library, 暂时命名lint_tools

2. 在build.gradle中引入lint的依赖

 dependencies {
        compileOnly 'com.android.tools.lint:lint-api:27.2.2'
        compileOnly 'com.android.tools.lint:lint-checks:27.2.2'
    }

在moudle中依赖了lint-api和lint-checks，其中lint-api就是lint相关的api，lint-checks就是android studio里自定义的一些lint规则，我们自定义lint可以参考lint-checks里面的写法。

3. 本地创建个资源id命名检查规则，用来规范项目中的id统一命名

创建ViewIdDetector，直接继承LayoutDetector(也可以继承ResourceXmlDetector 或者 继承Detector实现的接口是XmlScanner，方式多样)

import com.android.SdkConstants
import com.android.tools.lint.detector.api.*
import com.android.tools.lint.detector.api.Category.Companion.CORRECTNESS
import com.android.tools.lint.detector.api.Scope.Companion.RESOURCE_FILE_SCOPE
import org.w3c.dom.Element
​
class ViewIdDetector : LayoutDetector() {
    
    override fun getApplicableElements(): Collection<String>? {
        return listOf(
            SdkConstants.TEXT_VIEW,
            SdkConstants.IMAGE_VIEW,
            SdkConstants.BUTTON
        )
    }
​
    override fun visitElement(context: XmlContext, element: Element) {
        if (!element.hasAttributeNS(SdkConstants.ANDROID_URI, SdkConstants.ATTR_ID)) {
            return
        }
        val attr = element.getAttributeNodeNS(SdkConstants.ANDROID_URI, SdkConstants.ATTR_ID)
        val value = attr.value
        if (value.startsWith(SdkConstants.NEW_ID_PREFIX)) {
            val idValue = value.substring(SdkConstants.NEW_ID_PREFIX.length)
            var matchRule = true
            var expMsg = ""
            when (element.tagName) {
                SdkConstants.TEXT_VIEW -> {
                    expMsg = "tv"
                    matchRule = idValue.startsWith(expMsg)
                }
                SdkConstants.IMAGE_VIEW -> {
                    expMsg = "iv"
                    matchRule = idValue.startsWith(expMsg)
                }
                SdkConstants.BUTTON -> {
                    expMsg = "btn"
                    matchRule = idValue.startsWith(expMsg)
                }
            }
            if (!matchRule) {
                context.report(
                    ISSUE, 
                    attr, 
                    context.getLocation(attr), 
                    "ViewIdName建议使用view的缩写_xxx; ${element.tagName} 建议使用 `${expMsg}_xxx`"
                )
            }
        }
    }
​
    companion object {
        val ISSUE: Issue = Issue.create(
            "ViewIdCheck",
            "ViewId命名不规范",
            "ViewIdName建议使用 view的缩写加上_xxx,例如tv_xxx, iv_xxx",
            CORRECTNESS,
            5, Severity.ERROR,
            Implementation(
                ViewIdDetector::class.java,
                RESOURCE_FILE_SCOPE
            )
        )
    }
}

自定义Detector可以实现一个或多个Scanner接口,选择实现哪种接口取决于你想要的扫描范围。
Lint API 中内置了很多 Scanner：

Scanner 类型Desc
UastScanner扫描 Java、Kotlin 源文件
XmlScanner扫描 XML 文件
ResourceFolderScanner扫描资源文件夹
ClassScanner扫描 Class 文件
BinaryResourceScanner扫描二进制资源文件
GradleScanner扫描Gradle脚本

4. 实现IssueRegistry并添加对应的自定义Issue：

class IMockIssueRegistry: IssueRegistry() {
    override val issues: List<Issue>
        get() = listOf(
            ViewIdDetector.ISSUE
        )
​
}

5. 在module(lint_tools)中对应的build.gradle中配置如下信息：

jar {
    manifest {
        attributes("Lint-registry-v2": "com.imock.lint.IMockIssueRegistry")
    }
}
​

6. 在需要进行lint检查的module中或者app目录现的build.gradle中引用对应的lint_tools即可使用。

dependencies {
    lintChecks project(path: ':lint-tools')
}

至此你可以试着自己自定义Lint了，相关语法api都可参考lint-checks中提供的Detector实现，来实现自己的Lint检查规则。

拓展一下：

1. 针对Issue.create参数了解一下：

companion object {
    /**
     * Creates a new issue. The description strings can use some simple markup;
     * see the [TextFormat.RAW] documentation
     * for details.
     *
     * @param id the fixed id of the issue
     * @param briefDescription short summary (typically 5-6 words or less), typically
     * describing the **problem** rather than the **fix**
     * (e.g. "Missing minSdkVersion")
     * @param explanation a full explanation of the issue, with suggestions for
     * how to fix it
     * @param category the associated category, if any
     * @param priority the priority, a number from 1 to 10 with 10 being most
     * important/severe
     * @param severity the default severity of the issue
     * @param implementation the default implementation for this issue
     * @return a new [Issue]
     */
    @JvmStatic
    fun create(
        id: String,
        briefDescription: String,
        explanation: String,
        category: Category,
        priority: Int,
        severity: Severity,
        implementation: Implementation
    ): Issue {
        val platforms = computePlatforms(null, implementation)
        return Issue(
            id, briefDescription, explanation, category, priority,
            severity, platforms, null, implementation
        )
    }
}
  • 参数id 唯一的id,简要表面当前提示的问题。
  • 参数briefDescription 简单描述当前问题
  • 参数explanation 详细解释当前问题和修复建议
  • 参数category 问题类别
  • 参数priority 优先级，从1到10，10最重要
  • 参数Severity 严重程度：FATAL（奔溃）, ERROR（错误）, WARNING（警告）,INFORMATIONAL（信息性）,IGNORE（可忽略）
  • 参数Implementation Issue和哪个Detector绑定，以及声明检查的范围。Scope有如下选择范围：RESOURCE_FILE（资源文件),BINARY_RESOURCE_FILE（二进制资源文件）,RESOURCE_FOLDER（资源文件夹）,ALL_RESOURCE_FILES（所有资源文件）,JAVA_FILE（Java文件）, ALL_JAVA_FILES（所有Java文件）,CLASS_FILE（class文件）, ALL_CLASS_FILES（所有class文件）,MANIFEST（配置清单文件）, PROGUARD_FILE（混淆文件）,JAVA_LIBRARIES（Java库）, GRADLE_FILE（Gradle文件）,PROPERTY_FILE(属性文件),TEST_SOURCES（测试资源）,OTHER(其他);

2. Lint API 中 UastScanner 相关回调方法介绍

  1. getApplicableUastTypes 与 createUastHandler

    • getApplicableUastTypes 此方法返回需要检查的AST节点的类型，类型匹配的UElement将会被createUastHandler(createJavaVisitor)创建的UElementHandler(Visitor)检查。
    • createUastHandler 创建一个UastHandler来检查需要检查的UElement，对应于getApplicableUastTypes

  2. getApplicableMethodNames 与 visitMethod

    • getApplicableMethodNames 返回你所需要检查的方法名称列表，或者返回null，相匹配的方法将通过visitMethod方法被检查
    • visitMethod 检查与getApplicableMethodNames相匹配的方法

  3. getApplicableConstructorTypes 与 visitConstructor

    • getApplicableConstructorTypes 返回需要检查的构造函数类型列表，类型匹配的方法将通过visitConstructor被检查
    • visitConstructor 检查与getApplicableConstructorTypes相匹配的构造方法

  4. getApplicableReferenceNames 与 visitReference

    • getApplicableReferenceNames 返回需要检查的引用路径名，匹配的引用将通过visitReference被检查
    • visitReference 检查与getApplicableReferenceNames匹配的引用

  5. appliesToResourceRefs 与 visitResourceReference

    • appliesToResourceRefs 返回需要检查的资源引用，匹配的引用将通过visitResourceReference被检查
    • visitResourceReference 检查与appliesToResourceRefs匹配的资源引用

  6. applicableSuperClasses 与 visitClass

    • applicableSuperClasses 返回需要检查的父类名列表，此处需要类的全路径名
    • visitClass 检查applicableSuperClasses返回的类

文末

如果你想成为架构师，那就不要局限在编码，业务，要会选型、扩展，提升编程思维。此外，良好的职业规划也很重要，学习的习惯很重要，但是最重要的还是要能持之以恒，任何不能坚持落实的计划都是空谈。

如果你没有方向，这里给大家分享一套由阿里高级架构师编写的《Android八大模块进阶笔记》，帮大家将杂乱、零散、碎片化的知识进行体系化的整理，让大家系统而高效地掌握Android开发的各个知识点。
在这里插入图片描述
相对于我们平时看的碎片化内容，这份笔记的知识点更系统化，更容易理解和记忆，是严格按照知识体系编排的。

一、架构师筑基必备技能

1、深入理解Java泛型
2、注解深入浅出
3、并发编程
4、数据传输与序列化
5、Java虚拟机原理
6、高效IO
……

在这里插入图片描述

二、Android百大框架源码解析

1.Retrofit 2.0源码解析
2.Okhttp3源码解析
3.ButterKnife源码解析
4.MPAndroidChart 源码解析
5.Glide源码解析
6.Leakcanary 源码解析
7.Universal-lmage-Loader源码解析
8.EventBus 3.0源码解析
9.zxing源码分析
10.Picasso源码解析
11.LottieAndroid使用详解及源码解析
12.Fresco 源码分析——图片加载流程

在这里插入图片描述

三、Android性能优化实战解析

  • 腾讯Bugly:对字符串匹配算法的一点理解
  • 爱奇艺：安卓APP崩溃捕获方案——xCrash
  • 字节跳动：深入理解Gradle框架之一：Plugin, Extension, buildSrc
  • 百度APP技术：Android H5首屏优化实践
  • 支付宝客户端架构解析：Android 客户端启动速度优化之「垃圾回收」
  • 携程：从智行 Android 项目看组件化架构实践
  • 网易新闻构建优化：如何让你的构建速度“势如闪电”？
  • …

在这里插入图片描述

四、高级kotlin强化实战

1、Kotlin入门教程
2、Kotlin 实战避坑指南
3、项目实战《Kotlin Jetpack 实战》

  • 从一个膜拜大神的 Demo 开始

  • Kotlin 写 Gradle 脚本是一种什么体验？

  • Kotlin 编程的三重境界

  • Kotlin 高阶函数

  • Kotlin 泛型

  • Kotlin 扩展

  • Kotlin 委托

  • 协程“不为人知”的调试技巧

  • 图解协程：suspend

在这里插入图片描述

五、Android高级UI开源框架进阶解密

1.SmartRefreshLayout的使用
2.Android之PullToRefresh控件源码解析
3.Android-PullToRefresh下拉刷新库基本用法
4.LoadSir-高效易用的加载反馈页管理框架
5.Android通用LoadingView加载框架详解
6.MPAndroidChart实现LineChart（折线图）
7.hellocharts-android使用指南
8.SmartTable使用指南
9.开源项目android-uitableview介绍
10.ExcelPanel 使用指南
11.Android开源项目SlidingMenu深切解析
12.MaterialDrawer使用指南
在这里插入图片描述

六、NDK模块开发

1、NDK 模块开发
2、JNI 模块
3、Native 开发工具
4、Linux 编程
5、底层图片处理
6、音视频开发
7、机器学习

在这里插入图片描述

七、Flutter技术进阶

1、Flutter跨平台开发概述
2、Windows中Flutter开发环境搭建
3、编写你的第一个Flutter APP
4、Flutter开发环境搭建和调试
5、Dart语法篇之基础语法(一)
6、Dart语法篇之集合的使用与源码解析(二)
7、Dart语法篇之集合操作符函数与源码分析(三)
…
在这里插入图片描述

八、微信小程序开发

1、小程序概述及入门
2、小程序UI开发
3、API操作
4、购物商场项目实战……

在这里插入图片描述

全套视频资料：

一、面试合集
在这里插入图片描述
二、源码解析合集

在这里插入图片描述
三、开源框架合集

在这里插入图片描述
欢迎大家一键三连支持，若需要文中资料，直接点击文末CSDN官方认证微信卡片免费领取【保证100%免费】↓↓↓

bugyinyin
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Android-lint-自定义lint规则
08-13
lint - 自定义lint规则
Android-Android自定义Lint检查
08-13
Android自定义Lint检查
【工具】lint检测工具
qq_37776700的博客
11-07 606
AndroidStudio lint工具介绍
Android 自定义Lint打造编码规则1
08-08
以此类推,如果需要在工程中禁止使用什么类和方法都可以通过自定义Lint将其检查出来,规范开发流程和代码一致性. 前提,lintAPI 25版本和lintAPI
Lint-Checks,android lint中没有现成的有用lint检查集合.zip
09-25
这个存储库保存的lint检查不是标准android工具包的一部分，但对开发人员仍然有帮助。
Android Lint 原理及使用详解
热门推荐
卜大爷的博客
01-25 2万+
Android Lint 原理及使用详解 Android Lint 是 ADT 16中引入的新工具，用于扫描 Android 项目源中的潜在错误。 Lint 是 Android 提供的一个强大的，用于静态扫描应用源码并找出其中的潜在问题的实用工具。lint 工具可以检查你的 Android 项目源文件是否有潜在的错误，以及在正确性、安全性、性能、易用性、无障碍性和国际化方面是否需要优化改进。 Lint 既可以用作命令行工具，也可以与 Eclipse 和 IntelliJ 集成在一起。它被设计成独立于 ID
入门 Android Lint
卓原的进化之旅
06-18 2676
Lint ​ Android Lint 是Android Studio 在ADT(Android Developer Tools)16提供的代码扫描工具，可以帮助我们发现和更正代码结构质量的问题。系统会报告该工具检测到的每个问题并提供问题的描述消息和严重级别，以便快速确定需要优先进行的修改。此外，我们还可以通过降低问题的严重级别以忽略与项目无关的问题，或者提高严重级别以突出特定问题。 优点 无需实际执行应用 不必编写测试用例 Lint工作流 下图显示了 lint 工具如何处理应用源文件。 App
Android lint配置及使用
fumeidonga的博客
09-08 3727
lint 工具可以检查您的 Android 项目源文件是否有潜在的 bug，以及在正确性、安全性、性能、易用性、无障碍性和国际化方面是否需要优化改进。
Android量身定做的代码审查利器——Lint
chengxuyuan22的博客
06-21 952
一、Android Lint简介 Android Lint是SDK Tools 16（ADT16，当前笔者使用的ADT已经是26了，所以现在就不用担心自己所使用的SDK中不包含lint工具了）开始引入的一个代码扫描工具，路径为：Sdk\tools\bin\lint.bat。通过它对Android工程源代码进行扫描和检查，可发现潜在的问题，以便程序员及早修正这个问题。通过Lint，无需实际执行应用，也不必编写测试用例，就可以检查Android项目中源文件是否存潜在的错误，以及在正确性、安全性、...
android开发-Android自定义Lint开发示例工程.zip
03-03
android开发_Android自定义Lint开发示例工程
Android代码-android-custom-lint-rules
08-06
Custom Lint Rules The Android lint tool is a static code analysis tool that checks your Android project source files for potential bugs and optimization improvements for correctness, security, performance, usability, accessibility, and internationalization. Lint comes with over 200 checks, however it can be extended with additional custom rules. NOTE: The lint API is not a final API; if you rely on this be prepared to adjust your code for the next tools release. Introduction The Android Lint API
Android Lint规则（包括翻译规则）和空指针检查研究
cplasf2012的博客
05-06 1268
android {// true--关闭lint报告的分析进度quiet true// true--错误发生后停止gradle构建// true--只报告error// true--忽略有错误的文件的全/绝对路径(默认是true)// true--检查所有问题点，包含其他默认关闭项// true--所有warning当做error// 关闭指定问题检查// 打开指定问题检查// 仅检查指定问题// true--error输出文件不包含源码行号。
如何使用ESLint检查代码
m0_75198698的博客
05-04 1836
以上配置中，`husky.hooks.pre-commit` 表示在代码提交前运行 `lint-staged`，`lint-staged` 表示在提交的文件中运行 `eslint --fix` 命令，自动修复可以自动修复的错误，并将修复后的结果添加到 Git 提交中。上述代码中，`env` 字段指定了 ESLint 的运行环境，`extends` 字段指定了使用的规则库，`plugins` 字段指定了使用的插件，`rules` 字段指定了自定义的规则。首先，我们需要在项目中安装 ESLint。
使用Lint检查提高代码质量
卓越之路
07-20 3200
使用Lint检查提高代码质量1、概述2、代码中使用标记2.1 概述2.2 在工程中使用标记2.3 一些标记的使用2.3.1 Nullness标记2.3.2 资源标记2.3.3 线程标记2.3.4 值约束标记2.3.5 权限标记2.3.6 返回值标记2.3.7 CallSuper标记2.3.8 自定义标记类型2.3.9 Keep标记2.3.10 代码可见性标记 1、概述 开发app，除了通过单元测试确保app满足功能需求，通过lint检查确保代码没有框架上的问题也很重要。使用lint工具，可以找到框架上设计较
lint简介
栗少的博客
07-18 3286
引言： 静态程序分析是指使用自动化工具软件对程序源代码进行检查，以分析程序行为的技术，应用于程序的正确性检查、安全缺陷检测、程序优化等。它的特点就是不执行程序，相反，通过在真实或模拟环境中执行程序进行分析的方法称为“动态程序分析(Dynamic program analysis)”。 静态程序分析往往作为一个多人参与的项目中代码审查过程的一个阶段，因编写完一部分代码之后就可以进行静态分析，分析过程不需要执行整个程序，这有助于在项目早期发现以下问题：变量声明了但未使用、变量类型不匹配、变量在使用前未定义、
Android自定义Lint实践
一个有情怀的程序猿博客
07-04 525
Android Lint是Google提供给Android开发者的静态代码检查工具。使用Lint对Android工程代码进行扫描和检查，可以发现代码潜在的问题，提醒程序员及早修正。 为保证代码质量，美团在开发流程中加入了代码检查，如果代码检测到问题，则无法合并到正式分支中，这些检查中就包括Lint。 我们在实际使用Lint中遇到了以下问题：- 原生Lint无法满足我们团队特有的需求，例如：编码规范。 - 原生Lint存在一些检测缺陷或者缺少一些我们认为有必要的检测。 基于上面的考虑，我们开始调研并..
Android 工程师需要了解的 Lint 知识入门篇
PowerMartin Talk
12-13 1591
前言 项目开发过程中，通过对代码规范的约束对于代码质量的提升是非常重要的。这其中除了人为的代码审查之外，我们还可以使用 lint 工具来定位并修改一些有问题的代码，帮助提高我们的代码规范程度。今天我们就一起来学学 lint 的使用。 自动提示 Android Studio 内置了很多常用的 lint 规则，我们在平时中都能使用到。比如我们直接调用一些可能引发空指针的方法，就会出现如下图中的提示。我们平时开发过程中需要关注到这些提示并进行对应的修改。 手动调用 除了自动提示，我们还可以在 Android S
Android --- 英文单引号用&apos；替换报错：does not contain a valid string resource
梁同学与Android
04-23 195
Android --- 英文单引号用&apos;替换报错：does not contain a valid string resource
安卓aab文件生成apk文件
最新发布
ma15991375491的博客
04-24 329
比如我们在手机上经常下载的的各种APP，其实一个Android应用程序的代码想要在Android设备上运行，必须先进行编译，然后被打包成为一个被Android系统所能识别的文件才可以被运行，而这种能被Android系统识别并运行的文件格式便是“APK”。一个APK文件内包含被编译的代码文件(.dex 文件)，文件资源（resources）， 原生资源文件（assets），证书（certificates），和清单文件（manifest file）严格来说，两者没有什么区别，后者是前者的一种升级版格式文件。
idea sonarlint自定义规则
09-15
要在IDEA中使用SonarLint自定义规则，可以按照以下步骤进行操作： 1. 打开IDEA，点击"File（文件）"菜单，选择"Setting（设置）"。 2. 在设置界面中，点击"SonarLint"选项。 3. 选择"Quality Profiles（质量配置）"，然后点击"Create（创建）"按钮。 4. 在弹出的对话框中，可以选择创建新的质量配置或者复制现有的规则进行修改。如果选择复制现有规则，可以点击"Copy（复制）"按钮并选择要复制的规则。 5. 在创建或复制规则后，可以根据需要进行修改和自定义。可以添加、删除或修改规则，并调整规则的严重程度和条件。 6. 完成自定义规则后，点击"OK"按钮保存设置。 通过以上步骤，可以在IDEA中使用SonarLint自定义规则，以便根据项目的需求进行代码质量检查和规范。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值