51Testing软件测试论坛

标题: get到Gradle及多模块定制化统一配置实现将会无法离开你知道吗？ [打印本页]
作者: 海上孤帆    时间: 2022-8-9 14:47
标题: get到Gradle及多模块定制化统一配置实现将会无法离开你知道吗？
【学习背景】
相信做过实际项目或者学过项目的小伙伴，都听说过依赖构建工具，目前项目中用得最多的两种构建依赖构建方式分别是Maven和Gradle，至于哪种日出冲天，哪种日薄西山，这个说不准，我觉得现在实际上两种都使用得挺多的，只不过Maven出道得早一些，而Gradle是后起之秀，今天就来介绍一下这个后起之秀Gralde的使用，主要基于Spring Boot官方提供的gradle demo进行说明，将教你如何快速上手一个Gradle工程，并根据实际需要进行单模块的配置以及多模块的配置，甚至是定制化多模块的配置方案，希望对你有所帮助。
[attach]140844[/attach]

学习目录一、单模块
1.1 生成demo
1.2 gradle配置说明
1.3 构建demo
二、传统多模块（多配置）
2.1 添加子模块
2.2 构建单模块
2.3 构建多模块
三、定制多模块（单配置）
3.1 定制化说明
3.2 定制化配置
3.3 构建多模块（定制化）



一、单模块1.1 生成demo

直接通过SpringBoot官方快速创建一个demo工程 https://start.spring.io/

[attach]140847[/attach]

将demo工程导入IDEA或Eclipse等集成开发工具，得到的结构大致如下

  1. demo
  2. ├─src
  3. ├─build.gradle
  4. ├─settings.gradle
复制代码

[attach]140848[/attach]

1.2 gradle配置说明

关于Gradle依赖构建，我们主要关注build.gradle、settings.gradle这两个配置，配置说明如下：
settings.gradle

  1. //Gradle工程名
  2. rootProject.name = 'demo'
复制代码

build.gradle配置内容及说明：

  1. //依赖的插件
  2. plugins {
  3.         id 'org.springframework.boot' version '2.5.4'
  4.         id 'io.spring.dependency-management' version '1.0.11.RELEASE'
  5.         id 'java'
  6. }
  7. //组名（前缀包名）
  8. group = 'com.example'
  9. //工程版本号（这里去掉-SNAPSHOT）
  10. version = '0.0.1'
  11. //JDK版本
  12. sourceCompatibility = '1.8'

  14. //全局仓库
  15. repositories {
  16.         //maven仓库中心
  17.         mavenCentral()
  18. }

  20. dependencies {
  21.         //依赖正式架包
  22.         implementation 'org.springframework.boot:spring-boot-starter'
  23.         //依赖测试架包（正式构建时不会加入到依赖中）
  24.         testImplementation 'org.springframework.boot:spring-boot-starter-test'
  25. }

  27. test {
  28.         //Junit测试，Gradle 4.6及以上版本，加入该配置即自动支持
  29.         useJUnitPlatform()
  30. }
复制代码

1.3 构建demo

完成Gradle的build.gradle、settings.gradle两个配置之后，接下来开始进行构建生成架包


如果没配置Gradle配置的，可以先安装Gradle（下载地址https://gradle.org/releases/）并配置一下，配置为 File -> Settings -> Build, Execution, Deployment -> Build Tools - Gradle

[attach]140850[/attach]


展开右侧Gradle视图栏，进行构建得到demo-0.0.1-plain.jar架包

[attach]140853[/attach]

二、传统多模块（多配置）
  1. 现在实际的很多工程，一般不只是单个工程单模块，很多都是需要配置多模块的，比较传统的方式是直接添加各个子模块，每一个子模块对应一个build.gradle配置，比较简单，但是配置可能会比较冗余，网上很少有说明怎么整合多模块的配置到一个build.gradle里面的教程，下一章会进行介绍并给出定制化的方案
复制代码
2.1 添加子模块

直接基于上面Springboot生成的demo主工程，添加三个子模块
结构预览

  1. demo
  2.   ├─app_common
  3.   │  └─build.gradle
  4.   ├─app_one
  5.   │  └─build.gradle
  6.   ├─app_two
  7.   │  └─build.gradle
  8. ├─build.gradle
  9. ├─settings.gradle
