跳到主要内容

响应其他插件

DeepSeek V3 中英对照 Reacting to Other Plugins

当应用另一个插件时,Spring Boot 插件会通过修改项目的配置做出相应的反应。本节将描述这些变化。

对 Java 插件的响应

当 Gradle 的 Java 插件 应用于项目时,Spring Boot 插件:

  1. 创建一个名为 bootJarBootJar 任务,该任务将为项目创建一个可执行的 uber jar。该 jar 将包含主源代码集的运行时类路径中的所有内容;类文件打包在 BOOT-INF/classes 中,而 jar 文件打包在 BOOT-INF/lib 中。

  2. 配置 assemble 任务,使其依赖于 bootJar 任务。

  3. 配置 jar 任务,使用 plain 作为其归档分类器的约定。

  4. 创建一个名为 bootBuildImageBootBuildImage 任务,该任务将使用 buildpack 创建一个 OCI 镜像。

  5. 创建一个名为 bootRunBootRun 任务,该任务可用于运行应用程序,使用 main 源代码集来查找其主方法并提供其运行时类路径。

  6. 创建一个名为 bootTestRunBootRun 任务,该任务可用于运行应用程序,使用 test 源代码集来查找其主方法并提供其运行时类路径。

  7. 创建一个名为 bootArchives 的配置,其中包含由 bootJar 任务生成的工件。

  8. 创建一个名为 developmentOnly 的配置,用于仅在开发时需要的依赖项,例如 Spring Boot 的 Devtools,这些依赖项不应打包在可执行的 jar 和 war 中。

  9. 创建一个名为 testAndDevelopmentOnly 的配置,用于仅在开发时以及编写和运行测试时需要的依赖项,这些依赖项不应打包在可执行的 jar 和 war 中。

  10. 创建一个名为 productionRuntimeClasspath 的配置。它等同于 runtimeClasspath,但排除了仅出现在 developmentOnlytestDevelopmentOnly 配置中的任何依赖项。

  11. 配置任何未配置编码的 JavaCompile 任务以使用 UTF-8

  12. 配置任何 JavaCompile 任务以使用 -parameters 编译器参数。

对 Kotlin 插件的响应

Kotlin 的 Gradle 插件 应用于项目时,Spring Boot 插件:

  1. 将 Spring Boot 依赖管理中使用的 Kotlin 版本与插件的版本对齐。这是通过设置 kotlin.version 属性来实现的,该属性的值与 Kotlin 插件的版本匹配。

  2. 配置所有 KotlinCompile 任务以使用 -java-parameters 编译器参数。

响应 War 插件

当 Gradle 的 war 插件 应用到项目时,Spring Boot 插件:

  1. 创建一个名为 bootWarBootWar 任务,该任务将为项目创建一个可执行的 fat war。除了标准打包外,providedRuntime 配置中的所有内容都将打包到 WEB-INF/lib-provided 中。

  2. 配置 assemble 任务依赖于 bootWar 任务。

  3. 配置 war 任务使用 plain 作为其归档分类器的约定。

  4. 配置 bootArchives 配置以包含由 bootWar 任务生成的工件。

响应依赖管理插件

io.spring.dependency-management 插件 应用于项目时,Spring Boot 插件会自动导入 spring-boot-dependencies bom。

响应应用程序插件

当 Gradle 的 application 插件 被应用到项目时,Spring Boot 插件:

  1. 创建一个名为 bootStartScriptsCreateStartScripts 任务,该任务将生成使用 java -jar 启动 bootArchives 配置中的工件的脚本。该任务配置为使用 applicationDefaultJvmArgs 属性作为其 defaultJvmOpts 属性的约定。

  2. 创建一个名为 boot 的新分发,并配置其在其 lib 目录中包含 bootArchives 配置中的工件,并在其 bin 目录中包含启动脚本。

  3. 配置 bootRun 任务以使用 mainClassName 属性作为其 main 属性的约定。

  4. 配置 bootRunbootTestRun 任务以使用 applicationDefaultJvmArgs 属性作为其 jvmArgs 属性的约定。

  5. 配置 bootJar 任务以使用 mainClassName 属性作为其清单中 Start-Class 条目的约定。

  6. 配置 bootWar 任务以使用 mainClassName 属性作为其清单中 Start-Class 条目的约定。

对 GraalVM Native Image 插件的响应

GraalVM Native Image 插件 应用于一个项目时,Spring Boot 插件:

  1. 应用 org.springframework.boot.aot 插件,该插件:

    1. 注册 aotaotTest 源码集。

    2. 注册一个名为 processAotProcessAot 任务,该任务将生成应用程序在 aot 源码集下的 AOT 优化源码。

    3. 配置 aot 源码集的 Java 编译和资源处理任务,使其依赖于 processAot 任务。

    4. 注册一个名为 processTestAotProcessTestAot 任务,该任务将生成应用程序测试在 aotTest 源码集下的 AOT 优化源码。

    5. 配置 aotTest 源码集的 Java 编译和资源处理任务,使其依赖于 processTestAot 任务。

  2. aot 源码集的输出添加到 main GraalVM 原生二进制文件的类路径中。

  3. aotTest 源码集的输出添加到 test GraalVM 原生二进制文件的类路径中。

  4. 配置 GraalVM 扩展以禁用工具链检测。

  5. 配置每个 GraalVM 原生二进制文件,要求 GraalVM 22.3 或更高版本。

  6. 配置 bootJar 任务,使其在其 jar 中包含由 collectReachabilityMetadata 任务生成的可达性元数据。

  7. 配置 bootJar 任务,添加 Spring-Boot-Native-Processed: true 清单条目。

响应 CycloneDX 插件

当将 CycloneDX 插件 应用到项目时,Spring Boot 插件:

  1. 配置 cyclonedxBom 任务以使用 application 项目类型,并将 SBOM 以 JSON 格式输出到 application.cdx 文件中,不包含完整的许可证文本。

  2. 将 SBOM 添加到生成的 jar 或 war 文件的 META-INF/sbom 目录下。

  3. Sbom-FormatSbom-Location 添加到 jar 或 war 文件的清单中。