10 Gradle 实现多项目构建

之前我们已经学习了Gradle 的基本原理知识点,已经了解了 Gradle 构建配置的组成部分以及构建的生命周期,如何进行依赖管理以及如何解决传递性依赖冲突。那这一篇我们来做个实践,来看下我们在企业中经常使用到的操作,就是如何在项目中来使用 Gradle 构建工具。我们先来看下多项目的构建。

多项目构建

在企业中,一个比较复杂的项目往往是分成几个小项目来协同完成,这就涉及到多项目的构建,而多项目构建咱们需要先来学习一个概念叫“项目模块化”。

项目模块化

模块化是指将一个大程序按照功能划分为若干小程序模块,每个小程序模块完成一个确定的功能,并在这些模块之间建立必要的联系,通过模块的互相协作完成整个功能。

在企业项目中,包和类比较多,关系也比较复杂,为了能够很好的管理和区分这些包和类,我们会把代码拆分成模块,按某些功能点清晰的划分边界。比如把业务逻辑和数据持久拆分,比如把所有的 domain 拆分成一个模块,或者大的划分,把前后台代码拆分成两个独立的模块。项目中的模块要符合高内聚低耦合思想。接下咱们来看下如何做多项目构建。

多项目构建模块划分和依赖关系

以下咱们以一个点评网站(comment)的搭建来做模块的划分和关系的搭建,模块划分和模块关系如下图:

模块划分

我们把点评网项目划分为4个模块,架构如图所示,web 和 admin 需要依赖 core 和 model,core 需要依赖 model,由于传递性依赖的特点,我们待会在配置依赖时可以只配置 core 依赖 model,web 和 admin 依赖 core 即可。

有用过 Maven 或者其他构建工具的小伙伴都知道,不管一个项目分为几个模块,最终都需要有一个 root 项目来统一的管理所有的模块。对 Gradle 来说同样也不例外,以下我们先来看下模块之间的关系以及 Gradle 构建脚本中的配置范围。

模块关系和构建脚本配置范围

脚本配置范围和项目关系

所有划分出来的模块都是属于 root 项目的子模块,所有项目(包括 root 项目)的公用配置在 allprojects 中配置,所有子模块的公用配置可以在 subprojects 中来配置,build.gradle 针对项目的配置项都可以配置在 allprojects/subprojects 中。

多项目的构建其实不仅仅是配置模块和模块之间的依赖关系就 ok 的,其实还涉及到通用配置的管理等,那我们此次的多项目构建需要达到哪些目标或者说需要完成哪些需求呢?

多项目配置要求

    1. 所有的项目都需要使用 Java 插件,web 项目也需要依赖 Java 环境;
    1. web 子项目需打为 war 包;
    1. 统一配置公共属性,例如:group,version;
    1. 统一管理资源库;
    1. 通用依赖配置,例如 logback 日志功能的引入。

以上就是我们本次多项目构建需要完成的需求,接下来我们就开始来完成这些需求。

多项目构建

1. 创建 root 项目和所有的子模块项目

    1. 创建 Gradle 的 Java 项目,ArtifactId:comment
    1. 在 comment 下创建 Java 模块,ArtifactId:core
      右键->new->Module->Gradle,Java
    1. 在 comment 下创建 Java 模块,ArtifactId:model
    1. 在comment 下创建 web 模块,ArtifactId:admin
    1. 在comment 下创建 web 模块,ArtifactId:web
    1. 删除 comment 下的 src,只做模块管理项目,不写业务。

以上操作之后就得到以下项目结构:

项目结构

每个模块都有自己的 build.gradle。

子模块
settings.gradle

settings.gradle 主要做模块管理。

2. 配置项目依赖

    1. model 删除 junit 依赖
      model 无需测试
dependencies {
  // 空白配置,特殊需求依赖配置,如 lombok 引入
}
    1. core 依赖 model
      在 core 的 build.gradle 中配置模块依赖
dependencies {
    // core 依赖 model 子模块
    // 模块的依赖使用 project(":模块名") 方式.
    compile project(":model")
    testCompile group: 'junit', name: 'junit', version: '4.11'
}
    1. admin 和 web 模块依赖 core 模块
      在 admin 和 web 模块的 build.gradle 中配置如下
dependencies {
    // 依赖 core 模块
    compile project(":core")
}

至此,项目之间的关系就已经拉好了,先检查下是否配置成功,再来看下其他的配置。

依赖关系

通过 Gradle 管理工具栏可看出依赖已经配置成功,接下来处理一些其他的配置。

3. 所有项目使用 Java 插件,web项目使用 war

    1. 配置公用 java 插件引入
      在 comment 项目下的 build.gradle 中将 java 插件和版本引入的配置转到 allprojects 中,因为 root 项目作为管理项目也需要加入 java 插件,所以此处不能使用 subprojects。
allprojects {
    // 统一引入 java 插件和版本指定
    apply plugin: "java"
    sourceCompatibility = 1.8
}
    1. 删除所有子模块项目中的 java 插件引入和版本指定
    1. 检查是否配置成功
      执行 core/model->Tasks->build->jar,能导出 jar 即 OK。
      执行 admin/web->Tasks->build->war,能导出 war 即 OK。

4. 统一公共属性配置和资源库

    1. 统一资源库配置
      1.1 comment 的build.gradle 中将 repositories 移动到 allprojects/subprojects 中
      1.2 删除所有子模块中的资源库配置项
allprojects {
    // 统一引入 java 插件和版本指定
    apply plugin: "java"
    sourceCompatibility = 1.8
    // 统一指定所有项目的资源库
    repositories {
        mavenCentral()
    }
}
    1. 统一属性配置
      将所有模块中的 group 和 version 统一配置在 comment 的 build.gradle 的 allprojects/subprojects中,子模块删除。
subprojects {
    // 统一 group 和 version
    group 'cn.wolfcode.comment'
    version '1.0.0'
}

以上是一种配置,我们也可以给 project 配置属性,可用 ext 来做拓展,也可用 gradle.properties 来配置。

在 comment 下创建 gradle.properties

// gradle.properties
group=cn.wolfcode.comment
version=1.0.0

5. 所有项目引入 logback 日志

在 comment 下 build.gradle 中的allprojects/subprojects 中配置dependencies

allprojects {
    //...
    // 共用依赖配置
    dependencies {
        compile 'ch.qos.logback:logback-classic:1.2.2'
    }
}
共用依赖配置

以上多项目构建就完成了,接下咱们来回顾下,看下各个模块目前的配置和关系。

6. 模块配置文件以及关系

模块配置文件以及关系

以上则为本次多项目构建的全部配置以及关系的罗列,至此我们就可以开始快乐的使用 Gradle 来完成多项目的构建了。

7. 核心点

    1. 在 root 项目的build.gradle 使用allprojects/subprojects 来做公共的配置
    1. 所有项目使用java,web 项目使用war
    1. 属性配置文件的抽取

以上我们使用 Gradle 实现多项目的构建就完美结束了,剩下的就是写代码和测试了。接下来就期待Gradle 的自动化测试介绍吧。

转载链接:https://www.jianshu.com/p/a0beddfbc91e

推荐阅读更多精彩内容