依赖管理

要管理 Spring Boot 应用程序中的依赖项,您可以应用io.spring.dependency-management插件或使用 Gradle 的原生 BOM 支持。前者的主要好处是可以基于属性自定义受管理的版本,而后者则可能导致更快的构建速度。

使用依赖管理插件管理依赖项

应用io.spring.dependency-management插件后,Spring Boot 的插件会自动从您正在使用的 Spring Boot 版本导入spring-boot-dependencies BOM。这提供了与 Maven 用户享有的类似的依赖项管理体验。例如,它允许您在声明 BOM 中管理的依赖项时省略版本号。要使用此功能,请以通常方式声明依赖项,但省略版本号

  • Groovy

  • Kotlin

dependencies {
	implementation('org.springframework.boot:spring-boot-starter-web')
	implementation('org.springframework.boot:spring-boot-starter-data-jpa')
}
dependencies {
	implementation("org.springframework.boot:spring-boot-starter-web")
	implementation("org.springframework.boot:spring-boot-starter-data-jpa")
}

自定义受管理的版本

应用依赖管理插件时自动导入的spring-boot-dependencies BOM 使用属性来控制其管理的依赖项的版本。浏览 Spring Boot 参考中的依赖版本属性部分,了解这些属性的完整列表。

要自定义受管理的版本,请设置其对应的属性。例如,要自定义由slf4j.version属性控制的 SLF4J 版本

  • Groovy

  • Kotlin

ext['slf4j.version'] = '1.7.20'
extra["slf4j.version"] = "1.7.20"
每个 Spring Boot 版本都针对特定的一组第三方依赖项进行了设计和测试。覆盖版本可能会导致兼容性问题,因此应谨慎操作。

独立使用 Spring Boot 的依赖项管理

无需将 Spring Boot 插件应用于项目,即可在项目中使用 Spring Boot 的依赖项管理。SpringBootPlugin类提供了一个BOM_COORDINATES常量,可用于导入 BOM,而无需了解其组 ID、工件 ID 或版本。

首先,配置项目以依赖于 Spring Boot 插件,但不要应用它

  • Groovy

  • Kotlin

plugins {
	id 'org.springframework.boot' version '3.3.5' apply false
}
plugins {
	id("org.springframework.boot") version "3.3.5" apply false
}

Spring Boot 插件依赖于依赖管理插件,这意味着您可以使用依赖管理插件而无需声明对其的依赖。这也意味着您将自动使用与 Spring Boot 使用的相同版本的依赖管理插件。

应用依赖管理插件,然后将其配置为导入 Spring Boot 的 bom

  • Groovy

  • Kotlin

apply plugin: 'io.spring.dependency-management'

dependencyManagement {
	imports {
		mavenBom org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES
	}
}
apply(plugin = "io.spring.dependency-management")

the<DependencyManagementExtension>().apply {
	imports {
		mavenBom(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
	}
}

上面的 Kotlin 代码有点笨拙。这是因为我们正在使用命令式的方式应用依赖管理插件。

我们可以通过从根父项目应用插件,或者像我们对 Spring Boot 插件那样使用 `plugins` 块来使代码不那么笨拙。这种方法的一个缺点是它强制我们指定依赖管理插件的版本。

plugins {
	java
	id("org.springframework.boot") version "3.3.5" apply false
	id("io.spring.dependency-management") version "1.1.6"
}

dependencyManagement {
	imports {
		mavenBom(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
	}
}

了解更多

要了解有关依赖管理插件功能的更多信息,请参阅其文档

使用 Gradle 的 Bom 支持管理依赖项

Gradle 允许通过将其声明为 `platform` 或 `enforcedPlatform` 依赖项来使用 bom 管理项目的版本。`platform` 依赖项将 bom 中的版本视为建议,依赖关系图中的其他版本和约束可能会导致使用 bom 中声明的版本以外的依赖项版本。`enforcedPlatform` 依赖项将 bom 中的版本视为要求,它们将覆盖依赖关系图中找到的任何其他版本。

`SpringBootPlugin` 类提供了一个 `BOM_COORDINATES` 常量,可用于声明对 Spring Boot 的 bom 的依赖,而无需知道其组 ID、构件 ID 或版本,如下例所示。

  • Groovy

  • Kotlin

dependencies {
	implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
}
dependencies {
	implementation(platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES))
}

平台或强制平台只会约束在其已声明的配置或从其已声明的配置扩展的配置的版本。因此,可能需要在多个配置中声明相同的依赖项。

自定义管理版本

使用 Gradle 的 bom 支持时,您不能使用 `spring-boot-dependencies` 中的属性来控制它管理的依赖项的版本。相反,您必须使用 Gradle 提供的机制之一。一种这样的机制是解析策略。slf4j 的所有模块都在 `org.slf4j` 组中,因此可以通过将该组中的每个依赖项配置为使用特定版本来控制其版本,如下例所示。

  • Groovy

  • Kotlin

configurations.all {
	resolutionStrategy.eachDependency { DependencyResolveDetails details ->
		if (details.requested.group == 'org.slf4j') {
			details.useVersion '1.7.20'
		}
	}
}
configurations.all {
    resolutionStrategy.eachDependency {
        if (requested.group == "org.slf4j") {
            useVersion("1.7.20")
        }
    }
}
每个 Spring Boot 版本都针对特定的一组第三方依赖项进行了设计和测试。覆盖版本可能会导致兼容性问题,因此应谨慎操作。