自定义SpringBoot+Swagger中@ApiModel默认名称
前言
项目使用的
springfox-swagger2@2.9.2
版本
在 Spring 中集成 swagger 文档功能,需要通过@ApiModel
注解修饰出入参的类,但是如果有两个不同包下的相同名称的类都使用了@ApiModel
注解时,会导致文档被覆盖,例如:- com.example.demo.login.dto.UserDTO
package com.example.demo.login.dto;
@Data
@ApiModel
public class UserDTO{
@ApiModelProperty("姓名")
private String name;
@ApiModelProperty("年龄")
private Integer age;
}
- com.example.demo.vip.dto.UserDTO
package com.example.demo.vip.dto;
@Data
@ApiModel
public class UserDTO{
@ApiModelProperty("姓名")
private String name;
@ApiModelProperty("会员级别")
private Integer vipLevel;
}
上面两个类生成出来的文档会变成一个
swagger model
:![自定义SpringBoot+Swagger中@ApiModel默认名称](https://img.it610.com/image/info9/099de2e97af14ed68fafbd80d65e8ddf.png)
文章图片
从而导致接口文档显示错误:
![自定义SpringBoot+Swagger中@ApiModel默认名称](https://img.it610.com/image/info9/b8caae1e13a848f1b16522c290ff8883.jpg)
文章图片
解决冲突 修改@ApiModel 注解(推荐)
通过修改@ApiModel 的 value 属性,来规避同名冲突,修改之后为:
package com.example.demo.login.dto;
@Data
@ApiModel("login$UserDTO")
public class UserDTO{}
package com.example.demo.vip.dto;
@Data
@ApiModel("vip$UserDTO")
public class UserDTO{}
可以看到生成了两个
swagger model
:![自定义SpringBoot+Swagger中@ApiModel默认名称](https://img.it610.com/image/info9/2333430ff2674e269588b0968d9fa568.jpg)
文章图片
修改类名
【自定义SpringBoot+Swagger中@ApiModel默认名称】把两个类名做修改,让类名不冲突即可。
自定义 swagger 插件 然而上面解决冲突的方式还是太麻烦了,定义一个文档的出入参类而已,还要考虑类重名的问题,这种增加心智负担和工作量的问题应该要尽量避免掉的,我在想有没有可能做到每个类上只需要加上
@ApiModel
注解就行,剩下的冲突问题全部不用考虑。于是乎通过跟踪源码,找到了
swagger model
名称生成的地方,详见:github![自定义SpringBoot+Swagger中@ApiModel默认名称](https://img.it610.com/image/info9/7325e085d667473e815c6feb699ba578.jpg)
文章图片
可以看到取名的逻辑是,优先取
@ApiModel
的value
值,如果没有就会使用defaultTypeName
,跟进去一看,defaultTypeName
是直接取类的简称
,代码如下:![自定义SpringBoot+Swagger中@ApiModel默认名称](https://img.it610.com/image/info9/bcbfd1d0020a48ca9d222ece829c342b.jpg)
文章图片
正是因为默认情况下取类的
简称
,导致不同包名下的同名类生成出来的swagger model
被覆盖。原因已经分析出来了,接下来其实就是看看能不能定制化这个
super.nameFor(type)
方法了,然而很遗憾这个方法是写死的,没地方下手,但是ApiModelTypeNameProvider
这个类上两个注解@Component
和@Order
已经明示了这个是一个Spring bean
,并且是通过Spring插件机制进行加载的
,所以可以自定义一个插件来完成,在默认时通过完整的类路径和类名来生成唯一的swagger model
,代码如下:@Component
@Order(SwaggerPluginSupport.SWAGGER_PLUGIN_ORDER - 100)
public class FullPathTypeNameProvider extends DefaultTypeNameProvider {public static final String SPLIT_CHAR = "$";
@Override
public String nameFor(Class> type) {
ApiModel annotation = AnnotationUtils.findAnnotation(type, ApiModel.class);
if (annotation == null) {
return super.nameFor(type);
}
if (StringUtils.hasText(annotation.value())) {
return annotation.value();
}
// 如果@ApiModel的value为空,则默认取完整类路径
int packagePathLength = type.getPackage().getName().length();
return Stream.of(type.getPackage().getName().split("\\."))
.map(path -> path.substring(0, 1))
.collect(Collectors.joining(SPLIT_CHAR))
+ SPLIT_CHAR
+ type.getName().substring(packagePathLength + 1);
}}
效果如下:
![自定义SpringBoot+Swagger中@ApiModel默认名称](https://img.it610.com/image/info9/7c0f2a12a7ad4ea2b1b533cf8318f7ea.jpg)
文章图片
后记 通过这一个小小的优化,就可以减少许多团队中不必要的沟通成本,让我们能更专注于业务开发。
我是 MonkeyWie,欢迎扫码关注!不定期在公众号中分享JAVA
、Golang
、前端
、docker
、k8s
等干货知识。
![自定义SpringBoot+Swagger中@ApiModel默认名称](https://img.it610.com/image/info9/a978ec554cac4639aacd632211e3c33e.jpg)
文章图片
推荐阅读
- 热闹中的孤独
- Shell-Bash变量与运算符
- JS中的各种宽高度定义及其应用
- 2021-02-17|2021-02-17 小儿按摩膻中穴-舒缓咳嗽
- 深入理解Go之generate
- 异地恋中,逐渐适应一个人到底意味着什么()
- 我眼中的佛系经纪人
- 《魔法科高中的劣等生》第26卷(Invasion篇)发售
- “成长”读书社群招募
- 2020-04-07vue中Axios的封装和API接口的管理