springboot升级到3.5.x后knife4j文档无法识别问题及解决过程
作者:咚咚阳丶
在将Spring Boot从3.3.x升级到3.5.x后,访问接口文档页面时出现错误,原因是knife4j 4.5.0中使用的springdoc-openapi-starter-webmvc-ui版本过低,通过手动替换该依赖并关闭文档增强功能,问题得以解决
一、问题描述
将springboot从3.3.x版本升级到3.5.x后,访问xxx/doc.htm时原来的接口文档不显示了,同时控制台报错
jakarta.servlet.ServletException: Handler dispatch failed: java.lang.NoSuchMethodError: 'void org.springframework.web.method.ControllerAdviceBean.<init>(java.lang.Object)'
二、原因分析
knife4j 4.5.0中的springdoc-openapi-starter-webmvc-ui版本过低
三、解决方案
由于knife4j 4.5.0已是目前最新版本,所以只能手动替换knife4j 中 springdoc-openapi-starter-webmvc-ui版本,先排除springdoc-openapi-starter-webmvc-ui依赖,再单独引入即可
替换前
<!--knife4j & SpringDoc -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
<version>4.5.0</version>
</dependency>
替换后
<!-- knife4j & SpringDoc -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
<version>4.5.0</version>
<exclusions>
<exclusion>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.8.13</version>
</dependency>注意:
还需要修改配置文件,关闭文档增强功能(knife4j.enable = false),这将会导致文档的用户名密码验证被绕过,如果开启文档增强功能的话,访问文档依然会报错,导致文档加载失败,如果不需要开启文档增强功能的话直接这样解决即可,需要进行密码验证的,这只是一个临时解决方案,可以在开发环境这样配置,正式环境依然开启文档增强,不使用线上文档即可,不会影响项目启动。最终还是希望官方早点更新新版本后进行升级。
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。
