基于OpenRewrite实现Spring项目迁移至Spring Boot及Java版本升级

完全可以通过OpenRewrite实现Spring到Spring Boot的迁移，它提供了专门的Spring生态配方，能大幅自动化迁移流程，结合你已完成的Java版本升级，可高效完成整体迁移工作。

一、前置准备 #

• 你已完成的Java版本升级需确保与目标Spring Boot版本兼容（例如Spring Boot 3.x要求Java 17及以上）
• 确认项目使用Maven或Gradle构建（OpenRewrite对这两种构建工具支持最完善）

二、核心迁移步骤与OpenRewrite配方 #

1. 引入Spring Boot迁移依赖 #

根据项目构建工具添加OpenRewrite及Spring迁移配方依赖：

Maven配置

在pom.xml的build/plugins节点下添加：

<plugin>
    <groupId>org.openrewrite.maven</groupId>
    <artifactId>rewrite-maven-plugin</artifactId>
    <version>5.40.0</version>
    <dependencies>
        <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-spring</artifactId>
            <version>5.40.0</version>
        </dependency>
    </dependencies>
</plugin>

Gradle配置

在build.gradle中添加：

plugins {
    id("java")
    id("org.openrewrite.rewrite") version("6.12.0")
}

dependencies {
    rewrite(platform("org.openrewrite.recipe:rewrite-recipe-bom:2.4.0"))
    rewrite("org.openrewrite.recipe:rewrite-spring")
}

2. 执行官方迁移配方 #

OpenRewrite提供了针对不同Spring Boot版本的成套迁移配方：

• org.openrewrite.java.spring.boot2.SpringBoot2MigrationRecipe：适配从Spring Framework 5.x迁移到Spring Boot 2.x
• org.openrewrite.java.spring.boot3.SpringBoot3MigrationRecipe：适配从Spring Framework 6.x迁移到Spring Boot 3.x

执行命令

• Maven：

mvn rewrite:run -Drewrite.activeRecipes=org.openrewrite.java.spring.boot3.SpringBoot3MigrationRecipe

• Gradle：

./gradlew rewriteRun -Drewrite.activeRecipes=org.openrewrite.java.spring.boot3.SpringBoot3MigrationRecipe

这些配方会自动完成以下核心工作：

• 将零散的Spring Framework依赖替换为对应的Spring Boot Starter依赖
• 为启动类添加@SpringBootApplication注解，重构传统Java配置/XML配置结构
• 将配置参数迁移到application.properties或application.yml
• 更新过时API调用，适配Spring Boot的自动配置逻辑

3. 手动处理未覆盖场景 #

通用配方无法覆盖所有项目的自定义逻辑，需补充调整：

• 迁移自定义过滤器、监听器到Spring Boot的@Bean声明或自动配置体系
• 验证第三方依赖兼容性，替换不支持Spring Boot的老旧依赖
• 测试自动生成的配置文件，确保业务逻辑正常运行

三、自定义配方（针对特殊场景） #

如果项目有独特的迁移需求，可以编写自定义OpenRewrite配方：

1. 继承org.openrewrite.Recipe类
2. 实现基础描述方法，添加自定义代码处理逻辑
   示例代码：

public class CustomSpringToBootMigration extends Recipe {
    @Override
    public String getDisplayName() {
        return "自定义Spring到Spring Boot迁移配方";
    }

    @Override
    public String getDescription() {
        return "处理项目特定的Spring API替换逻辑";
    }

    @Override
    public TreeVisitor<?, ExecutionContext> getVisitor() {
        return new JavaIsoVisitor<ExecutionContext>() {
            @Override
            public MethodInvocation visitMethodInvocation(MethodInvocation method, ExecutionContext ctx) {
                // 替换项目内特定的旧Spring工具类调用
                if (method.getMethodType().getDeclaringType().getFullyQualifiedName().equals("com.example.OldSpringUtil")
                        && method.getSimpleName().equals("legacyMethod")) {
                    return method.withTemplate(Template.builder("com.example.NewBootUtil.modernMethod()")
                            .build(), getCursor());
                }
                return super.visitMethodInvocation(method, ctx);
            }
        };
    }
}

将自定义配方引入构建配置后，可与官方配方一同执行。

内容的提问来源于stack exchange，提问作者Ata Türkoğlu