前言
kts脚本只需要在原来的groovy脚本的后面加一个.kts尾缀即可。
本文重点是介绍Gradle和Kotlin脚本,所以有些地方比较模糊,请读者自行搜索一下。
在不断探索中学习,如有不正确的讲解,谢谢你在评论或者私信指出~
基础概念
Gradle就是一套构建工具,常见用法是在控制台执行./gradlew xxx...
样式的命令来完成一个 Task,例如./gradlew assembleDebug
就是执行assembleDebug
这个Task 来打Debug APK。
当然,一个Task肯定完成不了所有的任务,因此它还依赖或者指定了一些其它的Task,它依赖的Task会在它开始之前执行,它指定的Task会在它执行之后执行,例如:compileDebugKotlin
这个Task就肯定会在assembleDebug
之前执行。
Task是执行一个具体的任务,但是在执行之前,Gradle会进行项目构建,也就是搭建好Task执行的环境,例如:项目内依赖了哪些库、项目内有多少个模块... 在构建期都需要做出相应的准备工作;
利用buildSrc写插件
其余部分自行搜索下,关键词:编写Gradle插件
我把buildSrc下kts配置文件贴出来,因为这里有点坑。。
plugins {
//支持kts
`kotlin-dsl`
}
//定义资源目录
val javaSourcePath = "src/main/java"
sourceSets.main.get().java.srcDir(javaSourcePath)
repositories {
//gradle tools
google()
mavenCentral()
//kotlin-dsl
jcenter()
}
dependencies {
//gradle工具
implementation("com.android.tools.build:gradle:4.1.1")
}
关键类
Project Gradle在项目构建时,会为每一个Module都生成一个Project对象,这个Project对象包含了该Module的所有配置信息,包括使用的插件、Task、扩展属性等等。
Project的诞生关键在于在于settings.gradle
中的配置——include
。
例如:
//某个Module的gradle脚本下(获取当前Project的父Project)
this.rootProject
Task 默认实现是DefaultTask,也就是任务的概念,Gradle的目标就是完成一个任务的运行,例如./gradlew assemble
打包任务的执行。例如:
//创建一个Task,现在只是一个类而已
class TestTask : DefaultTask() {
//这个注解,代表该方法会被自动执行
@TaskAction
fun doAction() {
//可以知道到这个Task属于哪个Project
println(project.name)
}
}
Pluginapply()
方法。Plugin就是Gradle插件,在“构建期”会被触发,apply()
方法会被调用。
需要注意的是插件是需要发布才能够使用的,使用buildSrc是实现了自动发布插件。而且Task也必须被添加到Project中才能够使用,并非写出Task类就可以执行了。
例如:
//在buildSrc下制作一个Gradle插件
class AppScriptPlugin : Plugin {
override fun apply(target: Project) {
//打印当前Project的名字
println("my name is ${target.name}")
//在该Project下创建一个Task
target.create("testTask", TestTask::class.java)
}
}
//在某个Module的gradle文件中使用这个插件
pluginManager.apply(AppScriptPlugin::class.java)
//在控制台执行自己的Task
./gradlew :[project名称]:tsetTask
ExtensionContainer 扩展集合,我们在构建过程中,仅仅使用Project自身的属性是不够的,所以我们需要为我们的Project搞一个扩展,方便我们直接在kts脚本中就改变一些自定义的值,而不用每次都去代码动态改变,例如:
//为了方便演示,我都放在了kts脚本里面写
//作为容器里的对象,必须有一个name属性
class Meta(val name: String) {
var data = 0
}
//创建这个领域对象容器
val myContainer: NamedDomainObjectContainer = project.container(Meta::class.java)
//使用容器。一般从扩展中取出,并使用
myContainer.apply {
//创建元素
create("meta1") {
data = 1
}
create("meta2") {
data = 2
}
}
//执行任务。一般在Java中动态执行,可以拿到属性
tasks.create("printAllMeta") {
//拿到单个数据
myContainer.getByName("meta1").data
myContainer.getByName("meta2").data
//循环输出输出
myContainer.all {
this.data
}
}
/**
* 这里只介绍容器的使用,实际使用我们使用是无法将Java生成的"myContainer"传递到kts中来
* 因此容器一般放在扩展里面使用,容器就是扩展类的一个成员对象而已
* 例如:extensions.configure("android") { buildTypes{ } }
*/
Transform 它就是一种特殊的Task,作用大,但使用难度也会比较高。
想创建一个Transform需要继承BaseTransform,并且它只能够通过BaseExtension来注册,例如extension.registerTransform(this)
,这也就限制了这个任务只能在任务链的某个节点执行,不像普通Task那样灵活。
Transform的强大之处在于它提供了在打包过程中操纵.class
、.dex
、 resources
的能力,简单描述就是:通过一个路径输入文件 - 操纵文件 - 通过一个路径输出文件。
构建期
构建期会执行各种脚本,配置项目。
在settings.gradle脚本执行之后,build.gradle脚本执行之前,所有的Project对象就会被创建好。
build.gradle执行过程中,就会执行各种Plugin,Plugin执行的是apply()
方法,apply()
输入就是当前build.gradle对应的Project对象,插件执行的过程中,就会为这个Project生成各种属性和注册各种Task。
- 属性:用于配置Project,一般在构建期就会为各种属性赋值,Task执行时尽量不要再修改Project的属性,因为Task执行链一般都是并行执行的;
- Task:代表这个Project具有的一项能力;
Task执行期
在构建期通过属性决定多种多样的task执行链,在Task链执行时,这条链便不会发生改变。
任务链执行过程中,不同Task之间是相对隔离的,几乎没有耦合。可以理解为从一棵树的根结点出发,向下遍历。
我们可以做的事
收敛项目配置
目的: 让项目gradle配置代码变得简单可维护。
思路: 使用插件统一项目的属性,例如版本号、依赖库等,防止因为build.gradle文件的分散而导致项目配置的可维护性降低。
打包自动化
目的: 让不熟悉打包的人也能一键完成打包。
思路: 打包是一种高频操作,使用已有的或者生产新的NamedDomainObjectContainer来配置不同的打包方式,对外屏蔽细节,以此提升其它人的开发效率。
增量编译
目的: 提升大型项目的构建和打包速度。
思路: 在每个Project配置完成后,分析这个Project依赖项目下其它的哪些Project,例如:业务Module总是会依赖组件Module。直接依赖其它Project我们称之为源码依赖,在没有缓存的情况下,每次打包会将所有的Project收集起来,对java文件进行编译,因此耗时。我们可以通过分析,将某些Project依赖变成aar依赖,因此打包的时候就省去了这个Project的java编译耗时;
AOP技术
目的: 在java业务代码无侵入的情况下,实现aop,例如埋点、日志、打点等操作。
思路:借助Transform对class字节码进行操纵,一般是在每个方法内插入aop逻辑。这个思路也是一种热修的方案,可见美团Robust。
......
结尾
文章如有不对之处,欢迎批评~
推荐一篇自己的文章Android10 屏幕方向适配