Android Gradle开发指南

Posted 2022-09-07 wx5aae83353cec4

Gradle简介

Gradle 是一个优秀的构建系统和构建工具，它允许通过插件创建自定义的构建逻辑。它具有如下一些特点：

• 采用了 Domain Specific Language(DSL 语言) 来描述和控制构建逻辑。
• 构建文件基于 Groovy，并且允许通过混合声明 DSL 元素和使用代码来控制 DSL 元素以控制自定义的构建逻辑。
• 支持 Maven 或者 Ivy 的依赖管理。
• 非常灵活。允许使用最好的实现，但是不会强制实现的方式。
• 插件可以提供自己的 DSL 和 API 以供构建文件使用。
• 良好的 API 工具供 IDE 集成。

使用Gradle方式来构建项目，主要是为了达到如下的一些目的：

• 让重用代码和资源变得更加容易
• 让创建同一应用程序的不同版本变得更加容易，无论是多个 apk 发布版本还是同一个应用的不同定制版本
• 让构建过程变得更加容易配置，扩展和定制。
• 整合优秀的 IDE。

构建项目基础

文件构建

一个Gradle项目的构建过程定义在build.gradle文件中，位于项目的根目录下。一个最简单的Gradle纯Java项目的build.gradle文件包含以下内容。

apply plugin: java

上面的代码是引入了Gradle的Java插件，这个插件提供了所有构建和测试Java应用程序所需要的东西。例如，下面是一个最简单的android项目的build.gradle文件的源代码。

buildscript 
    repositories 
        google()
        jcenter()
        
    
    dependencies 
        classpath com.android.tools.build:gradle:3.4.1
    


allprojects 
    repositories 
        google()
        jcenter()
        
    


task clean(type: Delete) 
    delete rootProject.buildDir

build.gradle文件

在一个Android项目中一般会出现至少2个build.gradle文件，一个是project的gradle文件，一个是app module的gradle文件。

gradle文件中会涉及很多的常用命令和代码，它们的具体含义如下：

1，jcenter()

代码托管库，设置后可以在项目中引用jcenter上的开源项目，声明在build.gradle文件的repositories闭包中。

2，gradle插件及版本号

经常会看到如下一段代码：

 classpath com.android.tools.build:gradle:3.4.1

3，Android 闭包配置

在build.gradle的Android闭包中会看到一些常用的配置，如下所示：

• compileSdkVersion： 用于指定项目的编译版本。
• buildToolsVersion： 用于指定项目的构建工具的版本。
• applicationId: 用于指定项目的包名，在创建项目的时候已经指定了包名，当要修改整个项目的包名时可以在此更改。
• minSdkVersion: 项目最低的兼容版本。
• targetSdkVersion：表示你在该目标版本上已经做过了充分的测试，系统将为你的应用开启一些最新的功能和特性。假如targetSdkVersion 为23或者更高，那么在Android6.0中运行这个应用时会开启新的功能和特性；若设置成了22，只能说明你的应用程序在Android5.1系统上做过了充分的测试，Android6.0的新功能就不会启用。
• versionCode： 项目的版本号。
• versionName： 项目版本号的版本名。

4，buildTypes闭包

此配置包一般会包含两个闭包配置，一个是debug，一个release；当然也可以有其他闭包。debug闭包用于生成测试版安装文件的配置，release闭包用于生成正式版安装文件的配置。此文件的配置如下：

• minifyEnabled：用于设置是否对项目的代码进行混淆。true代表开启，false代表关闭。
• proguardFiles:指定混淆时使用的文件。
• proguard-android.txt：在Android SDK 目录下的，里面是所有项目通用的混淆规则。
• proguard-rules.pro：是在当前项目根目录下的，里面编写当前项目特有的混淆规则。

5，dependencies闭包

Android Studio 项目开发中一共有三种依赖方式：本地依赖、库依赖和远程依赖。

• 本地依赖：可以对本地的Jar包或目录添加依赖关系。
• 库依赖：可以对项目中的库模块添加依赖关系。
• 远程依赖：=可以对jcenter库上的开源项目添加依赖关系。

项目结构

