Gradle 的高级技巧

Posted 2021-04-27 code小生

作者 | 小武站台

声明 | 本文是 小武站台 原创，已获授权发布，未经原作者允许请勿转载

前言

原文：Gradle, the Applidium way

让我们继续谈论 android 生态中的 Gradle

Gradle 是 Android studio 用到的一个自动构建系统，基于 Groovy 语法，用来管理和构建 Android 项目，它可以精细的处理构建过程的各个步骤和简化持续集成（CI）,接下来让我们看看 Gradle 中一些有用的技巧。

1.The dependency, mother of all dependencies

开始之前，这里有一个重要的工具可以让你处理依赖更简单方便：SDK Manager Plugin,它会自动下载和更新你的一些依赖（例如：API,support library,emulator）,非常好用，尤其是当你下载了别人的代码项目时，什么也干不了，这时只需打开项目，等待下载或更新依赖，然后你可以启动应用程序了！

使用这个插件，只需要在你 Project 的根目录的 build.gradle 加上一行就可以了

dependencies {
   classpath 'com.android.tools.build:gradle:1.3.0'
   classpath 'com.jakewharton.sdkmanager:gradle-plugin:0.12.0' //添加该行
}

更多该插件相关信息 github https://github.com/JakeWharton/sdk-manager-plugin

2.Variants opportunities

productFlavor and buildConfigField

另一个 Gradle 有用的功能是 productFlavor,你可以在你的 build.gradle 定义不同的 productFlavor，这将会生成不同版本的应用程序包

一个简单例子：我想生成 2 个不同分支的包

productFlavors {
    branchOne {
        applicationId "com.example.branchOne"
        buildConfigField "String", "CONFIG_ENDPOINT", "http://branchOne.com/android"
   }
    branchTwo {
        applicationId "com.example.branchTwo"
        buildConfigField "String", "CONFIG_ENDPOINT", "http://branchTwo.org"
   }
}

你可以在 variants 里面定义 buildConfigFields，有了这些字段，这样你就可以让你的整个配置都写在一个文件里面。可以很容易的用来定义我们的常量（而不是分开写在几个 xml 文件），例如，我们刚才就它来定义了 http 请求的根url.

你可以在代码中使用它们：BuildConfig.FIELD_NAME（上面的的例子就是BuildConfig.CONFIG_ENDPOINT）

一个有用的技巧：你可以单独只为某一个 variants 添加一些依赖，只需要在Compile 加上对应的 variant 名字前缀就可以了

dependencies {
    compile 'com.android.support:support-v4:22.2.0'
    branchOneCompile 'com.android.support:appcompat-v7:22.2.0'//只为branchOne添加这个依赖
}

buildType

和 productFlavors 类似的，还有 buildTypes(debug和release 是默认的)，它们都也可以为你的应用程序生成 variants，合并一起形成buildVariant，brancheOne 和 debug 会生成 branchOneDebug.

差别在于改变 buildType 不会改变应用程序的代码，它们只是处理的东西不同，你可以通过 buildType 来获取更多的技术细节（例如：build optimization,log level 等等），但是app的内容不会改变，相反的，使用productFlavor 配置可以改变app的内容(ps:内容可以设想成 package 理解，buildType 没法改 applicationId)。

flavorDimension

更进一步如果我们想基于多个标准构建多个版本，可以用 flavorDimensions,看下面的例子：

flavorDimensions "brand", "environment"
productFlavors {
    branchOne {
        flavorDimension "brand"
        applicationId "com.example.branchOne"
        buildConfigField "String", "CONFIG_ENDPOINT", "http://branchOne.com/android"
    }
    branchTwo {
        flavorDimension "brand"
        applicationId "com.example.branchTwo"
        buildConfigField "String", "CONFIG_ENDPOINT", "http://branchTwo.org"
    }
    stubs {
        flavorDimension "environment"
    }
    preprod {
        flavorDimension "environment"
    }
    distrib {
        flavorDimension "environment"
    }
}

生成的 variants（2 个 buildType*2 个 brand 维度 *3个environment 维度 =12）:

通过上面修改 applicationId，每个版本的 app 都可以在你的手机上面安装共存。

A dynamic Manifest

得感谢${name}，使得你可以在你的 Manifest 插入一个占位符。看下面的例子:

<activity android:name=".Main">
    <intent-filter>
        <action android:name="${applicationId}.foo">
        </action>
    </intent-filter>
</activity>

通过上面的代码，${applicationId} 会被替换成真实的 applicationId,例如对于 branchOne 这个 variant,它会变成：

这是非常有用的，因为我们要根据 variant 用不同的 applicationId 填充Manifest.

如果你想创建自己的占位符，你可以在 manifestPlaceholders 定义，语法是：

