自定义SpringBootSwagger中ApiModel默

　　前言
　　项目使用的springfoxswagger22。9。2版本
　　在Spring中集成swagger文档功能，需要通过ApiModel注解修饰出入参的类，但是如果有两个不同包下的相同名称的类都使用了ApiModel注解时，会导致文档被覆盖，例如：com。example。demo。login。dto。UserDTOpackagecom。example。demo。login。DataApiModelpublicclassUserDTO｛ApiModelProperty（姓名）privateSApiModelProperty（年龄）privateI｝com。example。demo。vip。dto。UserDTOpackagecom。example。demo。vip。DataApiModelpublicclassUserDTO｛ApiModelProperty（姓名）privateSApiModelProperty（会员级别）privateIntegervipL｝
　　上面两个类生成出来的文档会变成一个swaggermodel：
　　从而导致接口文档显示错误：
　　解决冲突修改ApiModel注解（推荐）
　　通过修改ApiModel的value属性，来规避同名冲突，修改之后为：packagecom。example。demo。login。DataApiModel（loginUserDTO）publicclassUserDTO｛｝packagecom。example。demo。vip。DataApiModel（vipUserDTO）publicclassUserDTO｛｝
　　可以看到生成了两个swaggermodel：
　　修改类名
　　把两个类名做修改，让类名不冲突即可。自定义swagger插件
　　然而上面解决冲突的方式还是太麻烦了，定义一个文档的出入参类而已，还要考虑类重名的问题，这种增加心智负担和工作量的问题应该要尽量避免掉的，我在想有没有可能做到每个类上只需要加上ApiModel注解就行，剩下的冲突问题全部不用考虑。
　　于是乎通过跟踪源码，找到了swaggermodel名称生成的地方，详见：github
　　可以看到取名的逻辑是，优先取ApiModel的value值，如果没有就会使用defaultTypeName，跟进去一看，defaultTypeName是直接取类的简称，代码如下：
　　正是因为默认情况下取类的简称，导致不同包名下的同名类生成出来的swaggermodel被覆盖。原因已经分析出来了，接下来其实就是看看能不能定制化这个super。nameFor（type）方法了，然而很遗憾这个方法是写死的，没地方下手，但是ApiModelTypeNameProvider这个类上两个注解Component和Order已经明示了这个是一个Springbean，并且是通过Spring插件机制进行加载的，所以可以自定义一个插件来完成，在默认时通过完整的类路径和类名来生成唯一的swaggermodel，代码如下：ComponentOrder（SwaggerPluginSupport。SWAGGERPLUGINORDER100）publicclassFullPathTypeNameProviderextendsDefaultTypeNameProvider｛publicstaticfinalStringSPLITCHAR34；；OverridepublicStringnameFor（C？type）｛ApiModelannotationAnnotationUtils。findAnnotation（type，ApiModel。class）；if（annotationnull）｛returnsuper。nameFor（type）；｝if（StringUtils。hasText（annotation。value（）））｛returnannotation。value（）；｝如果ApiModel的value为空，则默认取完整类路径intpackagePathLengthtype。getPackage（）。getName（）。length（）；returnStream。of（type。getPackage（）。getName（）。split（。））。map（pathpath。substring（0，1））。collect（Collectors。joining（SPLITCHAR））SPLITCHARtype。getName（）。substring（packagePathLength1）；｝｝
　　效果如下：
　　后记
　　通过这一个小小的优化，就可以减少许多团队中不必要的沟通成本，让我们能更专注于业务开发。
　　本文首发于我的博客：https：monkeywie。cn，欢迎收藏！不定期分享JAVA、Golang、前端、docker、k8s等干货知识。