深入解析Gradle中的Project核心组件

前言

project在gradle里起到里重要的作用&＃xff0c;上节我们也说过可以通过./gradlew projects打印当前项目下所有的project&＃xff0c;准确的说是有build.gradle的文件既是一个project。而有多少project取决于在setting.gradle文件中设置了多少个。一个project对应一个输出&＃xff0c;而具体输出什么取决于build.gradle里面的内容。

Project核心API

每个工程下都有一个build.gradle文件。根目录的build.gradle可以管理子工程下面的build.gradle。下面具体看下project相关api。

getAllProjects()

我们可以通过getAllprojects打印出所有的project&＃xff0c;可以理解成和./gradlew projects命令一样。示例带入如下&＃xff1a;

getAllprojects().eachWithIndex { Project entry, int i ->if (i &＃61;&＃61; 0) {println("RootProject-------${entry.name}")} else {println("SubProject-------${entry.name}")}
}


输出结果如下&＃xff1a;

RootProject-------APMProjetct
SubProject-------apm
SubProject-------app
SubProject-------aspectj


getSubprojects()

此方法是获取所有子工程的实例&＃xff0c;示例代码如下&＃xff1a;

getSubprojects().eachWithIndex { Project entry, int i ->println("SubProject-------${entry.name}")
}


输出结果如下&＃xff1a;

> Configure project :
SubProject-------apm
SubProject-------app
SubProject-------aspectj


getRootProject()

既然我们可以拿到所有的子节点&＃xff0c;那我们依然可以单独获取到根节点&＃xff0c;示例代码如下&＃xff1a;

println("the root project name is ${getRootProject().name}")


输出结果如下&＃xff1a;

> Configure project :
the root project name is APMProjetct


getParent()

此方法是用于在子工程获取父工程的实例&＃xff0c;示例代码如下&＃xff1a;

println("the parent project name is ${getParent().name}")


输出结果可想而知&＃xff1a;

> Configure project :aspectj
the parent project name is APMProjetct


projects()

project是为了让我们在父工程的build.gradle文件&＃xff0c;针对子project做一些单独的处理&＃xff0c;比如这样&＃xff1a;

project("app") {apply plugin: &＃39;com.android.application&＃39;
}


allprojects()

allprojects 表示用于配置当前 project 及其每一个子 project&＃xff0c;在 allprojects 中我们一般用来配置一些通用的配置&＃xff0c;比如最常见的全局仓库配置。

allprojects {repositories {google()jcenter()}
}


subprojects()

此方法是为了让我们对所有的子project做一些配置&＃xff0c;比如这样&＃xff1a;

subprojects {if(project.plugins.hasPlugin("com.android.library")){apply from "../uploadMaven.gradle"}
}


ext扩展属性

我们可以通过ext扩展属性默认修改其他工程build.gradle的文件配置。比如我在root project中新增了如下属性&＃xff1a;

ext {minSdkVersion &＃61; 21targetSdkVersion &＃61; 30
}


那么我们可以在子工程的build.gralde文件修改文件如下&＃xff1a;

