Gradle学习9——多项目构建

2024年1月30日 266次阅读 来源: sososeen09

学习本系列前可以下载相关的github项目gradleLearnDemo。
地址：https://github.com/sososeen09/gradleLearnDemo

为了提高可维护性和防止紧密耦合，可以基于特定的功能和逻辑将代码写在不同的模块中。模块通常具有层次结构而且可以定义为相互依赖。Gradle对构建多模块项目提供了强大的支持，Gradle中的每一模块都是一个项目，我们称之为多项目构建。

注意：在Android Studio中，一个模块和一个项目是有区别的。一个项目包含多个模块module。而Android Studio中的每一个module对应的是Gradle多项目构建中的一个项目

在多项目构建中，settings文件声明了所需的配置来实例化项目的层次结构。在默认情况下，这个文件被命名为settings.gradle，并且和根项目的build.gradle 文件放在一起。settings.gradle脚本的执行是在构建生命周期的初始化阶段。Gradle组装构建之前会创建一个Settings类型的实例。Settings接口是settings文件的直接表示。若想使每个子项目都称为构建的一部分，则可以调用Settings接口中带有项目路径参数的include方法。

rootProject
      |———— settings.gradle
      |———— build.gradle
      |———— sub_project1
      |            |———— build.gradle
      |———— sub_project2
      |            |———— build.gradle

在settings.gradle中要声明当前项目包含的子项目：

include ':sub_project1', 'sub_project2'

注意：传给include方法的参数是项目路径，不是文件路径。该项目路径是相对于根目录的项目目录。也可以构建更深层次的项目结构。使用冒号(:)字符来分隔每一个子项目的层次结构。例如：

include ':subs:sub_project1'

有时候，想要为所有的项目或只有子项目定义一些公共的行为。为实现这些用力，Project API提供了两个专门的方法：allprojects和subprojects。
在根目录中的build.gradle中添加如下配置：

allprojects{
    task allTaskHello <<{
        println "hello from ${project.name}"
    }
}

配置在allprojects 这个闭包下的所有内容对根项目和子项目都有效。
在根目录下执行gradle allTaskHello 命令，可以看到结果：

:allTaskHello
hello from rootProject

:sub_project1:allTaskHello
hello from sub_project1

:sub_project2:allTaskHello
hello from sub_project2

在根目录中的build.gradle中添加如下配置：

subprojects{
    task subTaskHello <<{
        println "hello from sub project ${project.name}"
    }
}

配置在subprojects 这个闭包下的所有内容只对子项目都有效，对根项目无效。
在根目录下执行gradle subTaskHello 命令，可以看到结果：

:sub_project1:subTaskHello
hello from sub project sub_project1

:sub_project2:subTaskHello
hello from sub project sub_project2

如果进入到子项目目录下执行gradle命令，只会对当前的这个子项目有效。比如进入sub_project1这个子项目中，执行gradle subTaskHello命令，结果是：

:sub_project1:subTaskHello
hello from sub project sub_project1

默认的task执行顺序
如果task没有声明依赖另一个task，在多项目构建中位于根目录的task总是先执行。对于子项目来说，执行顺序完全取决于项目名称的字母顺序。例如，sub_project1在sub_project2之前。记住，在settings文件中子项目的声明顺序完全不影响其执行顺序。

单独定义特定的行为
前面我们讲的，都是在allprojects和subprojects中进行的定义，实际上我们在根目录下的build.gradle中也可以对每一个项目进行单独的定义。例如：

project(':sub_project1'){
    task forSub1 <<{
        println 'this is only for sub_project1 task'
    }
}

执行gradle forSub1命令，可以看到结果：

:sub_project1:forSub1
this is only for sub_project1 task

记住：在根目录下的build.gradle中执行task，Gradle会在所有拥有该task的project上执行该task。

属性继承
属性继承，在一个根项目中定义的属性会自动的被其子项目继承，也就是说子项目中也可以用到这些属性，例如我们在根项目中声明一个扩展属性projectInfo，对于根项目和子项目都是可用的：


ext.projectInfo=['group':'com.sososeen09','version':'0.1']

group = projectInfo.group
version = projectInfo.version
project(':sub_project1'){
    group = projectInfo.group
    version = projectInfo.version
    ...
}

project(':sub_project2'){
    group = projectInfo.group
    version = projectInfo.version
    ...
}

项目之间的依赖
多项目之间一般不会是毫无关联的，可能会存在依赖关系。比如sub-project1中有taskA和taskB，taskA依赖于taskB，而taskB依赖于sub_project2中的taskC。到目前为止，我们把子项目中的属性和任务都放在根目录下的build.gradle中声明，现在是时候在它们各自的build.gradle中是声明自己的任务了。

//sub_project1 中
task taskA << {
    println "this is ${name} from ${project.name}"
}

task taskB << {
    println "this is ${name} from ${project.name}"
}

taskA.dependsOn taskB
taskB.dependsOn ':sub_project2:taskC'

//sub_project2 中
task taskC << {
    println "this is ${name} from ${project.name}"
}

我们分析一下，taskA 依赖taskB ，所以taskA执行之前，taskB必须先执行；而taskB又依赖于sub_project2中的taskC，所以taskB执行前，taskC必须先执行。
现在执行 gradle taskA命令，可以看到结果跟我们的分析一致：

:sub_project2:taskC
this is taskC from sub_project2

:sub_project1:taskB
this is taskB from sub_project1

:sub_project1:taskA
this is taskA from sub_project1

下一篇，我们开始学习自定义Gradle插件，这是本系列的最后一篇，也是一个非常重要的部分。

    原文作者：sososeen09
    原文地址: https://www.jianshu.com/p/62c1f3ca380c
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