Spring Boot Migrator (SBM) 概述

Spring Boot Migrator (SBM) 是 Spring 项目组于 2022 年 3 月发布的一个实验性项目，旨在帮助开发者将基于 JAX-RS、EJB 和 JMS 等技术的非 Spring Boot 应用程序迁移到 Spring Boot，或将旧版本的 Spring Boot 应用程序升级到最新版本。

技术基础

SBM 基于 OpenRewrite，这是一个用于源代码和配置重构的通用工具。OpenRewrite 通过 Recipes（配方）来实现对 Kubernetes、Gradle、Maven、Java 等技术的文件修改。SBM 专门使用 OpenRewrite 来进行 Spring Boot 的迁移工作。

使用方法

1. 下载与启动：

   • 用户可以从 GitHub 下载最新版本的 SBM。

   • 通过命令行启动 SBM：

     java -jar spring-boot-migrator.jar

   • 启动后，用户会看到 SBM 的专用提示符：migrator:>。

2. 列出可用配方：

   • 使用 list 命令，可以查看当前支持的 30 个配方。这些配方支持的功能包括：

     • 升级 Spring Boot 到新版本
     • 将 XML Bean 配置改为 Java 配置
     • 将 Java EE / Jakarta 实现迁移到 Spring Boot

3. 扫描应用程序：

   • 使用 scan [directory] 命令，SBM 会分析应用程序并显示适用的配方。

   • 例如，扫描一个不支持 Spring Boot 的旧版 JAX-RS 应用程序时，SBM 会显示以下结果：

     scanning 'JAXRS'

     • 检查应用程序的 pom.xml、Java 版本、源代码目录等。

     • 显示适用的配方，例如：

       • initialize-spring-boot-migration：将应用程序初始化为 Spring Boot 应用程序。
       • migrate-jax-rs：迁移 JAX-RS 代码到 Spring Boot。

4. 应用配方：

   • 使用 apply 命令应用配方，例如：

     migrator:> apply initialize-spring-boot-migration

   • 应用配方后，SBM 会生成一个 Git 提交，描述为 SBM: applied recipe 'initialize-spring-boot-migration'。

   • 在 pom.xml 中，SBM 会进行以下修改：

     • 将打包方式从 WAR 改为 JAR
     • 添加 spring-boot-starter 和 spring-boot-starter-test 依赖
     • 添加 spring-boot-maven-plugin
     • 在 dependencyManagement 中添加 spring-boot-dependencies
   • 源代码中会生成 SpringBootApp.java 和 SpringBootAppTest.java，分别包含 @SpringBootApplication 和 @SpringBootTest 注解。

5. 进一步迁移：

   • 使用 migrate-jax-rs 配方将 JAX-RS 代码迁移到 Spring Boot：

     migrator:> apply migrate-jax-rs

   • 迁移后，JAX-RS 的注解（如 @Path、@Get 等）会被 Spring Boot 的注解（如 @RestController、@RequestMapping 等）替换，返回类型也从 Response 改为 ResponseEntity。

6. 问题与解决方案：

   • 迁移后，Spring Boot 应用程序可能由于 pom.xml 中 maven-compiler-plugin 使用了旧版 Java 而无法运行。用户需要手动修改 pom.xml 或使用 OpenRewrite 的 Change Maven plugin configuration 配方自动完成。
   • 迁移后，部分依赖可能不再需要，可以手动或通过 SBM 自动移除。

当前限制与未来展望

• SBM 目前仅支持 Maven 项目，因为 OpenRewrite 对 Gradle 的支持尚未完成。
• 更多关于 SBM 的信息可以在 用户文档 和 开发者文档 中找到。