架構(gòu)必修課：使用Bom管理依賴項(xiàng)，告別依賴包版本沖突
作者：迷路的架構(gòu)師
如果你使用過(guò) Spring Boot，應(yīng)該能注意到我們只需要聲明使用的庫(kù)即可，而不必指定版本。
如果你使用過(guò) Spring Boot，應(yīng)該能注意到我們只需要聲明使用的庫(kù)即可，而不必指定版本。如下所示：
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'javax.cache:cache-api'
implementation 'jakarta.xml.bind:jakarta.xml.bind-api'
runtimeOnly 'org.springframework.boot:spring-boot-starter-actuator'
runtimeOnly 'com.h2database:h2'
runtimeOnly 'org.postgresql:postgresql'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
}那么這是如何實(shí)現(xiàn)的呢？答案當(dāng)然是使用Bom進(jìn)行版本管理。
為什么要使用Bom？
不使用Bom將會(huì)存在很多問(wèn)題，如下：
- 版本沖突：當(dāng)不同的模塊或項(xiàng)目中使用相同的依賴項(xiàng)但版本不一致時(shí)，可能會(huì)發(fā)生版本沖突。可能導(dǎo)致編譯錯(cuò)誤、運(yùn)行時(shí)異常或不可預(yù)測(cè)的行為。沒(méi)有統(tǒng)一的依賴版本管理機(jī)制，開(kāi)發(fā)人員需要手動(dòng)處理版本沖突，增加了工作量和復(fù)雜性。
- 配置繁瑣：在每個(gè)模塊或項(xiàng)目中單獨(dú)指定依賴的版本號(hào)會(huì)導(dǎo)致配置繁瑣。當(dāng)需要更新或更改依賴版本時(shí)，必須在每個(gè)地方進(jìn)行修改，容易遺漏或出錯(cuò)。這樣的配置過(guò)程耗費(fèi)時(shí)間且容易引入錯(cuò)誤。
- 不一致的依賴環(huán)境：每個(gè)模塊或項(xiàng)目都有自己獨(dú)立的依賴配置，可能會(huì)導(dǎo)致不一致的依賴環(huán)境。這種不一致性可能導(dǎo)致測(cè)試和部署問(wèn)題，以及與其他團(tuán)隊(duì)成員之間的協(xié)作困難。
- 難以維護(hù)和更新：沒(méi)有集中的依賴管理機(jī)制，使得維護(hù)和更新依賴項(xiàng)變得困難。當(dāng)需要升級(jí)依賴版本或添加新的依賴時(shí)，需要在多個(gè)模塊或項(xiàng)目中進(jìn)行手動(dòng)操作，容易出錯(cuò)并帶來(lái)額外的工作量。
- 缺乏可視化和統(tǒng)一性：沒(méi)有BOM作為依賴清單，開(kāi)發(fā)人員可能缺乏對(duì)項(xiàng)目整體依賴關(guān)系和版本一致性的全局視圖。這使得項(xiàng)目管理和團(tuán)隊(duì)協(xié)作變得更加困難。
舉一個(gè)例子，app項(xiàng)目引入guava:31.1版本，又引入了lib，lib中依賴了guava:25.0，這時(shí)候?qū)?huì)存在兩個(gè)版本，如果還依賴了其他lib，其中又依賴了其他的guava版本，那么項(xiàng)目中同一個(gè)依賴將存在非常多的版本，難以管理。且與其他項(xiàng)目組協(xié)作時(shí)，版本不統(tǒng)一可能導(dǎo)致很多編譯錯(cuò)誤。
比如在guava:25.0中的這段代碼：
public class FutureStub {
public static Future<String> ofString(String s) {
doSomethingFunOnPurpose();
return CompletableFuture.completedFuture(s);
}
private static void doSomethingFunOnPurpose() {
Futures.immediateCheckedFuture(new Object());
}
}public class App {
public static void main(String[] args) throws Exception {
final var future = FutureStub.ofString("Hello Maven BOM");
System.out.println(future.get());
}
}在App類中的main函數(shù)對(duì)FutureStub.ofString方法進(jìn)行調(diào)用，這段代碼在guava:25.0中運(yùn)行良好，但在當(dāng)前App項(xiàng)目中就會(huì)報(bào)錯(cuò)，原因是該方法在guava:28后就已經(jīng)廢棄了。
那么要如何統(tǒng)一管理Bom呢？可以使用 Gradle 或者 Maven。
Gradle Bom示例：
- 首先，在項(xiàng)目的根目錄下創(chuàng)建一個(gè)名為dependencies.gradle的文件，用于定義BOM（Bill of Materials）：
ext {
// 定義BOM版本
bomVersion = '1.0.0'
// 定義依賴項(xiàng)的版本號(hào)
dependencies = [
'dependency1': '1.2.3',
'dependency2': '4.5.6',
// 添加更多依賴項(xiàng)...
]
}
// 創(chuàng)建BOM配置
configurations {
bom
}
// 生成BOM文件
task generateBom {
outputs.file("dependencies.bom")
doLast {
def bomFile = new File(outputs.files.singleFile, "dependencies.bom")
bomFile.text = configurations.bom.getResolvedConfiguration().getFirstLevelModuleDependencies().collect { dep ->
"${dep.moduleGroup}:${dep.moduleName}:${dep.moduleVersion}"
}.join("\n")
}
}- 在項(xiàng)目的build.gradle文件中，引入BOM并應(yīng)用到模塊中，并定義Maven發(fā)布任務(wù)：
apply from: 'dependencies.gradle'
plugins {
id 'maven-publish'
}
// 發(fā)布到Maven倉(cāng)庫(kù)
publishing {
repositories {
maven {
url "https://your.maven.repository.url" // 替換為實(shí)際的Maven倉(cāng)庫(kù)地址
credentials {
username 'your-username' // 替換為Maven倉(cāng)庫(kù)的用戶名
password 'your-password' // 替換為Maven倉(cāng)庫(kù)的密碼或API密鑰
}
}
}
publications {
mavenBom(MavenPublication) {
artifactId 'your-bom-artifact' // 替換為您的BOM的Artifact ID
version bomVersion
groupId 'your.group.id' // 替換為您的BOM的Group ID
pom.withXml {
def dependenciesNode = asNode().appendNode('dependencies')
dependencies.each { depName, depVersion ->
def dependencyNode = dependenciesNode.appendNode('dependency')
dependencyNode.appendNode('groupId', 'your.dependency.group.id') // 替換為實(shí)際的依賴項(xiàng)的Group ID
dependencyNode.appendNode('artifactId', depName)
dependencyNode.appendNode('version', depVersion)
}
}
}
}
}
// 發(fā)布任務(wù)
task publishToMavenRepository {
dependsOn generateBom
dependsOn publish
}- 運(yùn)行 publishToMavenRepository 任務(wù)來(lái)生成 BOM 文件并發(fā)布到 Maven 倉(cāng)庫(kù)：
./gradlew publishToMavenRepository這樣就完成了Bom的定義和發(fā)布，可以在Bom中統(tǒng)一管理項(xiàng)目中的依賴項(xiàng)版本，并可以讓其他團(tuán)隊(duì)使用這個(gè)Bom。
責(zé)任編輯：華軒
來(lái)源：
今日頭條