复制代码

这种多模块创建方式比较简单，直接选中根目录demo，右键选择 New -> Module…

[attach]140855[/attach]

选中Gradle -> Java -> Next

[attach]140856[/attach]

命名要添加的子模块名称、填写GroupId/ArtifactId/Version三要素 -> Finish：

[attach]140858[/attach]

同理，将app_one、app_two另外两个子模块也创建出来即可

最终得到的工程结构如下图所示：

[attach]140859[/attach]

每一个子模块下的build.gradle跟主模块的结构是一样的
例如app_common/build.gradle配置如下：

  1. plugins {
  2.     id 'java'
  3. }

  5. group 'com.example'
  6. version '0.0.1'

  8. repositories {
  9.     mavenCentral()
  10. }

  12. dependencies {
  13.     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0'
  14.     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
  15. }

  17. test {
  18.     useJUnitPlatform()
  19. }
复制代码

主模块下的settings.gradle主要负载依赖其他子模块：

  1. rootProject.name = 'demo'
  2. include 'app_common'
  3. include 'app_one'
  4. include 'app_two'
复制代码
2.2 构建单模块

同样的，完成多个子模块的创建后，测试一下Gradle构建单个模块是否正常
展开右边的Gradle -> app_common -> Tasks -> build -> jar，双击执行即可完成单模块的构建

[attach]140860[/attach]

最终得到app_common-0.0.1.jar单个构建包，一般生成在build的相关目录下：

[attach]140861[/attach]

2.3 构建多模块

也可以Gradle同时构建多个模块
展开右边的Gradle -> build -> jar，双击执行即可完成多模块的同时构建

[attach]140862[/attach]

三、定制多模块（单配置）
3.1 定制化说明
  1. 可以看到前面传统的多模块虽然创建简单，不过每一个子模块都需要维护一个build.gradle配置，对于实际应用来说，可能会比较繁琐了，因此可以考虑将多个子模块的配置整合到一个配置里面，这里本文做了一个定制化的配置，除了原有的build.gradle、settings.gradle两个配置文件之外，还新建了另外一个dependencies.gradle以及自定义template目录下相关的脚本
复制代码


结构预览
springboot-gradle-demo
  ├─template
    ├─gradle
          ├─v1
                ├─build_java.gradle //bootjar、jar、war等构建方式定义
                ├─buildscript.gradle //统一加载需要的插件
                ├─functions.gradle //gralde定制化主函数配置
                ├─junit.gradle //单元测试依赖的jdk版本、源码目录等
  ├─app_common
  ├─app_one
  ├─app_two
├─build.gradle //仓库定义、引用外部函数、插件以及依赖各个子模块定制化等
├─dependencies.gradle //根据名字可以看出主要用来进行依赖jar包用途
├─settings.gradle //主模块及子模块之间的include依赖

3.2 定制化配置

核心配置文件build.gradle、dependencies.gradle、settings.gradle及template配置内容及用途说明如下：
（1）settings.gradle配置及说明：

  1. //Gradle主工程名
  2. rootProject.name = 'springboot-gradle-demo'

  4. //Gradle子模块名
  5. include 'app_common','app_one','app_two'
复制代码