android {compileSdkVersion 30buildToolsVersion "30.0.1"defaultConfig {applicationId "com.xxxxx.apmprojetct"minSdkVersion rootProject.ext.minSdkVersiontargetSdkVersion rootProject.ext.targetSdkVersionversionCode 1versionName "1.0"testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"}
}


另外我们还可以通过apply的形式依赖自己新增的gradle文件&＃xff0c;比如我们可以新增一个config.gradle文件&＃xff0c;具体内容如下:

android {signingConfigs {debug {storeFile file(&＃39;xxx.jks&＃39;)storePassword &＃39;xxx&＃39;keyAlias &＃39;xxxx&＃39;keyPassword &＃39;xxxx&＃39;v1SigningEnabled truev2SigningEnabled true}release {storeFile file(&＃39;xxx.jks&＃39;)storePassword &＃39;xxx&＃39;keyAlias &＃39;xxxx&＃39;keyPassword &＃39;xxx&＃39;v1SigningEnabled truev2SigningEnabled true}}
}


那么我们可以在工程中这样使用&＃xff1a;

apply from: &＃39;config.gradle&＃39;
android {buildTypes {debug {signingConfig signingConfigs.debugminifyEnabled falseshrinkResources falseproguardFiles getDefaultProguardFile(&＃39;proguard-android.txt&＃39;), &＃39;proguard-rules.pro&＃39;versionNameSuffix "_dev"}release {signingConfig signingConfigs.releaseminifyEnabled trueshrinkResources trueproguardFiles getDefaultProguardFile(&＃39;proguard-android.txt&＃39;), &＃39;proguard-rules.pro&＃39;}}
}


gradle文件操作

gradle中操作本地文件可以使用的是Project.file()方法&＃xff0c;通过指定文件的相对路径或者绝对路径来进行操作。比如我们可以新建一个文件&＃xff0c;可以查看一个文件的绝对路径&＃xff0c;也可以判断一个文件是否存在&＃xff0c;示例代码如下&＃xff1a;

// 使用相对路径
File configFile &＃61; file(&＃39;src/main/java/test.java&＃39;)
configFile.createNewFile();// 使用绝对路径
configFile &＃61; file(‘/Users/xxx/xxx/src/main/java/test.java’)
println(configFile.absolutePath)// 使用一个文件对象
configFile &＃61; file(new File(&＃39;src/main/java/test.java&＃39;))
// 打印文件是否存在
println(configFile.exists())


同步一下&＃xff0c;输出结果如下&＃xff1a;

/Users/xxx/xxx/src/main/java/test.java
true


文件集合

Gradle中文件集合就是类似于java中的数组&＃xff0c;Gradle中使用FileCollection接口表示&＃xff0c;我们可以使用Project.files()方法来获得一个文件集合对象,所有文件集合都是用到的时候才会创建。示例代码如下&＃xff1a;

FileCollection collection &＃61; files(&＃39;src/test1.txt&＃39;,new File(&＃39;src/test2.txt&＃39;),[&＃39;src/test3.txt&＃39;, &＃39;src/test4.txt&＃39;])


我们可以这样遍历文件&＃xff1a;

// 遍历所有集合
collection.each { File file ->println file.name
}


我们还可以这样转换文件&＃xff1a;

// 把文件集合转换为Set类型
Set set1 &＃61; collection.files
Set set2 &＃61; collection as Set
// 把文件集合转换为List类型
List list &＃61; collection as List
// 把文件集合转换为String类型
String path &＃61; collection.asPath
// 把文件集合转换为File类型
File file1 &＃61; collection.singleFile
File file2 &＃61; collection as File


除此之外&＃xff0c;我们还可以新增或者删除一个文件&＃xff0c;比如这样&＃xff1a;

// 添加或者删除一个集合
def union &＃61; collection &＃43; files(&＃39;src/test5.txt&＃39;)
def different &＃61; collection - files(&＃39;src/test3.txt&＃39;)


文件树

文件树你可以理解成是一个有层级结构的文件集合&＃xff0c;所以文件树中包含了所有文件集合的操作。我们可以使用Project.fileTree()方法来创建文件树对象&＃xff0c;还可以使用过虑条件来包含或排除相关文件。示例代码如下&＃xff1a;

// 指定目录创建文件树对象
FileTree tree &＃61; fileTree(dir: &＃39;src/main&＃39;)// 给文件树对象添加包含指定文件
tree.include &＃39;**/*.java&＃39;
// 给文件树对象添加排除指定文件
tree.exclude &＃39;**/Abstract*&＃39;// 使用路径创建文件树对象&＃xff0c;同时指定包含的文件
tree &＃61; fileTree(&＃39;src&＃39;).include(&＃39;**/*.java&＃39;)// 通过闭包创建文件树
tree &＃61; fileTree(&＃39;src&＃39;) {include &＃39;**/*.java&＃39;
}// 通过map创建文件树
tree &＃61; fileTree(dir: &＃39;src&＃39;, include: &＃39;**/*.java&＃39;)
tree &＃61; fileTree(dir: &＃39;src&＃39;, includes: [&＃39;**/*.java&＃39;, &＃39;**/*.xml&＃39;])
tree &＃61; fileTree(dir: &＃39;src&＃39;, include: &＃39;**/*.java&＃39;, exclude: &＃39;**/*test*/**&＃39;)


既然说到了文件树的创建&＃xff0c;当然&＃xff0c;我们也可以对文件树进行一些业务操作&＃xff0c;比如&＃xff1a;

// 遍历文件树的所有文件
tree.each {File file ->println file
}// 过虑生成新的文件树对象
FileTree filtered &＃61; tree.matching {include &＃39;org/gradle/api/**&＃39;
}// 使用“&＃43;”号合并两个文件树&＃xff0c;同文件集合的“&＃43;”操作一样
FileTree sum &＃61; tree &＃43; fileTree(dir: &＃39;src/test&＃39;)// 访问文件树中各项内容
tree.visit {element ->println "$element.relativePath &＃61;> $element.file"
}


文件拷贝

我们可以通过copy的task对文件进行copy动作&＃xff0c;并且可以指定copy内容和过滤copy内容&＃xff0c;还可以在copy的过程中对文件进行重命名操作&＃xff0c;先来个简单的&＃xff0c;比如我需要从A目录copy到B目录&＃xff0c;那我们可以这样做&＃xff1a;

task copyTask(type: Copy) {from &＃39;src/main/java/fileA&＃39;into &＃39;src/main/kotlin/fileB&＃39;
}


当然&＃xff0c;我们也是支持批量copy的&＃xff0c;比如这样&＃xff1a;

task copyTask(type: Copy) {// 拷贝src/main/webapp目录下所有的文件from &＃39;src/main/java&＃39;// 拷贝单独的一个文件from &＃39;src/main/res/index.html&＃39;// 从Zip压缩文件中拷贝内容from zipTree(&＃39;src/main/assets.zip&＃39;)// 拷贝到的目标目录into &＃39;src/main/mouble&＃39;
}


前面我们也说了&＃xff0c;我们可以在copy的时候进行重命名&＃xff0c;最常见的场景&＃xff0c;就是项目拆解模块的时候&＃xff0c;我们需要重新命名&＃xff0c;那我们可以这样操作&＃xff1a;

task rename(type: Copy) {from &＃39;moudleA/src/main/res/&＃39;into &＃39;moudleB/src/main/res/&＃39;// 使用一个闭包方式重命名文件rename { String fileName ->fileName.replace(&＃39;moudleA&＃39;, &＃39;moudleB&＃39;)}
}


大量的节约了手动重命名的成本。
同样我们也可以新增过滤条件&＃xff1a;

task copyTaskWithPatterns(type: Copy) {from &＃39;src/main/drawable&＃39;into &＃39;src/main/drawable-xxhdpi&＃39;include &＃39;*.jpg&＃39;exclude { details -> details.file.name.endsWith(&＃39;.png&＃39;) &&details.file.text.contains(&＃39;.webp&＃39;) }
}


当然我们还可以拷贝的同时&＃xff0c;并删除对应目录文件&＃xff0c;我们可以这么操作&＃xff1a;

task libs(type: Sync) {from configurations.runtime// 拷贝之前会把$buildDir/libs目录下所有的清除into "$buildDir/libs"
}


总结

本文我们简单的介绍了projects的相关操作以及在gradle中我们如何去操作文件&＃xff0c;当然&＃xff0c;gradle中除了projects&＃xff0c;还有一个核心的task&＃xff0c;这个我们放在下一节进行介绍。

参考

暴力突破 Gradle 自动化项目构建&＃xff08;五&＃xff09;- Gradle 核心之 Project
gradle操作文件详解

本文首发于我的个人博客&＃xff1a;Gradle核心之Project

更多文章请关注我的公众号&＃xff1a;码农职场