Gradle遵循约定优先于配置的概念，在可能的情况尽可能提供合理的默认配置参数。Android基本的项目开始于两个名为“source sets”的组件，即main source code和test code。它们分别位于：src/main/和src/androidTest/文件中。
对于Java plugin和Android plugin来说，它们的Java源代码和资源文件路径如下：java/和resources/文件目录中。

对于Android plugin来说，它还拥有以下特有的文件和文件夹结构：

• AndroidManifest.xml
• res/
• assets/
• aidl/
• rs/
• jni/

配置结构

当默认的项目结构不适用的时候，你可能需要去自定义配置它。根据Gradle文档，重新为Java项目配置sourceSets可以使用以下方法：

sourceSets 
    main 
        java 
            srcDir src/java
        
        resources 
            srcDir src/resources
        
    

当然，也可以使用如下的配置方式：

sourceSets 
    main.java.srcDirs = [src/java]
    main.resources.srcDirs = [src/resources]

Android Plugin使用的是类似的语法。但是由于它使用的是自己的sourceSets，这些配置将会被添加在android对象中。

以下是一个示例，它使用了旧项目结构中的main源码，并且将androidTestsourceSet组件重新映射到tests文件夹。

android 
    sourceSets 
        main 
            manifest.srcFile AndroidManifest.xml
            java.srcDirs = [src]
            resources.srcDirs = [src]
            aidl.srcDirs = [src]
            renderscript.srcDirs = [src]
            res.srcDirs = [res]
            assets.srcDirs = [assets]
        

        androidTest.setRoot(tests)
    

构建任务

通用任务

添加一个插件到构建文件中将会自动创建一系列构建任务(build tasks)去执行（注：gradle属于任务驱动型构建工具，它的构建过程是基于Task的）。Java plugin和Android plugin都可以创建以下task。

• assemble：这个task将会组合项目的所有输出。
• check：这个task将会执行所有检查操作。
• build：这个task将会执行assemble和check两个task的所有工作。
• clean：这个task将会清空项目的输出。

实际上assemble，check，build这三个task不做任何事情，它们只是一个Task标志，用来告诉android plugin添加实际需要执行的task，执行某些具体的工作。

例如，添加了findbugs plugin将会创建一个新的task并且让check task依赖于这个新的task。当check task被调用的时候，这个新的task将会先被调用。

在命令行环境中，可以执行以下命令来获取更多高级别的task。

gradle tasks

查看所有task列表和它们之间的依赖关系，可以执行以下命令。

gradle tasks --all

需要说明的是，Gradle会自动监视一个task声明的所有输入和输出。两次执行build task并且期间项目没有任何改动，gradle将会使用UP-TO-DATE通知所有task。这意味着第二次build执行的时候不会请求任何task执行。这允许task之间互相依赖，而不会导致不需要的构建请求被执行。

Java 项目的Task

Java plugin主要创建了两个task，一个是assemble，一个是check，它们都依赖于main task（一个标识性的task）。通常情况下，你只需要调用到assemble和check，不需要其他task。

Android Task

Android plugin使用相同的约定以兼容其他插件，并且附加了自己的标识性task，常用的Task包括：

• assemble：这个task用于组合项目中的所有输出。
• check：这个task用于执行所有检查。
• connectedCheck：这个task将会在一个指定的设备或者模拟器上执行检查，它们可以同时在所有连接的设备上执行。
• deviceCheck：通过APIs连接远程设备来执行检查，这是在CL服务器上使用的。
• build：这个task执行assemble和check的所有工作。
• clean：这个task清空项目的所有输出。

这些新的标识性task是必须的，以保证能够在没有设备连接的情况下执行定期检查。注意build task不依赖于deviceCheck或者connectedCheck。

一个Android项目至少拥有两个输出：debug APK和release APK，每一个输出都拥有自己的标识性task以便能够单独构建它们。

• assemble
• assembleDebug
• assembleRelease

其中assemble task依赖于其他两个task，所以执行assemble将会同时构建出两个APK。gradle在命令行终端上支持骆驼命名法的task简称，例如，执行

gradle aR

命令等同于执行

gradle assembleRelease

同时，check task也可以拥有自己的依赖，常见的依赖有：

