Swagger异常：AbstractSerializableParameter : Illegal DefaultValue null for parameter type integer解决方案

野性酷女 2022-05-13 15:00 250阅读 0赞

### 文章目录 ###

*   *  出现问题
     *  问题原因
     *  解决方案

## 出现问题 ##

项目中使用Swagger作为文档工具，每次打开文档时，控制台都会打印出如下异常。

2018-10-24 23:03:36.537  WARN 19699 --- [nio-1111-exec-4] i.s.m.p.AbstractSerializableParameter    : Illegal DefaultValue null for parameter type integer
    
    java.lang.NumberFormatException: For input string: ""
    	at java.lang.NumberFormatException.forInputString(NumberFormatException.java:65) ~[na:1.8.0_171]
    	at java.lang.Long.parseLong(Long.java:601) ~[na:1.8.0_171]
    	at java.lang.Long.valueOf(Long.java:803) ~[na:1.8.0_171]
    	at io.swagger.models.parameters.AbstractSerializableParameter.getExample(AbstractSerializableParameter.java:412) ~[swagger-models-1.5.20.jar:1.5.20]
    	at sun.reflect.GeneratedMethodAccessor109.invoke(Unknown Source) ~[na:na]
    	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[na:1.8.0_171]
    	at java.lang.reflect.Method.invoke(Method.java:498) ~[na:1.8.0_171]
    	at com.fasterxml.jackson.databind.ser.BeanPropertyWriter.serializeAsField(BeanPropertyWriter.java:687) [jackson-databind-2.9.6.jar:2.9.6]

## 问题原因 ##

这是由于实体类使用`@ApiModelProperty`时，`example`属性没有赋值导致的，在`AbstractSerializableParameter`的getExample方法中会将数值属性的example的转换数值类返回，example的默认值是""，因此当example没有赋值时，会出现上面的异常。getExample方法如下

@JsonProperty("x-example")
        public Object getExample() { 
            if (example == null) { 
                return null;
            }
            try { 
                if (BaseIntegerProperty.TYPE.equals(type)) { 
                    return Long.valueOf(example);
                } else if (DecimalProperty.TYPE.equals(type)) { 
                    return Double.valueOf(example);
                } else if (BooleanProperty.TYPE.equals(type)) { 
                    if ("true".equalsIgnoreCase(example) || "false".equalsIgnoreCase(defaultValue)) { 
                        return Boolean.valueOf(example);
                    }
                }
            } catch (NumberFormatException e) { 
                LOGGER.warn(String.format("Illegal DefaultValue %s for parameter type %s", defaultValue, type), e);
            }
            return example;
        }

## 解决方案 ##

只要将每一个数值类型上`@ApiModelProperty`的example都赋值数字字符串即可。

但是这个解决方法比较麻烦，若将源码中的`if (example == null)`改为`if (example == null || example.isEmpty())`就可以解决问题。我下载并修改了源码，将其打包后覆盖了maven仓库的jar包，这样项目代码不需要任何修改就可以解决问题。

同时，我又查看了v1.5.21的代码 ，源码的修改是一样的。其实也可以排除1.5.20版本的swagger-models.jar，引入1.5.21版本的swagger-models.jar。但是考虑到可能由于代码改动较大引发其他问题，因此个人感觉还是在1.5.20版本代码微调最好。

最后把修复过的jar包下载链接放在这里，下载后替换本地仓库对应的文件，然后项目重新导入jar包即可。

例如，我的电脑，通过命令行进入如下目录  
`cd /Users/ly/.m2/repository/io/swagger/swagger-models/1.5.20/`  
然后将两个文件复制进去覆盖原文件。

[https://github.com/ly641921791/knowledge/raw/master/swagger/fix-jar/swagger-models-1.5.20.jar][https_github.com_ly641921791_knowledge_raw_master_swagger_fix-jar_swagger-models-1.5.20.jar]  
[https://github.com/ly641921791/knowledge/raw/master/swagger/fix-jar/swagger-models-1.5.20-sources.jar][https_github.com_ly641921791_knowledge_raw_master_swagger_fix-jar_swagger-models-1.5.20-sources.jar]

[https_github.com_ly641921791_knowledge_raw_master_swagger_fix-jar_swagger-models-1.5.20.jar]: https://github.com/ly641921791/knowledge/raw/master/swagger/fix-jar/swagger-models-1.5.20.jar
[https_github.com_ly641921791_knowledge_raw_master_swagger_fix-jar_swagger-models-1.5.20-sources.jar]: https://github.com/ly641921791/knowledge/raw/master/swagger/fix-jar/swagger-models-1.5.20-sources.jar