（2）build.gradle配置及说明：

  1. //==================定制化1：仓库、编译、插件、公共依赖start==================
  2. buildscript {
  3.         //全局声明变量
  4.         ext {
  5.                 //maven公共仓库
  6.                 maven_public_repo_url="https://maven.aliyun.com/repository/public/"

  8.                 //gradle插件中心
  9.                 gradle_repo_url="https://plugins.gradle.org/m2/"

  11.                 //maven应用系统私有仓库
  12.                 //maven_private_dev_repo_url="https://maven.aliyun.com/repository/spring/"

  14.                 //DEV SNAPSHOTS依赖仓库
  15.                 //maven_snapshots_dev_repo_url="https://oss.sonatype.org/content/repositories/snapshots/"

  17.                 //插件目录(放在工程目录下，也可以单独存放到资源服务器，指定访问文件的具体url)
  18.                 template_dir="/template/gradle/v1"

  20.                 //编译目录（相对路径）
  21.                 output_dir="build"
  22.         }

  24.         //全局仓库: 自上而下寻找依赖
  25.         repositories {
  26.                 //maven本地仓库: 优先加载
  27.                 mavenLocal()

  29.                 //maven仓库中心
  30.                 mavenCentral()

  32.                 //jcenter仓库中心
  33.                 //jcenter()和mavenCentral()是两个独立的仓库，两者毫无关系，jcenter()有的mavenCentral()可能没有，反之亦然。
  34.                 jcenter()

  36.                 //google仓库中心
  37.                 //google()

  39.                 //maven远程仓库: 阿里云或公司私服仓库
  40.                 maven {
  41.                         url = maven_public_repo_url
  42.                         url = gradle_repo_url
  43.                         //url = maven_private_dev_repo_url
  44.                         //url = maven_snapshots_dev_repo_url
  45.                 }
  46.         }

  48.         //全局公共依赖
  49.         apply from: template_dir+'/buildscript.gradle',to: buildscript
  50. }
  51. //==================定制化1：仓库、编译、插件、公共依赖end==================

  53. //Java插件: 未配置时api、implementation无法加载
  54. plugins {
  55.         id 'java'
  56.         id 'java-library'
  57. }

  59. //==================定制化2：配置构建主入口、全局功能函数start==================
  60. //自定义全局工具定制化: 自动构建主入口+配置全局功能函数
  61. apply from: template_dir+'/functions.gradle'
  62. //==================定制化2：配置构建主入口、全局功能函数end==================


  65. //=======================定制化3：gradle子项目模块start=========================
  66. //common project
  67. project(':app_common'){
  68.         apply from: '..'+template_dir+'/build_java.gradle'
  69.         apply from: '..'+template_dir+'/junit.gradle'
  70. }

  72. //app_one project
  73. project(':app_one'){
  74.         apply from: '..'+template_dir+'/build_java.gradle'
  75.         apply from: '..'+template_dir+'/junit.gradle'
  76. }

  78. //app_two project
  79. project(':app_two'){
  80.         apply from: '..'+template_dir+'/build_java.gradle'
  81.         apply from: '..'+template_dir+'/junit.gradle'
  82. }
  83. //=======================定制化3：gradle子项目模块end=========================

  85. //=======================定制化4：子项目定义依赖start=========================
  86. apply from: 'dependencies.gradle'
  87. //=======================定制化4：子项目定义依赖end=========================
  88. //setSysSnapshotsRepo
  89. //待扩展...


复制代码