• check
• lint
• connectedCheck
• connectedAndroidTest
• connectedUiAutomatorTest(目前还没有应用到）
• deviceCheck

Android 构建

Android plugin提供了大量DSL用于构建系统定制。

Manifest 属性

通过SDL，我们可以配置一下manifest选项。

• minSdkVersion
• targetSdkVersion
• versionName
• applicationId
• package Name for the test application
• Instrumentation test runner

例如：

android 
    compileSdkVersion 29
    buildToolsVersion "29.0.2"
    
    defaultConfig 
        applicationId "com.xzh.gradleplugin"
        minSdkVersion 15
        targetSdkVersion 29
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    

之前的Android Plugin版本使用packageName来配置manifest文件中的packageName属性。从0.11.0版本开始，你需要在build.gradle文件中使用applicationId来配置manifest文件中的packageName属性。这是为了消除应用程序的packageName（也是程序的ID）和java包名所引起的混乱。

在构建文件中定义的强大之处在于它是动态的。例如，可以从一个文件中或者其它自定义的逻辑代码中读取版本信息：

def computeVersionName() 
    ...


android 
    compileSdkVersion 29
    buildToolsVersion "29.0.2"
    
    defaultConfig 
        applicationId "com.xzh.gradleplugin"
        minSdkVersion 15
        targetSdkVersion 29
        versionCode 1
        versionName computeVersionName()
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    

如果一个属性没有使用DSL进行设置，一些默认的属性值将会被使用。以下表格是可能使用到的值：

Property Name	Default value in DSL object	Default value
versionCode	-1	value from manifest if present
versionName	null	value from manifest if present
minSdkVersion	-1	value from manifest if present
targetSdkVersion	-1	value from manifest if present
applicationId	null	value from manifest if present
testApplicationId	null	applicationId + “.test”
testInstrumentationRunner	null	android.test.InstrumentationTestRunner
signingConfig	null	null
proguardFile	N/A (set only)	N/A (set only)
proguardFiles	N/A (set only)	N/A (set only)

构建类型

默认情况下，Android Plugin会自动给项目设置同时构建应用程序的debug和release版本。两个版本之间的不同主要围绕着能否在一个安全设备上调试，以及APK如何签名。

Debug版本采用使用通用的name/password键值对自动创建的数字证书进行签名，以防止构建过程中出现请求信息。Release版本在构建过程中没有签名，需要稍后再签名。

这些配置通过一个BuildType对象来配置。默认情况下，这两个实例都会被创建，分别是一个debug版本和一个release版本。

Android plugin允许像创建其他构建类型一样定制debug和release实例。这需要在buildTypes的DSL容器中配置如下选项。

android 
    buildTypes 
        debug 
            applicationIdSuffix ".debug"
        

        jnidebug.initWith(buildTypes.debug)
        jnidebug 
            packageNameSuffix ".jnidebug"
            jnidebugBuild true
        
    

以上代码片段完成了如下功能：

• 配置默认的debug构建类型。
• 将debug版本的包名设置为.debug以便能够同时在一台设备上安装debug和release版本的apk。
• 创建了一个名为jnidebug的新构建类型，并且这个构建类型是debug构建类型的一个副本。
• 继续配置jnidebug构建类型，允许使用JNI组件，并且也添加了不一样的包名后缀。

创建一个新的构建类型就是简单的在buildType标签下添加一个新的元素，并且可以使用initWith()或者直接使用闭包来配置它。以下是一些可能使用到的属性和默认值：

Property Name	Default values for debug	Default values for release / other
debuggable	true	false
jniDebugBuild	false	false
renderscriptDebugBuild	false	false
renderscriptOptimLevel	3	3
applicationIdSuffix	null	null
versionNameSuffix	null	null
signingConfig	android.signingConfigs.debug	null
zipAlign	false	true
runProguard	false	false
proguardFile	N/A (set only)	N/A (set only)
proguardFiles	N/A (set only)	N/A (set only)

除了以上属性之外，Build Type还会受项目源码和资源影响：对于每一个Build Type都会自动创建一个匹配的sourceSet。默认的路径为：

  src/<buildtypename>/

这意味着BuildType名称不能是main或者androidTest（因为这两个是由plugin强制实现的），并且他们互相之间都必须是唯一的。跟其他sourceSet设置一样，Build Type的source set路径可以重新被定向。

android 
    sourceSets.jnidebug.setRoot(foo/jnidebug)