一、setting.gradle作用
settings.gradle 作为Android 项目构建配置的入口文件,它主要有以下五点作用:
1.定义项目根目录名称
rootProject.name = "MyAndroidProject" // 项目根目录名称
根项目名称是整个项目的唯一标识,在编译、打包、CI/CD等一些需要根据这个名称来标识这个项目。如果没有显性定义项目根目录名称,rootProject.name的默认值就是项目根目录文件夹名称。
2. 定义参与编译的模块和路径
假设项目结构如下:
MyProject/
├── settings.gradle
├── build.gradle
├── app/
│ └── build.gradle
├── custom/
│ ├── customView/
│ │ └── build.gradle
就要如此定义
include ':app'
include ':customView' // 必须
project(":customView").projectDir = new File("custom/customView") // 默认值是根目录下的模块文件夹
其他模块依赖的时候示例是
api project(':customview')
如果在setting.gradle这样声明
include ':app'
include ':custom:customView'
其他模块依赖的时候示例是
api project('custom:customview')
3.全局插件管理(新Gradle 7.0+)
pluginManagement {
// 插件仓库
repositories {
gradlePluginPortal() // gradle插件库地址
google()
mavenCentral()
}
// 插件版本,如果这里不显性配置,则默认获取最新
plugins {
id 'com.android.application' version '8.1.0' // 类似于 classpath 'com.android.tools.build:gradle:3.5.4'
id 'org.jetbrains.kotlin.jvm' version '1.9.10'
}
}
4.依赖仓库集中管理(新Gradle 7.0+)
dependencyResolutionManagement {
repositories {
google()
mavenCentral()
}
}
这个类似于之前在根目录build.gradle中配置的
allprojects {
repositories {
maven { url 'http://maven.aliyun.com/nexus/content/groups/public/' }
google()
maven { url 'https://jitpack.io' }
jcenter()
}
}
5.初始化gradle全局扩展属性ext
def deps = [:] // 定义一个map
gradle.ext.deps = deps // 通过将 deps 绑定到 gradle.ext,可以在项目中的其他地方(如子模块的 build.gradle 文件)引用这些依赖。
def baselib = [
rxjava : "io.reactivex:rxjava:1.2.3",
rxandroid : "io.reactivex:rxandroid:1.2.0",
mystique : 'com.baidu:mystique:0.1.135',
glide : 'com.baidu.mapclient.thirdpart.base:glide:3.9.1.8',
lottie : 'com.airbnb.android:lottie:3.7.1',
okhttp : "com.squareup.okhttp3:okhttp:3.11.0",
]
deps.platform = platform
这段代码通过在setting.gradle中初始化全局属性.gradle.ext,来实现集中管理和动态分配依赖,提高项目的维护性和可扩展性。将依赖存储在一个全局 Map 中,并通过 gradle.ext 暴露给整个项目,减少了重复声明依赖的工作,确保多个模块中依赖的一致性。
gradle.ext 是gradle默认作用域,你可以省略 ,可以在各个模块中如下使用
dependencies {
implementation deps.baselib.rxjava // 等同于 implementation ext.deps.baselib.rxjava
}
二、setting.gradle执行阶段和适用场景
setting.gradle是构建配置的入口文件,在gradle初始化阶段第一个被解析和执行。所以我们才把项目模块、插件管理、依赖仓库管理、全局属性、以及一些自定义的初始化逻辑、全局方法等放在setting.gradle之中。这也是之前定义在根目录build.gradle的一部分功能在gradle高版本被迁移到setting.gradle中原因。