架構必修課：使用Bom管理依賴項，告別依賴包版本沖突
作者：迷路的架構師
如果你使用過 Spring Boot，應該能注意到我們只需要聲明使用的庫即可，而不必指定版本。
如果你使用過 Spring Boot，應該能注意到我們只需要聲明使用的庫即可，而不必指定版本。如下所示：
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'
}那么這是如何實現的呢？答案當然是使用Bom進行版本管理。
為什么要使用Bom？
不使用Bom將會存在很多問題，如下：
- 版本沖突：當不同的模塊或項目中使用相同的依賴項但版本不一致時，可能會發生版本沖突。可能導致編譯錯誤、運行時異常或不可預測的行為。沒有統一的依賴版本管理機制，開發人員需要手動處理版本沖突，增加了工作量和復雜性。
- 配置繁瑣：在每個模塊或項目中單獨指定依賴的版本號會導致配置繁瑣。當需要更新或更改依賴版本時，必須在每個地方進行修改，容易遺漏或出錯。這樣的配置過程耗費時間且容易引入錯誤。
- 不一致的依賴環境：每個模塊或項目都有自己獨立的依賴配置，可能會導致不一致的依賴環境。這種不一致性可能導致測試和部署問題，以及與其他團隊成員之間的協作困難。
- 難以維護和更新：沒有集中的依賴管理機制，使得維護和更新依賴項變得困難。當需要升級依賴版本或添加新的依賴時，需要在多個模塊或項目中進行手動操作，容易出錯并帶來額外的工作量。
- 缺乏可視化和統一性：沒有BOM作為依賴清單，開發人員可能缺乏對項目整體依賴關系和版本一致性的全局視圖。這使得項目管理和團隊協作變得更加困難。
舉一個例子，app項目引入guava:31.1版本，又引入了lib，lib中依賴了guava:25.0，這時候將會存在兩個版本，如果還依賴了其他lib，其中又依賴了其他的guava版本，那么項目中同一個依賴將存在非常多的版本，難以管理。且與其他項目組協作時，版本不統一可能導致很多編譯錯誤。
比如在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函數對FutureStub.ofString方法進行調用，這段代碼在guava:25.0中運行良好，但在當前App項目中就會報錯，原因是該方法在guava:28后就已經廢棄了。
那么要如何統一管理Bom呢？可以使用 Gradle 或者 Maven。
Gradle Bom示例：
- 首先，在項目的根目錄下創建一個名為dependencies.gradle的文件，用于定義BOM（Bill of Materials）：
ext {
// 定義BOM版本
bomVersion = '1.0.0'
// 定義依賴項的版本號
dependencies = [
'dependency1': '1.2.3',
'dependency2': '4.5.6',
// 添加更多依賴項...
]
}
// 創建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")
}
}- 在項目的build.gradle文件中，引入BOM并應用到模塊中，并定義Maven發布任務：
apply from: 'dependencies.gradle'
plugins {
id 'maven-publish'
}
// 發布到Maven倉庫
publishing {
repositories {
maven {
url "https://your.maven.repository.url" // 替換為實際的Maven倉庫地址
credentials {
username 'your-username' // 替換為Maven倉庫的用戶名
password 'your-password' // 替換為Maven倉庫的密碼或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') // 替換為實際的依賴項的Group ID
dependencyNode.appendNode('artifactId', depName)
dependencyNode.appendNode('version', depVersion)
}
}
}
}
}
// 發布任務
task publishToMavenRepository {
dependsOn generateBom
dependsOn publish
}- 運行 publishToMavenRepository 任務來生成 BOM 文件并發布到 Maven 倉庫：
./gradlew publishToMavenRepository這樣就完成了Bom的定義和發布，可以在Bom中統一管理項目中的依賴項版本，并可以讓其他團隊使用這個Bom。
責任編輯：華軒
來源：
今日頭條
