Android 自定义 lint 插件(二)

背景

上一篇文章我们讲了如何自定义一个简单的 lint 检查规则,这篇文章我们讲讲 lint 规则如何发布与集成。

问题

上一篇文章中,我们编写的 lint 规则,通过 implementation project(':wrapper') 在主工程中引入我们的规则,但是在一般实际生产的场景中,我们很少通过源码的方式去依赖,而是更偏向于使用 gradle 依赖来实现,本文就来讲讲如何将我们的自定义 lint 规则发布到 maven,从而使其他工程可以直接用 gradle 依赖的方式来使用。

解决方法

升级 Gradle 和 lint library

在写这篇文章的时候,gradle 和 Android Gradle Plugin 都有了较大的版本升级,这里有一个限制需要注意:自定义 lint 工程的 AGP,必须和使用 lint 规则的工程(主工程)的 AGP 版本一致,否则可能出现无法正常使用的问题
由于我的主工程的 AGP 是 7.0.3,因此我们将 Lint 工程的 AGP 也同步升级到 7.0.3.
这边有一个官方文档没有说得很清楚的点,就是 lint library 的版本,应该和 AGP 的版本是一一对应的,具体的对应规则就是:
如果 AGP 版本是 x.y.z,那么 lint 的版本应该是 (x+23).y.z
所以对应 AGP 7.0.3 的 lint library 版本就是 30.0.3,我们修改相应的依赖如下:

compileOnly "com.android.tools.lint:lint-api:$LINT_VERSION"
compileOnly "com.android.tools.lint:lint-checks:$LINT_VERSION"

其中 LINT_VERSION = 30.0.3

注:AGP7 以上需要 Java 11 的环境,因此如果升级后无法编译,需要安装 Java 11 且在 AS 里面把 JDK 设置为 Java 11.

发布到 Maven

接下来就是发布到 maven repo 了,其实就是将 wrapper module 发布到 maven,如果你已经很熟悉 gradle maven 的发布,那下面的内容就可以不用看了。
要发布到maven,我们只需要两个步骤:

1. 配置 maven plugin

由于新版本的 AGP 已经集成了 maven plugin,所以我们不需要再使用第三方的插件了,直接在 wrapper module 下新建一个 maven.gradle,内容如下:

apply plugin: 'maven-publish'

group = GROUP
version = VERSION
def repositoryUrl = MAVEN_REPOSITORY_URL

afterEvaluate {
    publishing {
        publications {
            // Creates a Maven publication called "release".
            release(MavenPublication) {
                // Applies the component for the release build variant.
                from components.release

                // You can then customize attributes of the publication as shown below.
                groupId = GROUP
                artifactId = ARTIFACT_ID
                version = VERSION
            }
        }

        repositories {
            maven {
                allowInsecureProtocol true
                url = repositoryUrl

                credentials {
                    username MAVEN_USER
                    password MAVEN_PWD
                }
            }
        }
    }

    publish {
        doLast {
            println "*********************************************************************************"
            println "Lint Checker Uploaded"
            println "Group           : " + GROUP
            println "ArtifactId      : " + ARTIFACT_ID
            println "Version         : " + version
            println "Repository      : " + repositoryUrl
            println "*********************************************************************************"
        }
    }
}

其中有几个参数是定义在项目根目录下的 gradle.properties 里面的:

  • GROUP: maven 组,例如 xyz.glorin.lint
  • ARTIFACT_ID: 产物的ID,例如 customlint
  • VERSION: 版本号
  • MAVEN_REPOSITORY_URL: Maven 仓库地址
  • MAVEN_USER: Maven 仓库用户名(开启了认证的情况下才需要)
  • MAVEN_PWD: Maven 仓库密码
    最终我们在主工程使用的时候,完整的依赖就是:
    $GROUP:$ARTIFACT_ID:$VERSION (xyz.glorin.lint:customlint:1.0.0)

2. 打包发布

只需要执行: ./gradlew :wrapper:publish 即可发布成功。
或者在 AS Gradle 界面执行task:

2022-02-24-22-36-47.png

代码

本文工程代码: https://github.com/glorinli/CustomLintChecker
顺便推荐一个免费的 Maven server: https://repsy.io/

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,607评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,047评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,496评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,405评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,400评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,479评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,883评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,535评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,743评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,544评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,612评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,309评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,881评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,891评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,136评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,783评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,316评论 2 342

推荐阅读更多精彩内容