（3）dependencies.gradle配置及说明：

  1. //========================Gradle工程子模块依赖jar包及版本控制=========================
  2. //===========参数说明start=========
  3. //api: 依赖暴露，其他模块都可见
  4. //implementation: 表示依赖屏蔽，仅自己模块内可见
  5. //===========参数说明end===========



  9. //公共子模块依赖定义：app_common
  10. project(':app_common'){//app_common公共项目子模块: 作为jar工程供其他子模块引用，其他无须重复定义相关jar包
  11.         dependencies{
  12.                 //依赖仓库jar包
  13.                 api 'org.springframework.boot:spring-boot:2.4.3'
  14.                 api 'org.springframework.boot:spring-boot-starter-web:2.4.3'
  15.                 api 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.1.3'
  16.                 api 'mysql:mysql-connector-java:5.1.47'

  18.                 //依赖第三方jar包:指定工程资源lib目录下所有依赖包
  19.                 api fileTree(dir:'src/main/resources/lib',includes: ['*.jar'])

  21.                 //引入 mybatis-generator 插件
  22.                 //apply plugin: "com.arenagod.gradle.MybatisGenerator"

  24.                 //测试依赖：仅供测试用，仅当前模块生效，不会加载到打包版本中，PS: 根据实际需要定义
  25.                 testImplementation 'junit:junit:4.11'
  26.         }
  27. }

  29. //独立子模块依赖定义: app_one
  30. project(':app_one'){
  31.         dependencies{
  32.                 //模块依赖: 指定某个模块进行依赖
  33.                 implementation project(':app_common')

  35.                 //依赖第三方jar包：指定工程资源lib目录下所有依赖包
  36.             compile fileTree(dir:'src/main/resources/lib',includes: ['*.jar'])

  38.                 //依赖排除(包级别)：exclude的内容将不会被该jar包引用，PS: 根据实际需要定义
  39.                 testImplementation (('org.springframework:spring-test:5.3.3')) {
  40.                         exclude group: 'org.springframework', module: 'mock'
  41.                         exclude group: 'org.springframework', module: 'mock'
  42.                         exclude group: 'org.springframework', module: 'mock'
  43.                         exclude group: 'org.springframework', module: 'mock'
  44.                 }

  46.                 //依赖排除(模块级别)：exclude的内容将不会被该jar包引用，PS: 根据实际需要定义
  47.                 implementation (project(':app_common')) {
  48.                         exclude group: 'org.springframework', module: 'mock'
  49.                         exclude group: 'org.springframework', module: 'mock'
  50.                         exclude group: 'org.springframework', module: 'mock'
  51.                         exclude group: 'org.springframework', module: 'mock'
  52.                 }

  54.                 //测试依赖：仅供测试用，仅当前模块生效，不会加载到打包版本中，PS: 根据实际需要定义
  55.                 testImplementation 'junit:junit:4.11'
  56.                 testImplementation 'org.mybatis.generator:mybatis-generator-core:1.3.7'
  57.         }

  59.         //依赖排除(全局级别)：exclude的内容将不会被该jar包引用，PS: 当要排除的依赖范围很广时，可采用该方式
  60.         configurations.all {
  61.                 exclude group: 'org.springframework', module: 'spring-core'
  62.         }
  63. }

  65. //独立子模块依赖定义: app_two
  66. project(':app_two'){
  67.         dependencies{
  68.                 //模块依赖: 指定某个模块进行依赖
  69.                 implementation project(':app_common')

  71.                 //依赖第三方jar包：指定工程资源lib目录下所有依赖包
  72.                 compile fileTree(dir:'src/main/resources/lib',includes: ['*.jar'])

  74.                 //依赖排除(包级别)：exclude的内容将不会被该jar包引用，PS: 根据实际需要定义
  75.                 testImplementation (('org.springframework:spring-test:5.3.3')) {
  76.                         exclude group: 'org.springframework', module: 'mock'
  77.                         exclude group: 'org.springframework', module: 'mock'
  78.                         exclude group: 'org.springframework', module: 'mock'
  79.                         exclude group: 'org.springframework', module: 'mock'
  80.                 }

  82.                 //依赖排除(模块级别)：exclude的内容将不会被该jar包引用，PS: 根据实际需要定义
  83.                 implementation (project(':app_common')) {
  84.                         exclude group: 'org.springframework', module: 'mock'
  85.                         exclude group: 'org.springframework', module: 'mock'
  86.                         exclude group: 'org.springframework', module: 'mock'
  87.                         exclude group: 'org.springframework', module: 'mock'
  88.                 }

  90.                 //测试依赖：仅供测试用，仅当前模块生效，不会加载到打包版本中，PS: 根据实际需要定义
  91.                 testImplementation 'junit:junit:4.11'
  92.                 testImplementation 'org.mybatis.generator:mybatis-generator-core:1.3.7'
  93.         }

  95. }


复制代码

（4）template下的相关组件及函数
除了template/gradle/v1/functions.gradle这段内容中的包名com.justin需要改成自己的之外，其他可以可以不需要动

  1.   //deploy package dir of the project (sub-dir of output-dir)
  2.                 setSysPrivateRepo = { sys_id ->
  3.                         allprojects{
  4.                                 repositories{
  5.                                         maven {
  6.                                                 url maven_private_dev_repo_url
  7.                                                 content { includeGroupByRegx "com\\.justin\\."+sys_id+".*" }
  8.                                         }
  9.                                 }
  10.                         }
  11.                 }
复制代码
3.3 构建多模块（定制化）

同样整合了多个子模块的配置进行几种管理之后，跟前面一样，可以通过Gradle视图栏，对多个模块或者单个模块进行构建，生成得到jar、bootjar、war等格式的架包

[attach]140863[/attach]

如果大家有需要将多个模块的配置整合到一个配置里面进行管理的需求，可以根据本文提供的spring-boot-demo示例工程进行修改，来实现自己工程的定制化多模块配置的统一管理~

最后，附上spring-boot-demo工程的GitHub源码下载地址：https://github.com/JustinJava/springboot-gradle-demo













欢迎光临 51Testing软件测试论坛 (http://bbs.51testing.com/) Powered by Discuz! X3.2