欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Spring集成Swagger常见错误及解决办法

程序员文章站 2022-08-26 22:28:57
概览在当下几乎所有的公司都采用了前后端分离的开发模式,swagger作为了在api在线文档工具,几乎是后端开发的必备组件,最近公司的有个项目,在项目启动和打开swagger页面时候,后端产生了大量的异...

概览

在当下几乎所有的公司都采用了前后端分离的开发模式,swagger作为了在api在线文档工具,几乎是后端开发的必备组件,最近公司的有个项目,在项目启动和打开swagger页面时候,后端产生了大量的异常日志,虽然不影响现在的正常启动,不过,每次看到大量的异常日志,对于有代码洁癖的我,不能忍。于是乎今天抽了个时间把以下这些问题解决了,解决后再看日志,简直不能再爽歪歪啦~ 下面对问题以及解决的办法做个记录。

问题一

异常描述:no enum constant org.springframework.web.bind.annotation.requestmethod.get

项目启动的时候,后台日志报如下异常:

Spring集成Swagger常见错误及解决办法

原因

根据异常栈,能看出是springfox-swagger-common执行operationhttpmethodreader.apply()方法是抛出来的,分析日志 requestmethod.get 没有对应的enum,通过检查controller中requestmethod,发现了问题所在:

Spring集成Swagger常见错误及解决办法

枚举类中method方法都是大写, 而我的代码中将method写成了:

Spring集成Swagger常见错误及解决办法

导致了在获取enum类型的时候,匹配不上抛出异常。

解决办法

将httpmethod = "get" 给成 "get"即可。其实原来就很好奇为什么httpmethod后添加的方法名称是大写,当时也没有深入的去研究,正好借此机会知道背后的原因,这样在开发过程中才能避免很多坑~~

问题二

异常描述:java.lang.numberformatexception:for input string:""

项目起来后,访问swagger-ui.html页面后,接口文档可以正常展示和使用,不过后台会出现异常的日志:

Spring集成Swagger常见错误及解决办法

原因

看日志,swagger-models这个包中的abstractserializableparameter.getexample()方法的时候出现异常了,此外还有一条warn日志,illegal defaultvalue null for parameter type integer,意思是:有个默认值是空字符串的变量转换成integer类型时异常。

通过全局检索:illegal defaultvalue,查看如下:

Spring集成Swagger常见错误及解决办法

发现example只判断的null这种情况,当example如果为空字符串的话,照样往下执行,long.valueof(example)就是抛出异常,奔溃的心,好想把他的源码改掉呀~

解决办法

分析了下maven的包依赖:

Spring集成Swagger常见错误及解决办法

发现swagger-models的版本为 1.5.20,果断去mvnrepository上去寻找有么有新的包修复过这个bug:

Spring集成Swagger常见错误及解决办法

发现最新的版本 1.6.2,果断换成最新版本:

<dependency>
    <groupid>io.springfox</groupid>
    <artifactid>springfox-boot-starter</artifactid>
    <exclusions>
        <exclusion>
            <groupid>io.swagger</groupid>
            <artifactid>swagger-models</artifactid>
        </exclusion>
    </exclusions>
</dependency>

<!-- 解决 illegal defaultvalue null for parameter type integer -->
<dependency>
    <groupid>io.swagger</groupid>
    <artifactid>swagger-models</artifactid>
    <version>1.6.2</version>
</dependency>

看下源码:

Spring集成Swagger常见错误及解决办法

发现这个bug已经修复啦,哈哈哈哈

以上就是spring集成swagger常见错误及解决办法的详细内容,更多关于spring集成swagger常见错误的资料请关注其它相关文章!

相关标签: Spring Swagger