productFlavors {
    branchOne {
        manifestPlaceholders = [branchCustoName :"defaultName"]
    }
    branchTwo {
        manifestPlaceholders = [branchCustoName :"otherName"]
    }
}

To go further

如果你想做更复杂的事情，你可以 applicationVariants.all 这个task中添加代码进行执行。

思考一下，假设，我想设置一个特定的 applicationId 给 branchTwo 和distrib 结合的 variant,我可以在 build.gradle 里面这样写：

applicationVariants.all { variant ->
    def mergedFlavor = variant.mergedFlavor
    switch (variant.flavorName) {
        case "brancheTwoDistrib":
            mergedFlavor.setApplicationId("com.example.oldNameBranchTwo")
            break
    }
}

有时某些 buildTypes-flavor 结合没有意义，我们想告诉 Gradle 不要生成这些 variants,没有问题，只需要用 variant filter 就可以做到

variantFilter { variant ->
    if (variant.buildType.name.equals('release')) {
        variant.setIgnore(!variant.getFlavors().get(1).name.equals('distrib'));
    }
    if (variant.buildType.name.equals('debug')) {
        variant.setIgnore(variant.getFlavors().get(1).name.equals('distrib'));
    }
}

在上面的代码中，我们告诉 Gradle buildType=debug 不要和 flavor=distrib 结合而 buildType=release 只和 flavor=distrib 结合，生成的 Variants

3.Facilitate continuous integration（简化持续集成）

持续集成对于 Applidium 是一个大挑战，它是一种可以在开发的各个阶段保证你的代码质量的方法。下面是一些让集成CI更简单的技巧。

Thanks to buildVariants

从上面的例子我们可以看到 buildVariants(buildType+productFlavors) 允许存在多个拥有各自资源和配置的开发环境。有了这些不同的开发环境，你可以很容易在假数据之间(stubs,suitable for tests)或者一个接近生产条件的环境(preprod)中进行切换。

With a plug-in

classpath 'com.novoda:gradle-android-command-plugin:1.4.0'

这个插件可以在 Gradle tasks 中执行 adb 命令，事实上，把所有的部署步骤集中在一个工具中是很重要的。这样，所有的部署链可以用一个单一的命令执行和最小化错误机率。当我们在 Android Studio build+run 构建运行一个应用程序时，Android Studio 隐藏的事实是它使用了几个工具：首先执行Gradle assemble task 然后通过 adb 安装和启动 app。在 CI Server 或者其他你没有 Android Studio 的地方。你可以通过这个插件构建 build 和运行 app

只需要在根目录的 build.gradle 添加一行即可

dependencies {
  classpath 'com.android.tools.build:gradle:1.3.0'
  classpath 'com.jakewharton.sdkmanager:gradle-plugin:0.12.0'
  classpath 'com.novoda:gradle-android-command-plugin:1.4.0'  //添加该行
}

Automatically increase the versionCode（版本号自增长）

为了容易发现问题，推荐让 version code 自增长，避免问题，你可以创建一个让 version code 以 1 递增的 Gradle task。

下面是代码，添加到 build.gradle 里面

void bumpVersionCodeInFile(File file) {
    def text = file.text
    def matcher = (text =~ /versionCode ([0-9]+)/)
    if (matcher.size() != 1 || !matcher.hasGroup()) {
        throw new GradleException("Could not find versionCode in app/build.gradle")
    }
    def String versionCodeStr = matcher[0][1]
    def versionCode = Integer.valueOf(versionCodeStr)
    def newVersionCode = versionCode + 1
    def newContent = matcher.replaceFirst("versionCode " + newVersionCode)
    file.write(newContent)
}
task(bumpVersionCode) << {
    def appGradleFile = file('app/build.gradle')
    if (appGradleFile.canRead()) {
        bumpVersionCodeInFile(appGradleFile)
    } else {
        throw new GradleException("Could not read app/build.gradle");
    }
    def wearGradleFile = file('wear/build.gradle')
    if (wearGradleFile.canRead()) {
        bumpVersionCodeInFile(wearGradleFile)
    }
    // No exception here since projects are not required to have a wearable app
}

4.Tell us your interests（告诉我们你对哪些感兴趣）

这篇关于 Gradle 的文章到此结束了。接下来的主题还没确定，给我们分享你的想法或者你对 Android 还有哪些问题。我们将会尽力帮助你。

5.其他资源

使用 Gradle 管理 Debug/Release 版本的Key http://www.jianshu.com/p/3f25bef975e2

使用了文中的动态占位符技术

使用Gradle构建多个不同applicationId包 http://www.jianshu.com/p/037327da4893

使用了文中的 productFlavor and buildConfigField 同时打包多个开发环境包

与之相关

1 

日

更

精

彩

请系好安全带

「code小生」