在gradle管理可共享的依赖版本

“可共享的依赖版本管理” —— 用过 Maven 的小伙伴们可能说,这不就是BOM么。
对,这里聊的就是如何使用 gradle 实现 BOM 生成和导入。
没用过 Maven 的小伙伴们也不用被劝退,想想在使用Spring plugin io.spring.dependency-management时,imports.mavenBom到底在做什么,有没有想要了解一下?

1. BOM是什么?

在说 BOM 之前,先了解一下 Maven 的一些基本概念。
Maven POM,全名 Project Object Model, 是 Maven 使用中的重要配置文件,xml格式,主要用来导入依赖和进行项目构建。
Maven BOM,全名 Bill Of Materials, 是一种特殊的 POM,主要用来集中管理项目依赖的版本,更加灵活地维护所有依赖的版本信息。
配置好的 BOM,可以放在单个项目中自用,也可以传阅和分享给其他项目进行公用。

讲的直观一点,效果就是(见下图):


Spring-dependencies-management

dependencies中依赖的那些库为何可以不用标明版本?
正是因为使用了dependency-management 插件,当 gradle plugin org.springframework.boot 检测到此插件启用时,会自动导入Spring boot dependencies BOM,这样依赖库们会主动使用 BOM 中推荐的版本。链接

下面是Spring Cloud BOM的一部分展示(完整见链接):

Spring-cloud-dependencies

看到这里,是不是觉得有 BOM 的情况下便捷不少,再也不用一条条dependency分别查阅、选择和维护版本了?
日常开发中,我们已经见识过了Spring boot / Spring Cloud /junit 这些常用 BOMs。

当有了已经被验证过的依赖版本管理,setup projects时候直接拿来复用,是不是感觉省事不少?
同时 BOM 不可避免地还支持版本升级。
下面我们就来看看如何在 gradle 中定义我们自己的 BOM。

2. gradle Java platform plugin

gradle Java platform plugin是 gradle 对定义、发布 BOM 提供的一款实用插件。
引入它,我们就可以开始动手工作了。官方链接

build.gradle

plugins {
    id 'maven-publish'
    id 'java-platform'
}

version '0.1.1-SNAPSHOT'

javaPlatform {
    allowDependencies()
}
dependencies {
    api platform('org.springframework.boot:spring-boot-dependencies:2.2.6.RELEASE')
    api platform('org.springframework.cloud:spring-cloud-dependencies:Greenwich.SR3')
    api platform('org.springframework.cloud:spring-cloud-contract-dependencies:2.2.3.RELEASE')
    api platform('org.junit:junit-bom:5.3.2')
    constraints {
        api 'com.google.guava:guava:27.0.1-jre'

        api 'ch.vorburger.mariaDB4j:mariaDB4j-springboot:2.4.0'
        api 'org.mariadb.jdbc:mariadb-java-client:2.2.5'

        api 'org.mockito:mockito-core:2.22.0'
        api 'org.mockito:mockito-junit-jupiter:2.22.0'
        api 'org.assertj:assertj-core:3.11.1'
    }
}

publishing {
    repositories {
        maven {
            credentials {
                username = 'jfrog'
                password = 'jfrog123456'
            }

            def releasesRepoUrl = 'http://localhost:8082/artifactory/libs-release/'
            def snapshotsRepoUrl = 'http://localhost:8082/artifactory/libs-snapshot/'
            url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
        }
    }

    publications {
        myPlatform(MavenPublication) {
            from components.javaPlatform
        }
    }
}




当然, 作为一个服务级的 BOM,自然无需从零开始逐条定义,可以直接先 import 框架级的 BOMs,如上例中的Spring boot / Spring cloud / Spring cloud contract / Junit。
但由于需要使用第三方platform bom, 则不得不打开配置约束 ——javaPlatform.allowDependencies。具体使用请见官方链接

这里,通过gradle生成的 BOM 会发布到一个我本地自己搭建的JFrog artifactory OSS中。
(为什么不在云上搭一个?啊哈哈,因为JFrog artifactory OSS最低预配是4核4G内存,自己掏钱就手短了。。)
当然,也可以生成本地的 POM 文件,手动复制传阅,但这样就不容易进行后续的版本管理和保持更新了。

maven publish 成功后,我们就可以来使用 BOM 导入依赖版本了。

3. gradle platform

导入方式也非常简单,直接使用platform组件即可。官方链接

创建一个example项目试一下, 编写build.gradle文件。

repositories {
    maven {
        credentials {
            username = "jfrog"
            password = "jfrog123456"
        }
        url "http://localhost:8082/artifactory/libs-snapshot/"
    }
}

dependencies {
    implementation platform('com.ellendan.service.template:dependencies-bom:0.1.1-SNAPSHOT')

    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.boot:spring-boot-starter-security'

}

对,就是使用platform()引入即可。

也许有人会问:大家用 spring-dependency-management 习惯了,这个 BOM 是否支持 spring-dependency-management 的 imports.mavenBom
理论上是支持的。
但本人在写代码的时候,发现自定义 BOM 中spring boot dependencies BOM 无法被成功引入,而其他 BOMs 都没有此问题、可以成功导入。
因此,我这里并不推荐通过spring-dependency-management的imports.mavenBom来导入。

4. 为什么要做“可共享的依赖版本管理”

这还要从本人最近的一个任务说起。
任务本身是做 —— “启动模板”。
但“启动模板”,这四个字,怎么看都觉得非常的静态。
结合Rebecca《演进式架构》中“服务模板”的概念(虽然“模板”这命名还是怎么看怎么静态)。在构建服务的过程中,为了防止有害的重复,如果技术上的适当耦合避免不了,那就尽量让其黑盒复用。

通过在服务模板中定义适当的技术架构耦合点,并让基础设施团队管理这些耦合,就能使各个服务团队免于这些苦恼。

所以,这里决定尝试做一个“服务模板”。
依赖版本管理只是其中的一个小的部分, 并且使用 gradle 来实现也非常简单。
具体代码地址:https://github.com/ellendan000/service_template

PS. 废话篇

眼看2020就要过半,由于2020开局乱来,受种种因素影响,计划一团混乱变更。
一鼓作气,再而衰,三而竭,各种计划目标债。期望2020后半段能走好吧~

参考资料

  1. https://docs.spring.io/spring-boot/docs/current/gradle-plugin/reference/html/#managing-dependencies
  2. https://docs.gradle.org/5.6.3/userguide/java_platform_plugin.html#header
  3. https://docs.gradle.org/current/userguide/platforms.html
  4. https://docs.spring.io/dependency-management-plugin/docs/current/reference/html/#introduction
  5. https://www.baeldung.com/spring-maven-bom

个站原文

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,423评论 6 491
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,147评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,019评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,443评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,535评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,798评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,941评论 3 407
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,704评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,152评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,494评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,629评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,295评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,901评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,742评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,978评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,333评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,499评论 2 348

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,629评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,773评论 6 342
  • 问题复现 在项目中使用kafka组件,查看依赖(gradle dependencies)发现kafka-clien...
    知而乐者阅读 1,106评论 0 0
  • 简介 Spring Boot Gradle Plugin为Spring Boot提供了对Gradle的支持,允许你...
    竹天亮阅读 29,141评论 2 16
  • 久违的晴天,家长会。 家长大会开好到教室时,离放学已经没多少时间了。班主任说已经安排了三个家长分享经验。 放学铃声...
    飘雪儿5阅读 7,513评论 16 22