Android端生成META-INF信息文件的Gradle插件 RapidMetaInfPlugin


Android Studio, META-INF, android, gradle, gradle plugin

Android端生成META-INF信息文件的Gradle插件 RapidMetaInfPlugin

1. 需求背景

最近新遇到了一个需求，想在自己的一些库中写入版本信息，在别人使用了我的库后，我可以通过apk文件检测出依赖了我的哪个版本的库。感觉这个需求有点多余？那就举个例子吧。

比如，我编写了一个开源库：RapidORM，并上传到了Maven中心库 ，假设一个我不认识的开发者（暂且称它为X）在编写app，这个app中的代码对我来说是完全未知的，但是他通过在build.gradle中添加了如下依赖：

1
2
3
compile "com.github.wangjiegulu:rapidorm:1.0.0"
compile "com.github.wangjiegulu:rapidorm-api:1.0.0"
apt "com.github.wangjiegulu:rapidorm-compiler:1.0.0"

很明显，X依赖了我写的RapidORM库。并且打包成了Apk文件然后发布。这时我下载了这个apk，并且希望得到这个apk中依赖的RapidORM版本是多少？这个RapidORM在构建这个aar时的开发环境是怎么样的？反编译可能有希望能拿到RapidORM具体的版本号，但是aar当时的构建环境就无法得知了。

这时，我就希望在我发布RapidORM的Release版本的时候能够在aar中携带好一些自定义的参数，并且这些信息会在依赖了这个库的开发者X构建apk的时候跟随保存到apk文件中。

比较典型的一个例子当你依赖了RxJava这个库，我们构建apk完成之后，会发现在我们的apk文件中的META-INF文件夹下面会有一个rxjava.properties文件，打开这个文件就会发现如下内容：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Manifest-Version=1.0
Implementation-Title=io.reactivex.rxjava2#rxjava;2.1.2
Implementation-Version=2.1.2
Built-Status=integration
Built-By=travis
Built-OS=Linux
Build-Date=2017-07-23_08:21:58
Gradle-Version=2.14
Module-Owner=benjchristensen@netflix.com
Module-Email=benjchristensen@netflix.com
Module-Source=
Module-Origin=https://github.com/ReactiveX/RxJava.git
Change=e4fbe4c
Branch=e4fbe4cfcb3c240d14a42a586eecbbd74cb379d2
Build-Host=testing-gce-361876de-b66f-4569-b841-e037b0fee9af
Build-Job=LOCAL
Build-Number=LOCAL
Build-Id=LOCAL
Created-By=1.7.0_80-b15 (Oracle Corporation)
Build-Java-Version=1.7.0_80
X-Compile-Target-JDK=1.6
X-Compile-Source-JDK=1.6

很显然，这个文件中包含了：RxJava版本号, 构建的CI信息，构建时间, Gradle版本, 模块负责人信息, git分支, JDK版本等等。

通过这个方式，我可以在任意的apk中拿到它依赖的RxJava的信息。

当然，你可以通过在build.gradle进行如下配置来过排除这个rxjava.properties文件（但是不建议这么做，这个文件也许能在你遇到问题时给你帮助）：

1
2
3
4
5
6
android {
    ...
    packagingOptions {
        exclude 'META-INF/rxjava.properties'
    }
}

2. RapidMetaInfPlugin Gradle 插件

RapidMetaInfPlugin: https://github.com/wangjiegulu/RapidMetaInfPlugin

因此，写了 RapidMetaInfPlugin 这个 Gradle 插件。

这次先说说怎么使用这个插件，以后抽时间再写一篇 Gradle 插件编写教程。之前也写过一个Gradle插件（详情见Android Gradle 插件 DiscardFilePlugin（清空类和方法））也挺实用的。

2.1 最终效果

通过这个插件，我们可以在apk或者aar（app依赖后合并到apk）中写入任意信息。

以上在这个apk的META-INF中生成了一个名为DAL_REQUEST.properties的文件，内容中包含了dal_request这个库的名字、版本号和url。

2.2 如何使用

在你的buildscript的dependencies中添加classpath依赖（点击这里获取最新版本）：

1
2
3
4
5
6
7
8
9
10
11
12
buildscript {
    repositories {
        jcenter()
        google()
    }
    dependencies {
        // ...
        classpath ('com.github.wangjiegulu:rapidmetainf:x.x.x'){
            exclude group: 'com.android.tools.build', module: 'gradle'
        }
    }
}

然后在你的apk或者aar的build.gradle文件的顶部写入以下代码来使用插件：

1
apply plugin: 'com.github.wangjiegulu.plg.rapidmetainf'

然后通过如下方式填写你需要写进META-INF目录中的文件信息：

1
2
3
4
5
6
rapidmetainf {
    metaInfName 'DAL_REQUEST.properties'
    metaInfProperties "archiveName=$dbarchiveName",
            "archiveVersion=$dbarchiveVersion",
            "archiveUrl=$dbarchiveUrl"
}

如上，metaInfName表示在META-INF目录中生成的文件名称（文件名任意取，但是不能以”.”开头），metaInfProperties表示要写入文件的数据，这个变量为数组类型，可通过Groovy语法来编写，比如通过$符号来引用ext，通过如下命令参数的方式等等：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
rapidmetainf {
    metaInfName 'DAL_REQUEST_DEMO.properties'

    String[] infArray = new String[10]
    // ./gradlew clean build -PcommandKey=commandValue
    infArray[0] = "propertyFromCommand=${getParameter('commandKey')}"
    for(int i = 1; i < infArray.length; i++){
        infArray[i] = "array_item_key_$i=array_item_value_$i"
    }

    metaInfProperties infArray
}

def getParameter(String key) {
    // -D
    String value = System.getProperty(key)
    if (null != value && value.length() > 0) {
        return value
    }
    // -P
    if (hasProperty(key)) {
        return getProperty(key)
    }
    return null
}

以上，CI构建时就可使用命令./gradlew clean build -PcommandKey=commandValue来把commandValue写入到文件中。


来源博客：Wang Jie's Blog's Blog
本文链接：https://blog.wangjiegulu.com/2018/02/05/Android端生成META-INF信息文件的Gradle插件 RapidMetaInfPlugin/
版权声明：本博客所有文章除特别声明外，均采用 CC BY 4.0 CN协议 许可协议。转载请注明出处。