脚本宝典收集整理的这篇文章主要介绍了魔改swagger:knife4j的另外一种打开方式,脚本宝典觉得挺不错的,现在分享给大家,也给大家做个参考。
之前公司使用了swagger作为文档管理工具,原生的swagger-ui非常丑,之后就用了开源项目 萧明 / knife4j 的swagger组件进行了swagger渲染,改造之后界面漂亮多了,操作也方便了很多。当然这不是重点,重点是我们项目引用了knife4j之后出现的一些问题:
有人在gateway处做了文档聚合,它的聚合模式如下图所示
它的原理很简单,就是将请求转发到微服务,从微服务的restful接口中获取swagger的json信息,然后通过前端将swagger信息渲染出来。这样做的好处就是只需要在网关处集成swagger-ui,其它微服务不需要再单独集成swagger-ui,只需要收集swagger信息然后暴露接口给gateway,等着gateway来取信息即可。但是它没有完全解决上面提到的问题,而且还引入了新的问题
针对这个问题,我想了想,使用另外一种方式尝试着进行改造。
好吧,这个名字我瞎起的。具体技术架构如下图所示
系统流程如下:
需要注意的是swagger注册中心只部署开发环境或者公司局域网环境,我们公司局域网能直接访问开发环境。
集中注册模式的代码设计如下,这里搞两个单独的项目
项目名 | 功能 |
---|---|
swagger-spring-boot-starter | 客户端组件,微服务客户端使用封装好的该组件扫描项目中的swagger信息并上传到swagger注册中心 |
swagger-register-server | swagger注册中心,它接收微服务客户端上传的swagger信息并保存到数据库。用户请求查看文档的时候直接从数据库中取swagger文档 |
在一切开始之前,需要了解下swagger-ui的实现原理
正如之前所说,swagger-spring-boot-starter是客户端组件,微服务客户端使用封装好的该组件扫描项目中的swagger信息并上传到swagger注册中心。
关键的技术点是如何手动扫描项目的swagger信息,只要能拿到swagger信息,无论使用什么方式上传到swagger注册中心都很简单了。关于这个技术点想了一会儿没想到好办法,只能去看源代码,看了一会儿觉得云里雾里的,最终突然灵光一闪,swagger-ui的实现给了我灵感。
swagger-ui会请求后端一个接口获取swagger文档:/v2/api-docs
,然后根据拿到的swagger文档渲染前端页面。在intelij下ctrl+shift+f组合键搜索该关键字很容易能够找到相关代码(springfox 2.9.2):
springfox.documentation.swagger2.web.Swagger2Controller#getDocumentation
这段代码详细讲解了如何获取Swagger对象,这给我的实现提供了很大的参考依据。
在通过网关聚合模式下查看swagger文档的时候,会发现前端会请求后端一个接口获取所有的group信息:/swagger-resources,老规矩,还是ctrl+shift+f快捷键全局查询,可以看到相关代码的实现
springfox.documentation.swagger.web.ApiResourceController#swaggerResources
可以看到,改接口仅仅是调用了swaggerResource的get方法,然后就直接返回了,那就再看看swaggerResource是什么东西
https://github.com/springfox/springfox/blob/master/springfox-swagger-common/src/main/java/springfox/documentation/swagger/web/SwaggerResourcesProvider.java
它只是个接口,那它的实现类呢,它的实现类只有一个,就是InMemorySwaggerResourcesProvider类
它的GET方法是这样子的
https://github.com/springfox/springfox/blob/master/springfox-swagger-common/src/main/java/springfox/documentation/swagger/web/InMemorySwaggerResourcesProvider.java#L86
看到这里我不禁陷入了思考,难道要给documentationCache手动填充文档。。但是看这个名字就知道是基于内存的东西,要维护CRUD状态似乎有点麻烦。。看看这个代码是咋写的
https://github.com/springfox/springfox/blob/master/springfox-spring-web/src/main/java/springfox/documentation/spring/web/DocumentationCache.java#L28
确实是基于内存的东西,但是值提供了add方法,没提供remove方法,那获取到documentionLookup对象之后手动移除呢?仔细看看all()方法
它被Collections工具类包装成了不可修改的了,那手动移除的方式就没戏了。
换一种思路,其实还有另外一种方法,重新实现SwaggerResourcesProvider接口,并将实现类使用@Primary注解修饰,覆盖默认的InMemorySwaggerResourcesProvider实现类,重写get()方法即可,那这时候的自由度就大了去了,这里可以直接使用从数据库读的方式获取所有的group。
/swagger-resources接口的返回值是List
https://github.com/springfox/springfox/blob/master/springfox-swagger-common/src/main/java/springfox/documentation/swagger/web/SwaggerResource.java
项目源代码:https://gitee.com/kdyzm/swagger-register-server
它是一个swagger注册中心,对swagger文档进行持久化并进行CRUD操作,最终在knife4j中展示。它应当包含如下功能
设计上,用两张表分别存储group信息和文档详情信息
CREATE TABLE `group_info` (
`id` int(11) NOT NULL AUTO_INCREMENT COMMENT '自增主键',
`name` varchar(64) NOT NULL COMMENT 'groupName',
`location` varchar(128) NOT NULL COMMENT 'location',
`version` varchar(16) NOT NULL COMMENT 'version',
`url` varchar(128) NOT NULL COMMENT 'url',
`app_name` varchar(64) DEFAULT NULL COMMENT '服务名(spring.application.name)',
`gateway` varchar(64) DEFAULT NULL COMMENT '网关,无则不填',
PRIMARY KEY (`id`),
UNIQUE KEY `group_info_name` (`name`) COMMENT 'group name唯一',
UNIQUE KEY `group_info_app_name` (`app_name`) COMMENT 'appname唯一'
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
CREATE TABLE `swagger_json` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`group_name` varchar(64) NOT NULL,
`content` longtext NOT NULL COMMENT 'swagger具体信息',
PRIMARY KEY (`id`),
UNIQUE KEY `swagger_json_groupname` (`group_name`) COMMENT 'groupName唯一'
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
group_info表用于存储swagger的group信息,/swagger-resources接口将会从该表中取group数据
swagger_json表用于存储swagger的原始信息,用于文档渲染。
https://gitee.com/kdyzm/swagger-register-server/blob/master/src/main/java/com/kdyzm/swagger/register/server/controller/SwaggerRegisterController.java#L35
对应以上两个表,注册接口有两个实体类。注册逻辑是:存在则更新,不存在就新增,groupName和appName都要保持唯一。
https://gitee.com/kdyzm/swagger-register-server/blob/master/src/main/java/com/kdyzm/swagger/register/server/controller/SwaggerRegisterController.java#L61
默认值是/v2/api-docs,但是可以自定义,这里要求客户端在注册的时候就约定好接口路径是/swagger/detail
该接口从数据库中获取swagger信息。
从之前的/swagger-resources源码分析过,想要从数据库自定义获取group列表,就需要重新实现SwaggerResourcesProvider 接口并且标记为@Primary
https://gitee.com/kdyzm/swagger-register-server/blob/master/src/main/java/com/kdyzm/swagger/register/server/config/DocumentationConfig.java
设计上,要求做到微服务客户端只需要引入组件jar包,然后配置文件配置一些swagger的基本信息,服务启动之后就能自动上传swagger文档到swagger注册中心,具体技术细节,应当包含如下功能
/v2/api-docs
一样上面分析过/v2/api-docs的实现原理,利用它的实现原理,可以轻松获取到Swagger对象
https://gitee.com/kdyzm/swagger-spring-boot-starter/blob/master/src/main/java/com/kdyzm/swagger/spring/mvc/SwaggerMvcGenerator.java#L35
上传的话,根据配置文件中是否配置serverUrl决定采用服务发现方式还是直接请求方式上传Swagger信息
https://gitee.com/kdyzm/swagger-spring-boot-starter/blob/master/src/main/java/com/kdyzm/swagger/spring/mvc/SwaggerRegistryService.java#L50
这个非常简单,在resources/META-INF目录下新建文件
https://gitee.com/kdyzm/swagger-spring-boot-starter/blob/master/src/main/resources/META-INF/spring.factories
并配置好即可。
swagger-spring-boot-starter不依赖nacos client或者eurka client,而是依赖了它们的公共接口模块spring-cloud-commons,实际上nacos client或者eureka client均是该模块的具体实现,所以swagger-spring-boot-starter可以兼容两种客户端服务发现组件的实现,但是服务端因为具体依赖了某种服务发现组件,在我这里默认使用nacos,如果要用eureka需要自行改造。
这篇文章介绍的两个项目的源代码地址:
项目名称 | 项目地址 |
---|---|
swagger-register-server | https://gitee.com/kdyzm/swagger-register-server |
swagger-spring-boot-starter | https://gitee.com/kdyzm/swagger-spring-boot-starter |
该项目启动需要连接mysql数据库以及nacos。
准备好外部依赖之后,执行sql文件夹中的sql文件,最后启动项目即可,启动成功之后,访问项目的/doc.html,即可看到knife4j的文档页面。
这里我提供了线上部署好的版本:http://swagger.kdyzm.cn
上一步启动好了swagger-register-server,接下来需要打包swagger-spring-boot-starter已提供微服务客户端使用。
因为这里并没有上传maven中央仓库,所以有条件的可以上传nexus私服,没条件的可以直接运行命令mvn clean install
将jar包安装到本地maven仓库以便使用。
可以使用intelij自带的工具初始化一个spring boot的项目,这里使用了2.3.4.REALEASE版本的springboot版本号(经过测试发现,nacos版本号过高会导致服务发现功能故障,版本号低一些程序功能会更稳定)。
利用intilij自带的spring initiallizer工具可以很方便的快速搭建起来web开发框架。写完Controller接口之后,开始整合swagger-spring-boot-starter,测试项目地址源代码:https://gitee.com/kdyzm/swagger-spring-boot-starter-test
<!-- swagger功能组件 -->
<dependency>
<groupid>com.kdyzm</groupid>
<artifactid>swagger-spring-boot-starter</artifactid>
<version>1.0-SNAPSHOT</version>
</dependency>
在配置文件中新增配置
swagger:
config:
#每个人只关心自己的包名,方便和前端文档对接
base-package: com.kdyzm.swagger.test
description: swagger测试项目
group:
#swagger注册唯一标识,每个人都要不一样
appName: ${spring.application.name}
name: swagger测试项目
api:
title: swagger测试项目
contactName: kdyzm@foxmail.com
#swagger注册中心地址,指定了server-url就优先使用该地址注册swagger文档信息;未指定则顺延使用服务发现模式
server-url: http://swagger.kdyzm.cn
#swgger注册中心serviceId,即servername,用于服务发现模式
service-id: swagger-register-server
只是做了前两步,不会对项目产生任何影响,也不会产生swagger文档,必须激活swagger profile才会生效
项目启动之后如果没有任何报错,打开文档地址:http://swagger.kdyzm.cn/doc.html 查看文档上传效果。
还有swagger注册中心地址
服务名字 | 域名 | 访问地址 |
---|---|---|
nacos地址 | nacos.kdyzm.cn | http://nacos.kdyzm.cn/nacos (不提供管理端账号密码) |
eureka地址 | eureka.kdyzm.cn | http://eureka.kdyzm.cn (无需账号密码访问) |
swagger注册中心地址 | swagger.kdyzm.cn | http://swagger.kdyzm.cn/doc.html (无需账号密码访问) |
由于受限于资源和网络带宽,访问速度会比较慢;请善待公共资源,不要对它们进行压测和其它非正常操作。
配置文件中有个配置项:swagger.config.server-url ,若该配置项不为空,则走直连模式,即不通过服务发现直接请求该server-url上传swagger文档;
如果未配置该配置项,则检查swagger.config.service-id字段,如果该字段也没有配置值,则报错并跳过swagger文档上传。
为了能在分组里唯一区分,必须要将appName和name保持唯一,而且现在上传文档之后不支持删除,如果误上传到了swagger.kdyzm.cn,发邮件给我我来删除,我的邮箱地址:kdyzm@foxmail.com
原本分了两个单独的项目,维护起来不是很方便
项目名称 | 项目地址 |
---|---|
swagger-register-server | https://gitee.com/kdyzm/swagger-register-server |
swagger-spring-boot-starter | https://gitee.com/kdyzm/swagger-spring-boot-starter |
所以现在再加上实战案例放到同一个项目中进行管理。
三合一项目地址:
项目 | 地址 |
---|---|
gitee地址 | https://gitee.com/kdyzm/swagger-knife4j-spring-boot-starter |
github地址 | https://github.com/kdyzm/swagger-knife4j-spring-boot-starter |
以后的更新均会放到该项目中进行。
https://blog.kdyzm.cn/post/92
欢迎大家收藏访问~
以上是脚本宝典为你收集整理的魔改swagger:knife4j的另外一种打开方式全部内容,希望文章能够帮你解决魔改swagger:knife4j的另外一种打开方式所遇到的问题。
本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。