网站备案个人和企业的区别,网站免费建站广告机,菏泽网站制建设哪家好,网页界面模板设计swagger是一个API框架#xff0c;号称世界上最流行的API工具。它提供了API管理的全套解决方案#xff0c;比如API在线编辑器#xff0c;API UI展示界面#xff0c;代码生成器等诸多功能。如果想引入swagger进行API管理。目前 springfox 是一个很好的选择#xff0c;它内部…swagger是一个API框架号称世界上最流行的API工具。它提供了API管理的全套解决方案比如API在线编辑器API UI展示界面代码生成器等诸多功能。如果想引入swagger进行API管理。目前 springfox 是一个很好的选择它内部会自动解析Spring容器中Controller暴露出的接口并且也提供了一个界面用于展示或调用这些API。下图就是简单的一个使用springfox的API展示界面。springfox的前身是swagger-springmvc用于springmvc与swagger的整合。如若在springboot项目中使用springfox需要3个步骤1、maven添加springfox依赖2、启动类加上EnableSwagger2注解3、构造Docket bean用于展示API配置完之后进入 http://{path}:{port}/swagger-ui.html 即可查看controller中的接口信息并按照Docket中配置的规则进行展示。springfox实现原理在分析springfox实现原理之前首先看下springfox对文档Documentation的定义文档Documentation定义得很清晰主要由groupName(分组名)、basePath(contextPath)、apiListings(API列表集)、resourceListing(资源列表集)等属性组成。其中API列表被封装成ApiListing。ApiListing中又持有ApiDesciption集合引用每个ApiDesciption都持有一个API集合的引用Operation也就是具体的接口操作内部包含了该接口对应的http方法、produces、consumes、协议、参数集、响应消息集等诸多元素。springfox通过spring-plugin的方式将Plugin注册到Spring上下文中然后使用这些plugin进行API的扫描工作这里的扫描工作其实也就是构造Documentation的工作把扫描出的结果封装成Documentation并放入到DocumentationCache内存缓存中之后swagger-ui界面展示的API信息通过Swagger2Controller暴露Swagger2Controller内部直接从DocumentationCache中寻找Documentation。下图就是部分Plugin具体构造对应的文档信息代码细节方面的分析很明显入口处在EnableSwagger2注解上该注解会import一个配置类Swagger2DocumentationConfiguration。Swagger2DocumentationConfiguration做的事情1、构造Bean。比如HandlerMappingHandlerMapping是springmvc中用于处理请求与handler(controller中的方法)之间映射关系的接口springboot中默认使用的HandlerMapping是RequestMappingHandlerMappingSwagger2DocumentationConfiguration配置类里构造的是PropertySourcedRequestMappingHandlerMapping该类继承RequestMappingHandlerMapping。2、import其它配置类比如SpringfoxWebMvcConfiguration、SwaggerCommonConfiguration3、扫描指定包下的类并注册到Spring上下文中SpringfoxWebMvcConfiguration配置类做的事情跟Swagger2DocumentationConfiguration类似不过多了一步构造PluginRegistry过程。该过程使用EnablePluginRegistries注解实现EnablePluginRegistries注解是spring-plugin模块提供的一个基于Plugin类型注册PluginRegistry实例到Spring上下文的注解。EnablePluginRegistries注解内部使用PluginRegistriesBeanDefinitionRegistrar注册器去获取注解的value属性(类型为Plugin接口的Class数组)然后遍历这个Plugin数组针对每个Plugin在Spring上下文中注册PluginRegistryFactoryBean并设置相应的name和属性。如果处理的Plugin有Qualifier注解那么这个要注册的PluginRegistryFactoryBean的name就是Qualifier注解的value否则name就是插件名首字母小写Registry的格式(比如DocumentationPlugin对应构造的bean的name就是documentationPluginRegistry)。PluginRegistriesBeanDefinitionRegistrar注册器处理过程PluginRegistryFactoryBean是一个FactoryBean其内部真正构造的bean的类型是OrderAwarePluginRegistry。OrderAwarePluginRegistry实例化过程中会调用create静态方法传入的plugin集合使用aop代理生成一个ArrayList这个list中的元素就是Spring上下文中所有的类型为之前遍历的Plugin的bean。PluginRegistryFactoryBean的getObject方法这里的targetSource是在PluginRegistryFactoryBean的父类AbstractTypeAwareSupport(实现了InitializingBean接口)中的afterPropertiesSet方法中初始化的(type属性在PluginRegistriesBeanDefinitionRegistrar注册器中已经设置为遍历的Plugin)BeansOfTypeTargetSource的getTarget方法举个例子比如SpringfoxWebMvcConfiguration中的EnablePluginRegistries注解里的DocumentationPlugin这个Plugin在处理过程中会找出Spring上下文中所有的Docket(Docket实现了DocumentationPlugin接口)并把该集合设置成name为documentationPluginRegistry、类型为OrderAwarePluginRegistry的bean注册到Spring上下文中。DocumentationPluginsManager类会在之前提到过的配置类中被扫描出来它内部的各个pluginRegistry属性都是EnablePluginRegistries注解内部构造的各种pluginRegistry实例DocumentationPluginsBootstrapper启动类也会在之前提供的配置类中被扫描出来。它实现了SmartLifecycle接口在start方法中会获取之前初始化的所有documentationPlugins(也就是Spring上下文中的所有Docket)。遍历这些Docket并进行scan扫描(使用RequestMappingHandlerMapping的getHandlerMethods方法获取url与方法的所有映射关系然后进行一系列API解析操作)扫描出来的结果封装成Documentation并添加到DocumentationCache中以上就是API解析、扫描的大致处理过程整理如下下面分析一下HandlerMapping的处理过程。PropertySourcedRequestMappingHandlerMapping在Swagger2DocumentationConfiguration配置类中被构造PropertySourcedRequestMappingHandlerMapping初始化过程中会设置优先级为Ordered.HIGHEST_PRECEDENCE 1000同时还会根据Swagger2Controller得到RequestMappingInfo映射信息并设置到handlerMethods属性中。PropertySourcedRequestMappingHandlerMapping复写了lookupHandlerMethod方法首先会去handlerMethods属性中查询是否存在对应的映射关系没找到的话使用下一个HandlerMapping进行处理Swagger2Controller中只有一个mapping方法默认的path值为/v2/api-docs可以通过配置 springfox.documentation.swagger.v2.path 进行修改。所以默认情况下 /v2/api-docs?groupperson-api、/v2/api-docs?groupuser-api 这些地址都会被Swagger2Controller所处理。Swagger2Controller内部获取文档信息会去DocumentationCache中查找引入springfox带来的影响影响主要有2点应用启动速度变慢因为额外加载了springfox中的信息同时内存中也缓存了这些API信息多了一个HandlerMapping并且优先级高。以下是springboot应用DispatcherServlet的HandlerMapping集合。其中springfox构造的PropertySourcedRequestMappingHandlerMapping优先级最高。优先级最高说明第一次查询映射关系都是走PropertySourcedRequestMappingHandlerMapping而程序中大部分请求都是在RequestMappingHandlerMapping中处理的优先级问题可以使用BeanPostProcessor处理修改优先级本文作者中间件小哥阅读原文本文为云栖社区原创内容未经允许不得转载。
