欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

详解IDEA下Gradle多模块(项目)的构建

程序员文章站 2024-03-01 10:02:52
我们在新起一个项目的时候,一般都会建多个子项目(idea里面称之为module模块)。通过gradle构建,多个module之间需要将公用的配置抽取到全局,子项目中只写差异...

我们在新起一个项目的时候,一般都会建多个子项目(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项目:

1、file -> new -> project: 选择gradle->java

详解IDEA下Gradle多模块(项目)的构建

2、next, 填写groupid和artifactid:

groupid: 如com.diboot
artifactid:如demo

3、next, 指定gradle home和jvm等

4、next, 选择项目存放路径。完成之后idea会创建相关文件

接下来如果你需要将本地新项目代码上传到代码仓库,可以通过vcs菜单导入:

详解IDEA下Gradle多模块(项目)的构建

b. 基于代码仓库指定的项目名创建root项目

而如果项目名已经在仓库中定义,你需要基于仓库名初始项目的gradle配置,则项目的初始创建是通过vcs导入,然后用命令行初始化gradle:

  1. file -> new -> project from version control -> ...
  2. 切换到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多项目构建

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。

上一篇: spring快速入门实例教程

下一篇: