当前位置:首页 > 文章列表 > 文章 > java教程 > SpringBoot3集成Swagger2失败解决办法

SpringBoot3集成Swagger2失败解决办法

2026-03-15 09:42:45 0浏览 收藏
Spring Boot 3.x 因全面升级至 Spring Framework 6 和 Jakarta EE 9+,彻底移除了 Springfox 2.9.2 所依赖的旧版类(如 `InvertibleComparator`),导致集成失败并抛出 `NoClassDefFoundError`——这并非配置问题,而是技术代际断裂的必然结果;本文直击痛点,提供零配置、三步到位的平滑迁移方案:彻底弃用已停止维护的 Springfox,转而采用官方推荐、原生支持 Spring Boot 3 的 Springdoc OpenAPI,不仅一键解决启动异常,更带来更强的安全性、更好的生态兼容性(WebFlux、Spring Security、Lombok)、更简洁的 UI 访问路径(`/swagger-ui/index.html`)以及持续活跃的社区支持,让您的 API 文档真正跟上现代 Spring 开发节奏。

Spring Boot 3.x 中集成 Swagger2 失败的完整解决方案

Spring Boot 3.x 与 Springfox 2.9.2 不兼容,因 Spring Boot 3 基于 Jakarta EE 9+ 和 Spring Framework 6,移除了 org.springframework.util.comparator.InvertibleComparator 等旧类,导致 Springfox 启动时抛出 NoClassDefFoundError;推荐迁移到现代、 actively-maintained 的替代方案 Springdoc OpenAPI。

Spring Boot 3.x 与 Springfox 2.9.2 不兼容,因 Spring Boot 3 基于 Jakarta EE 9+ 和 Spring Framework 6,移除了 `org.springframework.util.comparator.InvertibleComparator` 等旧类,导致 Springfox 启动时抛出 `NoClassDefFoundError`;推荐迁移到现代、 actively-maintained 的替代方案 Springdoc OpenAPI。

Spring Boot 3.x(如您使用的 3.0.1 版本)已全面升级至 Spring Framework 6 和 Jakarta EE 9+ 规范,而 Springfox 2.9.2 发布于 2019 年,仅支持 Spring Boot 2.x(最高兼容至 2.2.x)。其核心依赖 spring-plugin-core:1.2.0.RELEASE 内部硬编码引用了已被 Spring Framework 6 移除的 org.springframework.util.comparator.InvertibleComparator 类——这正是您日志中 Caused by: java.lang.NoClassDefFoundError: org/springframework/util/comparator/InvertibleComparator 的根本原因。强行降级 Spring Boot 版本或尝试“修复” Springfox 不仅违背技术演进方向,更会引入安全风险与维护隐患。

✅ 正确解法:弃用 Springfox,采用官方推荐的 Springdoc OpenAPI

Springdoc 是当前 Spring 生态中事实标准的 OpenAPI 3 文档引擎,原生支持 Spring Boot 3、Jakarta EE、Reactive Web(WebFlux)、Spring Security 等,并提供零配置启动、注解驱动、UI 自动集成等特性。

✅ 迁移步骤(三步完成)

1. 移除 Springfox 依赖(关键!)

在 pom.xml 中彻底删除以下两行:

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

2. 引入 Springdoc OpenAPI(Starter 方式)

添加最新稳定版依赖(截至 2024 年,推荐 2.3.0+):

<!-- Springdoc OpenAPI UI (Swagger UI) -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
    <version>2.3.0</version>
</dependency>
<!-- 可选:如需 Swagger UI 页面(默认启用) -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.3.0</version>
</dependency>

? 提示:springdoc-openapi-starter-webmvc-api 是核心模块;-ui 模块自动提供 /swagger-ui.html 和 /swagger-ui/index.html 访问入口(Spring Boot 3 默认路径已更新为后者)。

3. 零配置启动(无需 Java 配置类)

Springdoc 在 Spring Boot 3 中开箱即用。启动应用后,直接访问:

  • ? Swagger UI: http://localhost:8080/swagger-ui/index.html
  • ? OpenAPI JSON: http://localhost:8080/v3/api-docs

如需自定义(如标题、版本、分组),可添加 application.yml 配置:

springdoc:
  api-docs:
    path: /v3/api-docs
  swagger-ui:
    path: /swagger-ui.html
    operations-sorter: method
  default-produces-media-type: application/json
  default-consumes-media-type: application/json

info:
  app:
    name: Bookstore Manager API
    description: RESTful API for managing bookstore resources
    version: 1.0.0

⚠️ 注意事项与常见问题

  • 勿混用 Springfox 与 Springdoc:残留的 Springfox 注解(如 @Api, @ApiOperation)将被忽略;请改用 Springdoc 兼容的 @Tag, @Operation, @Parameter 等 Jakarta 注解(位于 org.springdoc.core.annotations 包下)。
  • Lombok 兼容性:Springdoc 完美支持 Lombok(@Data, @Builder 等),无需额外配置。
  • Security 集成:若使用 Spring Security,需放行 Swagger 相关路径:
    @Configuration
    public class SecurityConfig {
        @Bean
        public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
            http.authorizeHttpRequests(auth -> auth
                .requestMatchers("/swagger-ui/**", "/v3/api-docs/**").permitAll()
                .anyRequest().authenticated()
            );
            return http.build();
        }
    }
  • 性能提示:Springdoc 默认启用缓存,生产环境无需额外优化;如需禁用(调试用),设 springdoc.cache.disabled=true。

✅ 总结

Springfox 已成为历史技术债,其与 Spring Boot 3 的不兼容是设计层面的断裂,而非配置疏漏。您遇到的 38 个嵌套 UnsatisfiedDependencyException,本质是 Spring Framework 6 类路径清理引发的连锁失败。拥抱 Springdoc 不仅解决当前问题,更确保项目长期可维护性、安全性与生态一致性。 迁移成本极低(仅修改依赖 + 删除旧配置),且文档质量、响应速度与社区支持均显著优于 Springfox。立即行动,让您的 Bookstore Manager 项目回归现代 Spring 开发正轨。

以上就是本文的全部内容了,是否有顺利帮助你解决问题?若是能给你带来学习上的帮助,请大家多多支持golang学习网!更多关于文章的相关知识,也可关注golang学习网公众号。

京东2025双11满减攻略及红包领取方法京东2025双11满减攻略及红包领取方法
上一篇
京东2025双11满减攻略及红包领取方法
Excel横转竖方法详解
下一篇
Excel横转竖方法详解
查看更多
最新文章
资料下载
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    4156次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    4508次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    4389次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    6002次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    4760次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码