共计 2741 个字符，预计需要花费 7 分钟才能阅读完成。
IDEA 下 Gradle 多模块项目的构建
我们在新起一个项目的时候，一般都会建多个子项目 (IDEA 里面称之为 Module 模块)。通过 Gradle 构建，多个 Module 之间需要将公用的配置抽取到全局，子项目中只写差异化的配置，以便于维护。
多模块项目的 Gradle 目录结构
示例：我的示例项目 demo，我需要有一个 common 模块用于公用代码，一个 rest 模块用于提供 rest 接口，rest 依赖 common，如果用 gradle 构建，目录树会是这样:
demo
├── build.gradle — 全局配置
├── settings.gradle — 全局配置
├── common — 子模块 1 目录
│ └── build.gradle — 子模块 1 配置
├── rest — 子模块 2 配置
│ └── build.gradle — 子模块 2 配置
…
IDEA 下初始创建 root 目录结构
A. IDEA 本地创建项目并定义项目名
如果是通过 IDEA 新建一个本地项目，可按照如下步骤先创建 root 项目:
File -> New -> Project: 选择 Gradle->Java
Next, 填写 GroupId 和 ArtifactId:
GroupId: 如 com.dibootArtifactId: 如 demo
Next, 指定 Gradle home 和 JVM 等
Next, 选择项目存放路径。完成之后 IDEA 会创建相关文件
接下来如果你需要将本地新项目代码上传到代码仓库，可以通过 VCS 菜单导入：
B. 基于代码仓库指定的项目名创建 root 项目
而如果项目名已经在仓库中定义，你需要基于仓库名初始项目的 gradle 配置，则项目的初始创建是通过 VCS 导入，然后用命令行初始化 gradle：
File -> New -> Project from Version Control -> …
切换到 Terminal 命令行，输入 gradle init，按照操作提示进行 root 项目的初始化。
创建子模块 / 项目
在根目录 demo 文件夹右键选择 New -> Module -> Gradle -> Java, 指定子模块 ArtifactId 名称，依次添加 common 模块和 rest 模块后，gradle 相关的目录结构就跟我们期望的一致了。
全局 gradle 配置
在 demo 根目录下: settings.gradle 中的结构定义如下
rootProject.name = ‘demo’
include ‘common’
include ‘rest’
build.gradle 中可以定义全局公用的构建配置，以 Spring Boot 项目配置示例:
buildscript {
ext {
springBootVersion = ‘2.1.2.RELEASE’
}
repositories {
maven{url ‘http://maven.aliyun.com/nexus/content/groups/public/’}
}
dependencies {
classpath(“org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}”)
}
}
// 所有模块 / 项目的通用配置
allprojects {
group ‘com.diboot’
version ‘1.0-SNAPSHOT’
apply plugin: ‘idea’
}
// 子模块 / 项目的统一配置
subprojects {
apply plugin: ‘java’
// 指定 JDK 版本
sourceCompatibility = 1.8
targetCompatibility = 1.8
// 指定编码格式
[compileJava,compileTestJava,javadoc]*.options*.encoding = ‘UTF-8’
repositories {
maven{url ‘http://maven.aliyun.com/nexus/content/groups/public/’}
}
ext {// 依赖版本
springBootVersion = “2.1.2.RELEASE”
mysqlConnectorVersion = “8.0.13”
mybatisStarterVersion = “1.3.2”
fastjsonVersion = “1.2.54”
}
dependencies {
compile(“javax.servlet:javax.servlet-api:4.0.1”)
compile(“org.springframework.boot:spring-boot-starter-web:$springBootVersion”)
// Mybatis
compile(“org.mybatis.spring.boot:mybatis-spring-boot-starter:$mybatisStarterVersion”)
// Log4j2
compile(“org.springframework.boot:spring-boot-starter-log4j2:$springBootVersion”)
// JDBC Driver
compile(“mysql:mysql-connector-java:$mysqlConnectorVersion”)
// JSON
compile(“com.alibaba:fastjson:$fastjsonVersion”)
// Apache Commons
compile(“org.apache.commons:commons-lang3:3.8.1”)
// 单元测试
testCompile(“org.springframework.boot:spring-boot-starter-test:$springBootVersion”)
testCompile(“junit:junit:4.12”)
}
configurations {
// 移除 spring boot 默认 logger 依赖
all*.exclude module: ‘spring-boot-starter-logging’
}
}
子模块 / 项目 gradle 配置
通用的依赖配置可以在根目录下的 build.gradle 中，子模块 / 项目仅配置差异化的部分即可，如子项目特定的依赖。common 下的 build.gradle 示例:
dependencies {
// 配置该项目特有的依赖
}
rest 下的 build.gradle 示例（rest 项目依赖 common 项目）：
dependencies {
// 依赖 common 项目
compile project(“:common”)
// 配置该项目特有的依赖
}
代码参考:Diboot-v2 初始项目
Gradle 官方相关文章:Gradle 多项目构建介绍 Gradle 多项目构建
Diboot 轻代码开发平台, Diboot 开发助理