spring boot2升级boot3指南

spring boot2升级boot3

整体流程如下

1、借助于开源的自动化代码重构工具OpenRewrite，快速地进行代码重构等

2、相关坐标升级更改

3、配置文件属性更改

4、打包、构建与运行验证

1. 前期准备工作

第一步：确保升级之前项目是可编译运行的
第二步：更改项目坐标中 version 版本，以免 install 后覆盖了已有的包，如：

xml 复制代码

<revision>5.9.0-SNAPSHOT</revision>
更改后：
<revision>5.9.0.1-boot3-SNAPSHOT</revision>

2. 使用OpenRewrite升级SpringBoot项目

对原项目代码进行重构，快捷升级可以使用OpenRewrite插件对项目进行改写，能自动升级如下：

markdown 复制代码

* javax 写法自动转为 jakarta
* 部分旧包pom坐标自动更新为新版pom坐标
* 部分配置旧版自动更新新版本
* 自动增加新版自动装配文件
* 部分spring写法变更会自动更换（部分复杂的会有一定的问题，需要对部分代码进行手动重写）

需注意的几个问题：

部分自动更新的写法可能会有问题，上面说的复杂的写法
部分设置的版本控制不会改变，但是如果spring定义了更高的版本，可能会导致版本过老不兼容，建议将spring-boot-dependecies里面定义过的版本控制进行删除
自动生成后仍需手动编译进行查缺补漏

2.1 添加OpenRewrite相关依赖

重要：

使用插件前要保证原项目没有经过更改，以及改过相关依赖坐标等。保证原本可编译过。

需要注意的点是该插件会对文件夹内所有文件都进行重构，不是根据具体的pom配置的module限制。所以会需要占用很大的内存，如果未设置jvm大小，一般在比较多模块的情况下会OOM。此时需要用命令设置，在项目根目录设置即可：

bash 复制代码

set MAVEN_OPTS=-Xmx2048m -XX:MaxHeapSize=1024m

目前最新的插件只支持SpringBoot_3_3，没有3.4.x的，但是相差不大，使用后注意如有springboot版本定义改为和框架同步 3.4.3
在 pom.xml 中添加 OpenRewrite 插件和所需的 recipe

xml 复制代码

<plugin>
    <groupId>org.openrewrite.maven</groupId>
    <artifactId>rewrite-maven-plugin</artifactId>
    <version>6.2.2</version>
    <configuration>
        <!-- activeRecipes标签用于指定要执行的OpenRewrite recipes -->
        <activeRecipes>
            <!-- 用于将SpringBoot升级到3.0版本的recipe -->
         <recipe>org.openrewrite.java.spring.boot3.UpgradeSpringBoot_3_3</recipe>
        </activeRecipes>
    </configuration>
    <dependencies>
        <dependency>
            <!-- 专门针对 Spring 生态系统的重构规则集合 -->
            <!-- 1、Spring Boot 2.x → 3.0 迁移
 			    2、Jakarta EE 包名替换（javax → jakarta）
			    3、过时配置属性更新 -->
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-spring</artifactId>
            <version>6.2.1</version>
        </dependency>
    </dependencies>
</plugin>

2.2 运行OpenRewrit后检查变更

1、引入坐标后使用如下命令进行预览更改，不修改实际源代码

bash 复制代码

mvn rewrite:dryRun

2、执行变更，实际应用并修改源代码

bash 复制代码

mvn rewrite:run

这个命令会分析你的项目，并应用SpringBoot 3.x.x 升级 recipe，自动更新代码以适应新版本的API变化
运行后检查：使用git查看文件变化，变化过大的需要格外注意些，如需要需进行手动更改

3、举例

例1：

运行 mvn rewrite:dryRun
运行 mvn rewrite:run

生成了新的 auto-configuration imports 文件

bash 复制代码

Generated new file:
xxx/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

Spring Boot 3.x 之后的变更之一，新的自动配置机制要求把 AutoConfiguration 类明确定义在 imports 文件中 ，取代了 spring.factories 文件中的配置方式

修改了配置类

arduino 复制代码

Changes have been made to:xxx/src/main/java/com/xxx/config/XxxConfigLoaderAutoConfiguration.java

