大多数情况下我们的企业项目都会有多个模块同时参与开发,模块之间再进行关联。
例如:
- core模块包含一些通用的组件,它们能够被程序的其他模块使用。
- app模块是程序的开端,它需要core模块。
倘若Gradle项目拥有多于一个组件,我们就将其称之为多项目构建(multi-project build)
1.创建一个多项目构建
下一步,我们将创建一个多项目的Gradle构建,包括两个子项目:app 和 core。初始阶段,先要建立Gradle构建的目录结构。
建立目录结构
由于core和app模块都使用Java语言,而且它们都使用Java项目的默认项目布局,我们根据以下步骤建立正确的目录结构:
- 建立core模块的根目录(core),并建立以下子目录:src/main/java目录包含core模块的源代码。src/test/java目录包含core模块的单元测试。
- 建立app模块的根目录(app),并建立以下子目录:src/main/java目录包含app模块的源代码。src/main/resources目录包含app模块的资源文件。
现在,我们已经创建了所需的目录,下一步是配置Gradle构建,先对包含在多项目构建中的项目进行配置。
对包含在多项目构建中的项目进行配置
我们可以通过以下步骤,对包含在多项目构建中的项目进行配置:
- 在根项目的根目录下创建settings.gradle文件,一个多项目Gradle构建必须含有这个文件,因为它指明了那些包含在多项目构建中的项目。
- 确保app和core项目包含在我们的多项目构建中。
settings.gradle文件如下:
include 'app'
include 'core'
配置 core 项目
我们可以通过以下步骤对core项目进行配置:
- 1.在core项目的根目录下创建build.gradle文件。
- 2.使用Java插件创建一个Java项目。
- 3.确保core项目从Maven2中央仓库(用aliyun镜像替代)中获取依赖。
- 4.声明JUnit依赖(版本4.11),并使用testCompile配置项,该配置项表明:core项目在它的单元测试被编译前,需要JUnit库。
core项目的build.gradle文件如下:
apply plugin: "java"
repositories {
maven {
url "http://maven.aliyun.com/nexus/content/groups/public/"
}
}
dependencies {
testCompile 'junit:junit:4.11'
}
配置App项目
在配置app项目之前,我们先来快速浏览一下对一些特殊依赖的依赖管理,这些依赖都是同一个多项目构建的一部分,我们将其称之为”项目依赖“。
如果多项目构建拥有项目A和B,同时,项目B的编译需要项目A,我们可以通过在项目B的build.gradle文件中添加以下依赖声明来进行依赖配置:
dependencies {
compile project(':A')
}
现在,我们可以按照以下步骤配置app项目:
- 在app项目的根目录下创建build.gradle文件。
- 用Java插件创建一个Java项目。
- 确保app项目从Maven2中央仓库(central Maven2 repository)中获取依赖。
- 配置所需的依赖,app项目在编译时需要两个依赖:Log4j (version 1.2.17) core模块
- 创建二进制发布版本
app项目的build.gradle文件如下:
apply plugin: 'application'
apply plugin: 'java'
repositories {
maven {
url "http://maven.aliyun.com/nexus/content/groups/public/"
}
}
dependencies {
compile 'log4j:log4j:1.2.17'
compile project(':core')
}
mainClassName = 'ouxch.example.HelloWorld'
移除重复配置
当我们对多项目构建中的子项目进行配置时,我们在core和app项目的构建脚本中添加了重复的配置。
- 由于两个项目都是Java项目,因此它们都使用Java插件。
- 两个项目都使用Maven2中央仓库(aliyun镜像代替)。
换句话说,两个构建脚本都包含以下配置:
apply plugin: 'java'
repositories {
maven {
url "http://maven.aliyun.com/nexus/content/groups/public/"
}
}
让我们将这项配置转移到根项目的build.gradle文件中,在此之前,我们必须先学习一下如何在根项目的build.gradle文件中配置子项目。
如果我们想要在一个称为core的子项目中添加配置,那么就必须在根项目的build.gradle文件中添加以下片段:
project(':core') {
//Add core specific configuration here
}
换句话说,如果想要将重复的配置转移到根项目的构建脚本中,就必须将以下配置添加到build.gradle文件中:
project(':app') {
apply plugin: 'java'
repositories {
maven {
url "http://maven.aliyun.com/nexus/content/groups/public/"
}
}
}
project(':core') {
apply plugin: 'java'
repositories {
maven {
url "http://maven.aliyun.com/nexus/content/groups/public/"
}
}
}
不过这种做法在实质上并没有改变什么,在构建脚本中依然还存在重复配置,唯一的区别是重复配置现在转移到了根项目的build.gradle文件中。让我们来消灭这些重复配置。
如果我们想要在根项目的子项目中添加通用的配置,需要将以下片段添加到根项目的build.gradle文件中:
subprojects {
//Add common configuration here
}
在根项目的build.gradle文件中移除了重复配置后,代码如下:
subprojects {
apply plugin: 'java'
repositories {
maven {
url "http://maven.aliyun.com/nexus/content/groups/public/"
}
}
}
如果我们的配置项是被多项目构建中的 所有项目 所共享的,那么需要在根项目的build.gradle文件中添加以下片段:
allprojects {
//Add configuration here
}
现在,我们可以从子项目的构建脚本中移除重复配置,子项目新的构建脚本如下:
core/build.gradle文件如下:
dependencies {
testCompile 'junit:junit:4.11'
}
app/build.gradle文件如下:
apply plugin: 'application'
dependencies {
compile 'log4j:log4j:1.2.17'
compile project(':core')
}
mainClassName = 'ouxch.example.HelloWorld'
现在,我们已经创建了一个多项目Gradle构建,下面让我们来直观的感受一下我们做了些什么。
我们刚刚做了什么?
在我们的多项目构建的根目录下执行命令gradle projects,可以看到如下输出:
$ gradle projects
:projects
------------------------------------------------------------
Root project
------------------------------------------------------------
Root project 'multi-project-build'
+--- Project ':app'
--- Project ':core'
To see a list of the tasks of a project, run gradle <project-path>:tasks
For example, try running gradle :app:tasks
BUILD SUCCESSFUL
正如我们所看到的,这条命令列出了根项目的子项目(app和core),这意味着我们刚才已经创建了一个多项目Gradle构建,它拥有两个子项目。
在我们的多项目构建的根目录下执行命令gradle tasks,可以看到如下输出(仅列出相关部分):
$ gradle tasks
:tasks
------------------------------------------------------------
All tasks runnable from root project
------------------------------------------------------------
Application tasks
-----------------
distTar - Bundles the project as a JVM application with libs and OS specific scripts.
distZip - Bundles the project as a JVM application with libs and OS specific scripts.
installApp -Installs the project as a JVM application along with libs and OS specific scripts
run - Runs this project as a JVM application
正如我们所看到的,我们可以使用Gradle运行程序,并创建一个可运行的二进制发布,它没有使用所谓的“fat jar”方式。
总结
- 一个多项目构建必须在根项目的根目录下包含settings.gradle文件,因为它指明了那些包含在多项目构建中的项目。
- 如果需要在多项目构建的所有项目中加入公用的配置或行为,我们可以将这项配置加入到根项目的build.gradle文件中(使用allprojects)。
- 如果需要在根项目的子项目中加入公用的配置或行为,我们可以将这项配置加入到根项目的build.gradle文件中(使用subprojects)。
网友评论