将 spring boot 从 2.7.x 升级到 3.3 是一个重要的迁移过程,特别是因为 spring boot 3.x 系列基于 jakarta ee 9,而不再使用 java ee。此版本升级伴随着许多重大变化,以下是你在升级过程中需要注意的关键事项:
1. jdk 版本升级
- 要求:spring boot 3.x 最低要求 jdk 17。如果你当前项目还在使用 jdk 8 或 jdk 11,首先需要升级到 jdk 17 或更高版本。
- 建议:在升级 spring boot 之前,先确保项目能够在 jdk 17 上正常运行。
2. jakarta ee 迁移
- 变化:spring boot 3.x 转换到 jakarta ee 9,所有 java ee 包名从
javax.*
更改为jakarta.*
。- 例如:
javax.servlet
变成了jakarta.servlet
。
- 例如:
- 解决方法:检查代码中是否直接依赖了
javax.*
包,如果有的话,必须修改为jakarta.*
。许多第三方库和框架(如 hibernate、tomcat、jetty 等)也需要更新到兼容 jakarta ee 版本。
3. spring framework 6 升级
- spring boot 3.x 是基于 spring framework 6 构建的,升级到 spring framework 6 会带来以下改动:
- 移除的 api:一些已经废弃的 api 将被彻底移除。
- 不再支持的框架:对一些老旧技术和库的支持被移除,如 junit 4、cglib、rhino 等。
- reactive changes:spring webflux 的一些 api 已做调整。
- 解决方法:根据官方迁移指南,调整代码中使用到的 spring api。
4. 依赖库的兼容性
- 第三方库升级:确保你项目中使用的所有第三方库都兼容 spring boot 3.x 和 jakarta ee 9。如果你使用的库没有更新到支持
jakarta.*
包,可能需要找到替代方案或等待库更新。 - 建议:升级前使用
mvn dependency:tree
或./gradlew dependencies
来检查所有依赖项,并确认其兼容性。
5. spring security
- spring security 6:spring boot 3.x 使用 spring security 6,带来了诸多变化,尤其是在 oauth2 和 jwt 的处理上有新的 api 改动。
- 变化示例:
- 许多配置类和方法已经废弃或被重构,比如
websecurityconfigureradapter
已被弃用,推荐使用securityfilterchain
来配置安全规则。 @enablewebsecurity
需要与securityconfigureradapter
一起配置,而不再是继承websecurityconfigureradapter
。
- 许多配置类和方法已经废弃或被重构,比如
6. hibernate 和 jpa
- jakarta persistence api:spring boot 3.x 使用的 hibernate 版本已经迁移到 jakarta persistence api (
jakarta.persistence
),这意味着你需要检查项目中所有 jpa 实体类的导入声明,确保它们指向正确的 jakarta 包。 - 建议:使用自动化工具如
jdeps
或jdeprscan
来检查代码中的依赖并进行迁移。
7. 日志框架
- log4j 2.x 或 logback 更新:spring boot 3.x 默认使用较新的日志库版本,确保项目中的日志框架已经升级到最新的稳定版本以防止兼容性问题。
- 日志配置:检查
log4j2.xml
或logback-spring.xml
中的配置项是否需要更新,尤其是涉及jakarta.*
包的。
8. spring cloud 和其他生态系统
- spring cloud 兼容性:如果你使用了 spring cloud,确保 spring cloud 版本与 spring boot 3.x 兼容。通常 spring cloud 会发布兼容特定 spring boot 版本的版本。
- 例如:spring cloud 2022.0.x 系列版本兼容 spring boot 3.x。
9. 废弃和移除的 api
- 废弃 api 清单:在 spring boot 2.7.x 中,某些 api 可能已经标记为废弃,spring boot 3.x 可能会彻底移除这些 api。因此在升级前,建议先解决所有废弃 api 的警告。
- 工具:使用
jdeps
或jdeprscan
工具检查是否使用了废弃的 api。
10. 配置文件的变更
- application.properties / application.yml:一些配置属性可能在 spring boot 3.x 中发生了变更或重命名,需要检查你的配置文件。
- 解决方法:参考 spring boot 官方发布的配置属性迁移指南,确保配置项正确迁移。
11. 测试框架
- junit 5:spring boot 3.x 强制要求使用 junit 5。如果你项目中仍在使用 junit 4,需要迁移到 junit 5。junit 5 提供了更现代化的 api 和特性,如
@extendwith
、@testfactory
、@nested
等。 - mock 和 stub 库:升级时也要注意测试框架如 mockito、wiremock 等的兼容性。
示例:升级过程的步骤
1. 升级 java 版本
- 修改
pom.xml
中的maven.compiler.source
和maven.compiler.target
为 17,或者修改build.gradle
中的sourcecompatibility
和targetcompatibility
为 17。 - 确保在 jdk 17 环境下编译和运行项目。
2. 升级 spring boot 版本
在 pom.xml
中将 spring boot 版本升级为 3.3.x:
<parent> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-parent</artifactid> <version>3.3.x</version> <relativepath/> <!-- lookup parent from repository --> </parent>
或者在 build.gradle
中:
implementation 'org.springframework.boot:spring-boot-starter:3.3.x'
3. 迁移依赖库
- 使用
mvn dependency:tree
或./gradlew dependencies
查看依赖树,确保所有依赖都兼容jakarta.*
包名。 - 手动调整代码中对
javax.*
的引用,改为jakarta.*
。
4. 运行和测试
- 运行项目,修复编译和运行时问题。
- 运行单元测试和集成测试,确保所有测试通过,且升级不会破坏功能。
额外工具
jdeps
:用于检测是否使用了已被移除的 jdk 内部 api。jdeprscan
:扫描项目是否使用了已废弃的 api,可以结合--release 17
参数来检查与 jdk 17 的兼容性。
总结
从 spring boot 2.7.x 升级到 3.3 是一个涉及较多变动的过程,特别是迁移到 jakarta ee 和 jdk 17。你需要确保:
- 项目在 jdk 17 上正常运行。
- 所有
javax.*
包改为jakarta.*
。 - 更新 spring 依赖和第三方库以支持 jakarta ee 9。
- 仔细检查配置文件和日志,处理废弃 api。
到此这篇关于springboot从2.7.x 升级到3.3注意事项的文章就介绍到这了,更多相关springboot从2.7.x 升级到3.3内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网!
发表评论