例2 ：如运行 mvn rewrite:run，会把包名以 javax开头的需要相应地变更为jakarta，对应的单元测试、坐标等也会相应的进行变更

2.3 升级相关依赖版本

boot2

xml 复制代码

<java.version>1.8</java.version>
<spring-framework.version>5.3.27</spring-framework.version>
<spring-boot.version>2.5.8</spring-boot.version>
<spring-cloud.version>2020.0.5</spring-cloud.version>
<spring-cloud-alibaba.version>2021.1</spring-cloud-alibaba.version>

boot3

xml 复制代码

<java.version>17</java.version>
<spring-framework.version>6.2.3</spring-framework.version>
<spring-boot.version>3.4.3</spring-boot.version>
<spring-cloud.version>2024.0.0</spring-cloud.version>
<spring-cloud-alibaba.version>2023.0.1.0</spring-cloud-alibaba.version>

更新 Maven 编译器的配置

xml 复制代码

<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>

需要使用 Maven 3.6.3 以上版本，对应的插件版本升级如下

xml 复制代码

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-plugin-plugin</artifactId>
    <version>3.8.1</version>
</plugin>

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>3.1.2</version>
</plugin>

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.6.2</version>
    <configuration>
        <compilerArgs>
            <!-- 保留方法参数名，供 Spring/SpringDoc 等框架反射使用，
			不加的话endpoin会出问题-->
            <arg>-parameters</arg>
        </compilerArgs>
        <encoding>${project.build.sourceEncoding}</encoding>
        <showWarnings>true</showWarnings>
        <release>${java.version}</release>
    </configuration>
</plugin>

2.4 测试

mvn compile 修改编译问题
运行对应的测试类，确保升级后的项目仍能正常运行。可能需要手动调整一些OpenRewrite无法自动处理的部分

3. 常用坐标更改

1、MySQL JDBC驱动

xml 复制代码

<dependency>
    <groupId>com.mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
变更为：
<dependency>
    <groupId>com.mysql</groupId>
    <artifactId>mysql-connector-j</artifactId>
</dependency>

2、坐标不变，指定对应的版本号，如：

xml 复制代码

<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>4.12.0</version>
</dependency>

<dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-inline</artifactId>
    <version>4.8.0</version>
</dependency>

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-jcl</artifactId>
    <scope>provided</scope>
    <version>1.7.25</version>
</dependency>

<dependency>
    <groupId>org.apache.httpcomponents.client5</groupId>
    <artifactId>httpclient5</artifactId>
    <version>5.4.1</version>
</dependency>

<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.2</version>
</dependency>

3、测试相关

xml 复制代码

<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-engine</artifactId>
    <version>5.11.4</version>
</dependency>
<dependency>
    <groupId>org.junit.vintage</groupId>
    <artifactId>junit-vintage-engine</artifactId>
    <version>5.11.4</version>
</dependency>

4. 配置文件属性更改

1、Redis 配置

properties 复制代码

spring.redis.host: localhost
spring.redis.port: 6379
变更为：
spring.data.redis.host: localhost
spring.data.redis.port: 6379

2、RabbitMQ 配置

properties 复制代码

spring.rabbitmq.addresses: localhost:5672
spring.rabbitmq.username: guest
spring.rabbitmq.password: guest
变更为：
spring.rabbitmq.host: localhost
spring.rabbitmq.port: 5672
spring.rabbitmq.username: guest
spring.rabbitmq.password: guest

5. 常见问题汇总

1、通过 OpenRewrite 插件自动更改代码后，会出现 @Configuration 和 @AutoConfiguration 同时存在的情况，需要手动删除 @Configuration

2、通过插件自动更改后会出现pom某些包自动指定了某些版本，建议删除使用框架控制的版本

3、部分引入了 org.apache.commons.lang.x 的包会自动变成 org.apache.commons.lang3.x，需要手动改回。或者引入对应的坐标

4、部分注解会修改错误，如 javax.annotation.Nullable 会修改成 jakarta.annotation.Nullable，其实不存在 jakarta.annotation.Nullable，需要修改回去

5、部分app启动时会报xxx未开放，需要在启动增加如下参数

bash 复制代码

--add-opens java.base/java.lang.reflect=ALL-UNNAMED