补齐Android技能树 - 玩转Gradle(二) _ 小册免费学(1)

/* ========= ① 获取全局属性 ========= */

gradleHomeDir → 执行此次构建的Gradle目录；
gradleUserHomeDir → Gradle User Home目录；
gradleVersion → 当前Gradle版本；
includedBuilds → 获取内嵌构建；
parent → 获取父构建；
pluginManager → 获取插件管理器实例；
plugins → 获取插件容器；
rootProject → 获取当前构建的根项目；
startParameter → 获取传入当前构建的所有参数
taskGraph → 获取当前构建的task graph，此对象在taskGraph.whenReady { } 后才具有内容

/* ========= ② 项目配置，闭包方法会在Project可用时立即执行 ========= */

rootProject(action) // 为Root Project添加闭包
allprojects(action) // 为所有 Project添加闭包

应用示例：Gradle全局设置Maven仓库，创建一个 $GRADLE_USER_HOME/init.gradle(.kts) 或在 $GRADLE_USER_HOME/init.d/ 目录下随便创建一个xxx.gradle(.ktx)文件，内容如下：

// 项目依赖仓库
allprojects {
repositories {
maven { url “https://maven.aliyun.com/repository/google” }
maven { url “https://maven.aliyun.com/repository/jcenter” }
}
}

// Gradle脚本依赖仓库
gradle.projectsLoaded {
rootProject.buildscript {
repositories {
maven { url “https://maven.aliyun.com/repository/google” }
maven { url “https://maven.aliyun.com/repository/jcenter” }
}
}
}

配置后，Gradle项目构建时会优先从这里的Maven仓库下载依赖，然后再到项目中配置的仓库中下载，在Gradle编译提速中，可把Maven地址替换为自己搭建的Maven私服，所以Gradle项目编译时都会优先走这里~

---

2. Settings Script(设置脚本)

涉及文件：项目根目录下的 settings.gradle(.kts)，在此文件中：声明参数构建的模块 及 管理构建过程需要的插件，此处会生成一个 Settings 对象。

Gradle会从当前目录开始查找此文件，找到停止找不到则往父目录递归查找，所以建议不管是单项目还是多项目，都要有一个 settings.gradle(.kts) 文件。

① 声明参数构建的模块

Settings类中，最重要的方法就是 include(String… projectPaths) 方法，用于添加参与构建的Project，传入一个 可变参数，值是每个Project的路径( 当前project相对于根project的路径 )，示例如下：

// [:]代表项目分隔符，类似于路径分隔中的[/]，以:开头表示相对于根目录
include ‘:module1’
include ‘:libs:library1’
// 也可写到一行
include ‘:module1’,‘:libs:library1’

// 注：当子项目不在根目录下时需使用相对路径描述
project(“:module3”).projectDir = File(rootDir, “…/…/library2”)

// 默认情况下Gradle会使用根项目所在目录名称作为项目名
// 配合CI一起使用时，往往会检测到一个随机文件名，可以强制指定项目名称
rootProject.name = ‘JustTest’

每个被include的项目都会生成 ProjectDescriptor 对象, 用于描述该模块。模块名称最终都会添加到Map类型的 DefaultProjectRegistry.projects 中，所以无需特殊处理include的顺序。

另外，即便settings.gradle(.kts)什么都不写，也会加载当前目录下的Build Script。

② 管理构建过程需要的插件

通过 settings.pluginManagement 的相关接口实现，比如指定插件的仓库地址(默认从Gradle官方创建仓库查找)，打开settings.gradle：

pluginManagement {
// 对应PluginManagementSpec类
repositories { // 管理Plugin Repository(仓库)
google { url “https://maven.aliyun.com/repository/gradle-plugin” }
}
}

rootProject.name = ‘temp’
include ‘:module1’,‘:module2’

利用 resolutionStrategy 接口则可进行插件决策，比如打印一个Kotlin项目用到的插件信息：

resolutionStrategy {
eachPlugin { // 接收一个PluginResolveDetails类型的闭包，通过requestsd可以获得plugin的信息
println “${requested.id} → ${requested.module} → ${requested.version}”
}
}

输出结果如下：

接着可以根据id替换插件或指定插件版本，示例如下：

resolutionStrategy {
eachPlugin { // 接收一个PluginResolveDetails类型的闭包，requested可以获得plugin的信息
println “${requested.id} → ${requested.module} → KaTeX parse error: Expected '}', got 'EOF' at end of input: ….gradle.plugin:{requested.version}”)
}
// 统一插件版本
if (requested.id.id == “org.jetbrains.kotlin.jvm”) {
useVersion(“1.3.71”)
}
}
}

另外，此阶段涉及到的两个生命周期事件：settingsEvaluated() 和 projectLoaded()，前者可以拿到配置完毕的 Setting 对象，后者可以拿到包含项目基础信息的 Project 对象。

---

3. Build Script(构建脚本)

涉及文件：模块目录下的 build.gradle(.kts)，用于配置当前模块的 构建信息，分为：

• 根目录模块的 Root Build Script (一般是对子模块进行统一的配置，没有太多内容)；
• 子模块的 Module Build Script；

多模块的构建流程：Init Script → Settings Script → Root Build Script(单模块没这一步) → Build Script (默认字母序，可通过设置依赖关系干预)

Build Script完成的工作有两个：插件引入 和 属性配置，即对 Project 对象进行进一步的配置，生成Task的有向无环图。

① 插件引入

Gradle自身 并没有提供编译打包的功能，它只是一个 负责定义流程和规则的框架，具体的编译工作都是由 插件 来完成的，比如编译Java用Java插件，编译Kotlin用Kotlin插件。

所以插件到底是什么？→ 答：定义Task，并具体执行这些Task的模板。

插件的两种类型：

• 脚本插件：存在于另一个脚本文件中的一段脚本代码；
• 二进制插件(编译成字节码)：实现Plugin接口，通过编程的方式操作构建过程(项目或Jar包形式)；

Gradle会内置一些核心插件，并提供简单名字，如 “java”，没在其中的插件则需采用完整名字，如：“org.jetbrains.kotlin:kotlin-gradle-plugin”，这个又称插件id，唯一不可重复！引入方式区别如下：

// 内置插件引入
apply plugin: ‘kotlin-android’
// 也可以使用plugins，不过有些插件不能指定版本，有些必须指定，要注意！
// 下面这种写法是Kotlin中的中缀表达式，apply→ 是否立即应用插件
plugins {
id(“org.jetbrains.kotlin.jvm”) version “1.3.71”
id(“org.jetbrains.kotlin.jvm”) version “1.3.71” apply false
java
build-scan
}

// 非内置插件引入，会将对应Jar文件放到Gradle的classpath下
buildscript {
repositories {
jcenter()
}
dependencies {
classpath “org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.72”
}
}

② 属性配置

一旦应用了某个插件，就可以使用此插件提供的DSL进行配置，以此干预模块的构建过程。以Android构建为例：

// 引入android.application插件 → 为Project对象添加一个android{}配置闭包
apply plugin: ‘com.android.application’

android {
compileSdkVersion 29 // 使用API 29编译此模块

// 编译时的一些配置
defaultConfig {
applicationId “com.example.test”
minSdkVersion 26
targetSdkVersion 29
versionCode 1
versionName “1.0”
}

// 签名配置
signingConfigs {
release {
storeFile file(‘test.jks’)
storePassword ‘123456’
keyAlias ‘test’
keyPassword ‘123456’
}
}

// 构建类型配置
buildTypes {
release {
minifyEnabled true
shrinkResources true
proguardFiles getDefaultProguardFile(‘proguard-android-optimize.txt’), ‘proguard-rules.pro’
signingConfig signingConfigs.release
}
}

// 编译选项配置
compileOptions{
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}

除了插件另外引入的属性DSL外，Project对象也提供了很多用于配置构建的DSL，如 dependencies 配置编译依赖项，更多可以点进Project源码中自行查看。

另外根目录Build Script还可以使用一个 ext 属性用于Project间的数据共享、统一模块依赖版本。

// 根目录build.gradle配置
ext {
applicationId = “xxx.xxx.xxx”
buildToolsVersion = “28.0.3”
compileSdkVersion = 28
minSdkVersion = 22
…
}

// 子模块build.gradle使用
android {
compileSdkVersion rootProject.ext.compileSdkVersion
buildToolsVersion rootProject.ext.buildToolsVersion
…
}

---

0x2、依赖规则

Gradle会声明每个依赖项的适用范围，可以理解为 分组，如：有些依赖在编译时用到，有些则在运行时用到，Gradle通过 Configuration 来表示这个范围(分组)，不同的Configuration通过不同的name区分。

许多Gradle插件会预置一些Configuration添加到你的项目中，如Java插件：

有点懵，没关系，看下Android内置的这些Configuration你就懂了(2.x是废弃的)：

// 对应2.x的 compile，既参与编译又参与打包
implementation → 当前模块依赖，但不向其他模块暴露此依赖，编译时只能在本模块访问；
api → 当前模块依赖，且向其他模块暴露此依赖，同compile；

举例区分下：
模块A、B，如果A依赖了Gson库，B依赖A，使用implementation，B用不了Gson，使用api，B可以使用Gson。

// 对应2.x的provided和apk，用的较少
compileOnly → 编译时有效，不会参与打包；
runtimeOnly → 运行时有效，不会参与编译；

annotationProcessor → 注解处理器依赖

testCompile → 对应2.x的testImplementation，只在单元测试代码的编译以及最终打包测试apk时有效；
debugCompile → 对应2.x的debugImplementation，只在debug模式的编译和最终的debug apk打包时有效；
releaseCompile → releaseImplementation，只在release的编译和最终的release apk打包时有效；

附：四种依赖方式

// ① 本地library依赖
implementation project(“:mylibrary”)

// ② 本地二进制依赖
implementation files(‘libs/xxx.jar’, ‘libs/yyy.jar’) // 依赖特定库
implementation fileTree(dir: ‘libs’, include: [‘*.jar’]) // 依赖目录下的库

// ③ 远程二进制依赖
implementation(‘io.reactivex:rxandroid:1.2.1’)

// ④ AAR包依赖
implementation(name: ‘me.leolin:ShortcutBadger’, ext: ‘aar’) // 本地
implementation ‘me.leolin:ShortcutBadger:1.1.17@aar’ // 远程

当然，你也可以自定义一个Configuration，示例如下：

allprojects {
// 配置maven仓库地址
repositories {
maven { url “https://maven.aliyun.com/repository/jcenter” }
}
}

// 定义一个名为myDependency的Configuration
configurations {
myDependency
}

// 为自定义Configuration添加依赖
dependencies {
myDependency(‘io.reactivex:rxjava:1.1.9’)
myDependency(‘io.reactivex:rxandroid:1.2.1’)
}

// 打印自定义Configuration下载依赖后的文件地址
task showMyDependency {
println configurations.myDependency.asPath
}

终端键入：gradle showMyDependency，输出结果如下：

还可以调 extendsFrom 方法来继承另一个Configuration的所有dependencies，比如implementation就继承了compile。

最后还得提提两个标志，默认都为true：

• canBeResolved：编译时依赖
• canBeConsumed：运行时依赖

0x3、依赖创建的过程

Tips：跟源码了解下原理，不感兴趣可以直接跳过，不影响后续学习~

1. 依赖识别

build.gradle 处点开 dependencies，定位到了 Project 类：

看注释：传递的闭包由此Project的 DependencyHandler 执行，定位到此接口：

可以看到每个方法都返回 Dependency 实例，点开这个接口：

噢吼，接口定义了获取group、name、version的方法，回到 DependencyHandler 的 add() 方法，最多可传递三个参数：

implementation(io.reactivex:rxandroid:1.2.1) {
transitive = false
}

Dependency add(String configurationName, Object dependencyNotation, Closure configureClosure);

// 参数一一对应：

implementation、io.reactivex:rxandroid:1.2.1、后面跟着的大括号(依赖配置闭包)

AS只能跟到这里，接着用VS Code打开Gradle的源码，全局搜下 implements DependencyHandler，定位到 DefaultDependencyHandler 类：

该类除了实现 DependencyHandler 接口外，还实现了一个**MethodMixIn** 接口：

在讲解这个接口前，我们先来了解下Groovy语言的两个特性：invokeMethod 和 methodMissing，先介绍下前者：

package groovy.reflect

class InvokeTest1 {
def hello() {
‘执行Hello方法’
}

def invokeMethod(String name, Object args) {
return “未知方法 $name(${args.join(‘,’)})”
}

static main(args) {
def it = new InvokeTest1()
println it.hello()
println it.foo(“test”, 28)
}
}

// 运行输出：
// 执行Hello方法
// 未知方法 foo(test, 28)

对于一个对象的方法调用，类中有此方法就分发给此方法，如果不能分派，就调用invokeMethod方法，而methodMissing同样能实现上面的效果：

package groovy.reflect

class InvokeTest1 {
def hello() {
‘执行Hello方法’
}

def methodMissing(String name, Object args) {
return “未知方法 $name(${args.join(‘,’)})”
}

static main(args) {
def it = new InvokeTest1()
println it.hello()
println it.foo(“test”, 28)
}
}

输出结果相同，而在Groovy中invokeMethod是用来 分发一个对象的所有方法 (已实现和未实现)的，要借助 GroovyInterceptable 接口。而methodMissing则只能 分发一个类未实现的方法，无论它是否实现了GroovyInterceptable接口。

总结下就是：invokeMethod管理所有方法，methodMissing只管理类所有的未实现方法！

弄懂后回到 MethodMixIn 接口，其实就是Gradle对methodMissing的封装，类想要实现这个特性，只需实现此接口，接口中定义了一个抽象方法 getAdditionalMethods() 返回一个 MethodAccess 对象：

定义了两个方法：判断某Method是否存在，动态执行Method，如出一辙，可以，跟下 getAdditionalMethods 重写处：

跟下哪里给 dynamicMethods 属性赋值：

跟下 DynamicAddDependencyMethods：

参数个数判断，最后都调用到 dependencyAdder.add()，而 DependencyAdder 是一个内部接口，跟下哪里实现了：

实际上还是调用的 DefaultDependencyHandler 的 doAdd() 方法：

判断dependencyNotation是否为Configuration对象，如果存在，就让当前的configuration对象继承dependencyNotation，即将添加到dependencyNotation的依赖都添加到configuration中。

2. 依赖创建

往下一点，可以看到 DefaultDependencyHandler 调用 create() 方法创建了一个 Dependency 的实例，跟下：

跟下：DefaultDependencyFactory → createDependency()

调用 dependencyNotationParser 实例的 parseNotation() 创建了 Dependency 实例，往上跟下：

构造方法里设置了这个参数，跟下哪里传入的：

跟下：DependencyNotationParser → parser()

可以看到好几种类型的 NotationConverter (依赖转换器)：

// ① DependencyStringNotationConverter、DependencyMapNotationConverter 针对下面这种：
implementation(io.reactivex:rxandroid:1.2.1) {
transitive = false
}

// ② DependencyFilesNotationConverter 针对下面这种：
implementation fileTree(dir:‘libs’, include:[‘*.jar’])

最后

如果你看到了这里，觉得文章写得不错就给个赞呗？如果你觉得那里值得改进的，请给我留言。一定会认真查询，修正不足。谢谢。

最后针对Android程序员，我这边给大家整理了一些资料，包括不限于高级UI、性能优化、移动架构师、NDK、混合式开发（ReactNative+Weex）微信小程序、Flutter等全方面的Android进阶实践技术；希望能帮助到大家，也节省大家在网上搜索资料的时间来学习，也可以分享动态给身边好友一起学习！
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！
false
}

// ② DependencyFilesNotationConverter 针对下面这种：
implementation fileTree(dir:‘libs’, include:[‘*.jar’])

最后

如果你看到了这里，觉得文章写得不错就给个赞呗？如果你觉得那里值得改进的，请给我留言。一定会认真查询，修正不足。谢谢。

[外链图片转存中…(img-wgTGwAog-1715143761237)]

最后针对Android程序员，我这边给大家整理了一些资料，包括不限于高级UI、性能优化、移动架构师、NDK、混合式开发（ReactNative+Weex）微信小程序、Flutter等全方面的Android进阶实践技术；希望能帮助到大家，也节省大家在网上搜索资料的时间来学习，也可以分享动态给身边好友一起学习！
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！