1 上手
简而言之,gradle 是一个基于 groovy 编程语言的软件框架,主要用于源代码的组织管理和编译。
概念很抽象,下面我们实际体验一下 gradle 在 Android 开发中的应用,在实际应用中理解 gradle。
使用 Android Studio 新建一个 Empty Activity 项目:
项目建好后,看一下目录结构:
tree -L 2
.
├── app
│ ├── build
│ ├── build.gradle
│ ├── libs
│ ├── proguard-rules.pro
│ └── src
├── build.gradle
├── gradle
│ └── wrapper
├── gradle.properties
├── gradlew
├── gradlew.bat
├── local.properties
└── settings.gradle
项目中的 gradle 脚本有:
- 根目录下的 settings.gradle build.gradle
- app 目录下的 build.gradl
下面我们逐个介绍其作用:
settings.gradle
settings.gradle: 对项目做整体的配置,核心功能点是配置整个项目的结构
//配置gradle的远程依赖仓库
pluginManagement {
repositories {
gradlePluginPortal()
google()
mavenCentral()
}
}
//配置项目的远程依赖仓库
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
}
}
//指定项目名称
rootProject.name = "HelloAndroid"
//指定项目包含了哪些子项目
include ':app'
最新的 Gradle 7.x 版本将远程库的配置统一在了 settings.gradle 中。
这里解释一下什么是 “gradle 的远程依赖库" , 什么是 "项目的远程依赖库":
- gradle 配置脚本身也是一个软件项目,他也需要使用一些第三方库(主要是一些 gradle 插件),这些第三方库就在 “gradle 的远程依赖库”中查找并下载到本地。
- 我们写的 Android App 项目需要使用很多第三方库,这些库就在 “项目的远程依赖仓库”中查找并下载
远程库的服务器一般在境外,下载速度慢,解决方法主要有两种:
- 使用阿里云镜像
- 使用 maven 私服
我们可以把 settings 修改为以下内容以加快第三库的下载速度:
//配置gradle的远程依赖仓库
pluginManagement {
repositories {
maven { url 'https://maven.aliyun.com/repository/gradle-plugin' }
maven { url 'https://maven.aliyun.com/repository/google' }
maven { url 'https://maven.aliyun.com/repository/public/' }
}
}
//配置项目的远程依赖仓库
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
maven { url 'https://maven.aliyun.com/repository/google' }
maven { url 'https://maven.aliyun.com/repository/public/' }
}
}
//指定项目名称
rootProject.name = "HelloAndroid"
//指定项目包含了哪些子项目
include ':app'
容易发现,相比于早起版本,这里多了一个 repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)。在 gradle 文档 中介绍了其作用:
FAIL_ON_PROJECT_REPOS :在项目的子 module 中配置仓库信息会导致编译失败。
PREFER_PROJECT:使用子 module 中配置仓库信息,忽略根目录中 settings 配置的仓库信息
PREFER_SETTINGS:使用根目录中 settings 配置的仓库信息,忽略子 module 中配置仓库信息
build.gradle
build.gradle:根目录下得 build.gradle,对项目整体进行配置,与 setting 分工协作:
//申明可能会用到的 gralde 插件,这里的插件均从 gradle 的远程依赖仓库中下载
plugins {
id 'com.android.application' version '7.1.2' apply false
id 'com.android.library' version '7.1.2' apply false
}
//自定义 clean Task
task clean(type: Delete) {
delete rootProject.buildDir
}
app/build.gradle
app/build.gradle:用于配置 app module:
//应用 Android Gradle Plugin 插件,这是一个 Android App 项目
plugins {
id 'com.android.application'
}
//配置 Android Application 项目,插件提供的配置内容
android {
//sdk 版本
compileSdk 32
//android app 项目的配置,从名字可知道其基本功能
defaultConfig {
applicationId "com.zzh.helloandroid"
minSdk 21
targetSdk 32
versionCode 1
versionName "1.0"
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}
//编译类型,后面详说
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
}
}
//设置 java 版本
compileOptions {
//Language level of the java source code
sourceCompatibility JavaVersion.VERSION_1_8
//Version of the generated Java bytecode
targetCompatibility JavaVersion.VERSION_1_8
}
}
//配置项目依赖的第三方库
dependencies {
implementation 'androidx.appcompat:appcompat:1.4.1'
implementation 'com.google.android.material:material:1.5.0'
implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
testImplementation 'junit:junit:4.13.2'
androidTestImplementation 'androidx.test.ext:junit:1.1.3'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
}
至此,我们了解一个使用 gradle 组织的 Android App 项目的基本结构。
2 执行 gradle 脚本
当通过 Android Studio 新建好项目后,可以使用命令行来执行 gradle 脚本以完成编译运行打包等任务:
# 这里使用 gradlew, gradlew 是一个bash可执行文件,
# 它对 gradle 进行了包装以保证执行时使用正确的gradle版本
./gradlew build #编译整个项目
./gradlew assembleDebug #生成 debug 的apk
./gradlew installDebug #安装 debug 的程序到手机
这里执行的都是 gradle 的 task,我们通过 ./gradlew tasks 命令查看所有的 task。
这里我们会基本的命令行使用即可,具体的概念(task,gradlew等)会在后续文章中讲解。
3 基本概念理解
以 .gradle 结尾的文件,称之为 gradle 脚本。gradle 脚本由零个或多个声明(statements)和脚本块(script blocks)组成。声明(statements)包含了方法调用,属性赋值,本地变量定义。脚本块(script blocks)是一个以闭包(closure)为参数的方法调用,这些方法通常用于配置委托对象(delegate object)。比如 settings.gradle 中:
//脚本块
pluginManagement {
repositories {
gradlePluginPortal()
google()
mavenCentral()
}
}
//脚本块
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
}
}
//声明
rootProject.name = "HelloAndroid"
//声明
include ':app'
当执行 gradle 脚本时,gradle 会为每个脚本生成一个对象并通过脚本的内容来配置这个对象。这个对象称之为脚本的委托对象(delegate object)。settings.gradle 对应 Settings 对象,build.gradle 对应 Project 对象。
要理解这些对象,理解声明和脚本块,需要我们了解 groovy 的基本语法。接下来的内容,我们就来看看 groovy 这门语言。