项目使用的springfox-swagger2@2.9.2
版本
在 Spring 中集成 swagger 文档功能,需要通过@ApiModel
注解修饰出入参的类,但是如果有两个不同包下的相同名称的类都使用了@ApiModel
注解时,会导致文档被覆盖,例如:
package com.example.demo.login.dto;
@Data
@ApiModel
public class UserDTO{
@ApiModelProperty("姓名")
private String name;
@ApiModelProperty("年龄")
private Integer age;
}
package com.example.demo.vip.dto;
@Data
@ApiModel
public class UserDTO{
@ApiModelProperty("姓名")
private String name;
@ApiModelProperty("会员级别")
private Integer vipLevel;
}
上面两个类生成出来的文档会变成一个swagger model
:
通过修改@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
:
把两个类名做修改,让类名不冲突即可。
然而上面解决冲突的方式还是太麻烦了,定义一个文档的出入参类而已,还要考虑类重名的问题,这种增加心智负担和工作量的问题应该要尽量避免掉的,我在想有没有可能做到每个类上只需要加上@ApiModel
注解就行,剩下的冲突问题全部不用考虑。
于是乎通过跟踪源码,找到了swagger model
名称生成的地方,详见:github
可以看到取名的逻辑是,优先取@ApiModel
的value
值,如果没有就会使用defaultTypeName
,跟进去一看,defaultTypeName
是直接取类的简称
,代码如下:
正是因为默认情况下取类的简称
,导致不同包名下的同名类生成出来的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);
}
}
效果如下:
通过这一个小小的优化,就可以减少许多团队中不必要的沟通成本,让我们能更专注于业务开发。
我是MonkeyWie,欢迎扫码????关注!不定期在公众号中分享JAVA
、Golang
、前端
、docker
、k8s
等干货知识。
作者 / Krish Vitaldevara,Google Play 信任与安全产品管理总监 多年来,向数十...
背景 京东购物小程序作为京东小程序业务流量的主要入口,承载着许多的活动和页面...
CSS3实现酷炫的3D旋转透视 3D动画效果现在越来越普及,已经被广泛的应用到了各个...
在讲CSS优先级之前,我们得要了解什么是CSS,CSS是用来做什么的。 首先,我们对C...
行高line-height实现单行文本垂直居中 以前一直认为单行文本垂直居中要将高度和...
Dreamweaver中如何使用Flash影片 1、首先需要我们准备的是一个Flash文件,其次最...
在ie下设置 css 样式 style="cursor:hand;" 可以正常显示 但是在firefox下就不行...
打开软件,我们按快捷键ctrl+n,建立一个新的文件。 点击常用,选择布局。 点击...
一、作用 离线浏览 - 根据文件规则把资源缓存在本地,脱机依然能够访问资源,联...
最近在做项目时,发现CSS3中关于动画的技术,自己很少运用在项目中,平时一些列...