快捷導(dǎo)航

Spring集成Swagger常見錯(cuò)誤及解決辦法

更新時(shí)間：2021年05月03日 10:09:30 作者：黑色的燈塔

這篇文章主要介紹了Spring集成Swagger常見錯(cuò)誤及解決辦法，幫助大家更好的理解和學(xué)習(xí)使用Spring，感興趣的朋友可以了解下

概覽

在當(dāng)下幾乎所有的公司都采用了前后端分離的開發(fā)模式，Swagger作為了在API在線文檔工具，幾乎是后端開發(fā)的必備組件，最近公司的有個(gè)項(xiàng)目，在項(xiàng)目啟動(dòng)和打開Swagger頁面時(shí)候，后端產(chǎn)生了大量的異常日志，雖然不影響現(xiàn)在的正常啟動(dòng)，不過，每次看到大量的異常日志，對(duì)于有代碼潔癖的我，不能忍。于是乎今天抽了個(gè)時(shí)間把以下這些問題解決了，解決后再看日志，簡(jiǎn)直不能再爽歪歪啦~ 下面對(duì)問題以及解決的辦法做個(gè)記錄。

問題一

異常描述：No enum constant org.springframework.web.bind.annotation.RequestMethod.Get

項(xiàng)目啟動(dòng)的時(shí)候，后臺(tái)日志報(bào)如下異常：

原因

根據(jù)異常棧，能看出是springfox-swagger-common執(zhí)行OperationHttpMethodReader.apply()方法是拋出來的，分析日志 RequestMethod.Get 沒有對(duì)應(yīng)的enum，通過檢查Controller中RequestMethod，發(fā)現(xiàn)了問題所在：

枚舉類中method方法都是大寫，而我的代碼中將method寫成了：

導(dǎo)致了在獲取enum類型的時(shí)候，匹配不上拋出異常。

解決辦法

將httpMethod = "Get" 給成 "GET"即可。其實(shí)原來就很好奇為什么httpMethod后添加的方法名稱是大寫，當(dāng)時(shí)也沒有深入的去研究，正好借此機(jī)會(huì)知道背后的原因，這樣在開發(fā)過程中才能避免很多坑~~

問題二

異常描述：java.lang.NumberFormatException:For input string:""

項(xiàng)目起來后，訪問swagger-ui.html頁面后，接口文檔可以正常展示和使用，不過后臺(tái)會(huì)出現(xiàn)異常的日志：

原因

看日志，swagger-models這個(gè)包中的AbstractSerializableParameter.getExample()方法的時(shí)候出現(xiàn)異常了，此外還有一條WARN日志，Illegal DefaultValue null for parameter type integer，意思是：有個(gè)默認(rèn)值是空字符串的變量轉(zhuǎn)換成Integer類型時(shí)異常。

通過全局檢索：Illegal DefaultValue，查看如下：

發(fā)現(xiàn)example只判斷的null這種情況，當(dāng)example如果為空字符串的話，照樣往下執(zhí)行，Long.valueOf(example)就是拋出異常，奔潰的心，好想把他的源碼改掉呀~

解決辦法

分析了下maven的包依賴：

發(fā)現(xiàn)swagger-models的版本為 1.5.20，果斷去mvnrepository上去尋找有么有新的包修復(fù)過這個(gè)bug：

發(fā)現(xiàn)最新的版本 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>

看下源碼：