Gradle构建生命周期简介和通用Maven打包脚本
Gradle构建生命周期简介和通用Maven打包脚本
Gradle构建生命周期
Gradle构建过程分为三个大的步骤:初始化、配置和执行。
初始化
初始化阶段的任务是根据settings.gradle
创建项目的层次结构,为每一个module
创建一个Project
实例。并且在初始化之前会构造一个Settings对象,主要包含以下方法,可以直接在settings.gradle中访问。
- findProject(File): ProjectDescriptor
- findProject(String): ProjectDescriptor
- getGradle(): Gradle
- getRootDir():File
- getRootProject(): ProjectDescriptor
- getSettings(): Settings
- project(File): ProjectDescriptor
- project(String): ProjectDescriptor
比如可以通过如下代码向Gradle的构建过程添加监听:
gradle.addBuildListener(new BuildListener() {
void buildStarted(Gradle var1) {
println '开始构建'
}
void settingsEvaluated(Settings var1) {
println 'settings评估完成(settins.gradle中代码执行完毕)'
// var1.gradle.rootProject 这里访问Project对象时会报错,还未完成Project的初始化
}
void projectsLoaded(Gradle var1) {
println '项目结构加载完成(初始化阶段结束)'
println '初始化结束,可访问根项目:' + var1.gradle.rootProject
}
void projectsEvaluated(Gradle var1) {
println '所有项目评估完成(配置阶段结束)'
}
void buildFinished(BuildResult var1) {
println '构建结束 '
}
})
执行结果如下:
settings评估完成(settins.gradle中代码执行完毕)
项目结构加载完成(初始化阶段结束)
初始化结束,可访问根项目:root project 'GradleTest'
所有项目评估完成(配置阶段结束)
:buildEnvironment
------------------------------------------------------------
Root project
------------------------------------------------------------
classpath
No dependencies
BUILD SUCCESSFUL
Total time: 0.959 secs
构建结束
配置
配置阶段的任务是执行各项目下的build.gradle
脚本,完成Project
的配置,并且构造Task任务依赖关系图以便在执行阶段按照依赖关系执行Task。该阶段也是我们最常接触到的构建阶段,比如应用外部构建插件apply plugin: 'com.android.application'
,配置插件的属性android{...}等。每个build.gralde
脚本文件对应一个Project
对象,在初始化阶段创建,Project
的接口文档。配置阶段执行的代码包括build.gralde
中的各种语句、闭包以及Task中的配置段语句。
println 'build.gradle的配置阶段'
// 调用Project的dependencies(Closure c)声明项目依赖
dependencies {
// 闭包中执行的代码
println 'dependencies中执行的代码'
}
// 创建一个Task
task test() {
println 'Task中的配置代码'
// 定义一个闭包
def a = {
println 'Task中的配置代码2'
}
// 执行闭包
a()
doFirst {
println '这段代码配置阶段不执行'
}
}
println '我是顺序执行的'
调用gradle build,得到如下结果:
build.gradle的配置阶段
dependencies中执行的代码
Task中的配置代码
Task中的配置代码2
我是顺序执行的
:buildEnvironment
------------------------------------------------------------
Root project
------------------------------------------------------------
classpath
No dependencies
BUILD SUCCESSFUL
Total time: 1.144 secs
一定要注意,配置阶段不仅执行build.gradle中的语句,还包括了Task中的配置语句。**从上面执行结果中可以看到,在执行了dependencies的闭包后,直接执行的是任务test中的配置段代码(Task中除了Action外的代码段都在配置阶段执行)。
另外一点,无论执行Gradle的任何命令,初始化阶段和配置阶段的代码都会被执行。
同样是上面那段Gradle脚本,我们执行帮助任务gradle help,任然会打印出上面的执行结果。我们在排查构建速度问题的时候可以留意,是否部分代码可以写成任务Task,从而减少配置阶段消耗的时间。
执行
在配置阶段结束后,Gradle会根据任务Task的依赖关系创建一个有向无环图,可以通过Gradle对象的getTaskGraph方法访问,对应的类为TaskExecutionGraph,然后通过调用gradle <任务名>执行对应任务。
通用Maven打包上传脚本
通常我们在开发中遇到的情况是lib模块开发阶段和需要打包阶段的脚本配置方面有很大差别,所以一般的做法多为开发阶段的lib模块在需要上传到Maven仓库的时候,会有另外一个专用的项目来打包目标模块和上传,这个专用的模块一般情况下是一个壳子,而且可能因为lib模块在改动manifest文件或者BuildConfig参数的时候,需要对应要做出修改
但是这样做,往往意味着修改起来很麻烦,而且容易忘。所以我们需要一个通用的打包脚本来处理这些情况。
所以思路就是不使用壳module,直接使用开发的lib模块上传到maven库。而且考虑到历史原因及其兼容,不能直接在lib模块修改,那么就只能在rootProject这个层级考虑做一些事情。
上面有讲到Gradle在各个阶段的任务,同时,Gradle也提供了非常多的钩子给开发者自定义构建行为
gradle_hook.png由此可以看到,我们的目标很明确,就是在lib模块配置阶段为我们注入一些我们需要的操作:移除开发阶段的本地依赖、移除maven配置文件的本地依赖、添加本地依赖的maven版本依赖。
//跟项目.gradle
allprojects {
repositories {
jcenter()
google()
afterEvaluate { project ->
if (project.name == 'gisdk') {
println '依赖maven插件:apply plugin maven for ' + project
project.apply from: "${rootProject.projectDir}/maven.gradle"
println "取消发布时debug版本的编译"
project.android.publishNonDefault false
project.dependencies {
println '依赖现网模块'
compile "xxx.xxx:xxx:${version}"
}
project.configurations {
println '排除本地依赖'
all*.exclude group: '${root_project_name}'
}
project.tasks.create(name: 'deleteKeepProguardRules') {
doFirst {
def path = "${project.projectDir}/build/intermediates/exploded-aar/com.xxx/xxx/${rootProject.ext.gtc.version}/proguard.txt"
def bFile = new File(path)
if (bFile.exists()) {
bFile.delete()
println '删除keep文件成功'
} else {
println '文件不存在:' + path
}
}
}
project.tasks.whenTaskAdded { task ->
if (task.name == 'transformClassesAndResourcesWithProguardForRelease') {
task.dependsOn deleteKeepProguardRules
}
}
}
}
}
}
//maven.gradle
apply plugin: 'maven'
def mavenProps = rootProject.ext.maven // 配置
def getProjectVersion() {
def sdkProps = rootProject.ext.sdk // 配置
return sdkProps.version
}
uploadArchives {
repositories {
mavenDeployer {
repository(url: mavenProps.url) {
authentication(userName: mavenProps.userName, password: mavenProps.pwd)
}
pom.groupId = mavenProps.groupId
pom.artifactId = project.name
pom.version = getProjectVersion() + mavenProps.snapshot
println '上传的包:' + "${pom.groupId}:${pom.artifactId}:${pom.version}"
pom.whenConfigured { pom ->
def dependencies = []
pom.dependencies.each { dep ->
if (dep.version == 'unspecified') {
println "无效的依赖:${dep.groupId}:${dep.artifactId}:${dep.version}"
} else {
dependencies.add(dep)
}
}
pom.dependencies = dependencies
pom.dependencies.each { dep ->
println "最终的依赖:${dep.groupId}:${dep.artifactId}:${dep.version}"
}
}
}
}
}
至此,lib模块就可以实现无侵入式的maven打包上传能力