在使用Android Studio创建工程时,会在根目录创建类似如下的build.gradle。本文将从初学者的角度来解释每一行的意思,具体的细节还需查看gradle的API文档。
如果要学习gradle,推荐一篇写得很好的blog深入理解Android之Gradle。个人认为最重要的一点是不要把build.gradle简单地看作配置文件,而是要把它看作一种编程框架,使用其API或者Groovy编程语言来完成编译、打包、测试等工作。
以下的注释为每一行代码的意思,希望对理解build.gradle有所帮助。
// Top-level build file where you can add configuration options common to all sub-projects/modules.
// Gradle中可以使用“//”或“/**/”来添加注释,与Java类似。
// 根目录下的build.gradle用于添加子工程或模块共用的配置项。
// "buildscript"的类型为script block,而且是最上层的script block,用于配置Gradle的Project实例。其API文档为https://docs.gradle.org/current/dsl/org.gradle.api.Project.html#org.gradle.api.Project:buildscript(groovy.lang.Closure)
// 其余的根script block有"allprojects", "dependencies", "configurations"等,更多的可见https://docs.gradle.org/current/dsl/的“Build script structure”一节。
// Script Block是一种method的调用,传入的参数为configuration closure。执行后会对Project的属性进行配置。
// 此处的"buildscript"用于配置Project的build script的classpath。
buildscript {
// 如果需要的话,从https://jcenter.bintray.com/下载code reposities。
repositories {
jcenter()
}
// 定义classpath,gradle会从“repositories”中下载对应版本的Gradle。如果使用gradle wrapper的话,感觉这个配置会被忽略。Wrapper会自己去下载所使用的gradle版本。
dependencies {
classpath 'com.android.tools.build:gradle:2.1.3'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
// 该配置会被应用到所有的子工程。
allprojects {
repositories {
jcenter()
}
}
// 运行gradle clean时,执行此处定义的task。
// 该任务继承自Delete,删除根目录中的build目录。
// 相当于执行Delete.delete(rootProject.buildDir)。
// gradle使用groovy语言,调用method时可以不用加()。
task clean(type: Delete) {
delete rootProject.buildDir
}
另外,根目录下还有一个settings.gradle文件, 内容如下。
// 调用include函数,将子工程app(目录名为app)导入进来。
// ':'表示app是一个相对路径,跟路径为该工程的根目录。
include ':app'
settings.gradle的作用就是导入子工程。它支持导入多个子工程,使整个工程支持multi-project的编译。
当有多个子工程时,gradle既可以在根目录下执行任务(比如:gradle tasks会显示在根目录下可以执行的任务),又可以在相应的子工程下执行任务(比如:gradle :app:tasks会显示在子工程app下可以执行的任务)。
如果有的app之间有依赖关系,或者app依赖需本地编译的库,使用multi-project编译会增加编译的灵活性,因为在build.gradle中可以指定或修改任务之间的依赖关系。
网友评论