如何替换重构依赖里面的Service
- 以下知识来源于疯狂的狮子Li在QQ群的讲解,纯属做一下笔记。
- 总结的经验
以下知识来源于疯狂的狮子Li在QQ群的讲解,纯属做一下笔记。
由于knife4j停止更新,未来将无法适配springboot3.0,所以Li研究springdoc配合apifox替换掉knife4j,
在过程中,发现控制器的名称和描述还是需要通过增加注解@Tag(name = “xxx处理”, description = “xxx描述”)才能显示,为了彻底去除注解,实现0侵入的api文档方案,遂需要对springdoc进行相应的改造。
在SwaggerConfig中
增加了如下代码
/**
* 自定义 openapi 处理器
*/
@Bean
public OpenAPIService openApiBuilder(Optional<OpenAPI> openAPI,
SecurityService securityParser,
SpringDocConfigProperties springDocConfigProperties, PropertyResolverUtils propertyResolverUtils,
Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomisers,
Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomisers, Optional<JavadocProvider> javadocProvider) {
return new OpenApiHandler(openAPI, securityParser, springDocConfigProperties, propertyResolverUtils, openApiBuilderCustomisers, serverBaseUrlCustomisers, javadocProvider);
}
然后声明了OpenApiHandler extends OpenAPIService来重构OpenAPIService,为什么可以如此重构呢?首先在右侧maven管理中,找到springdoc所在的包ruoyi-common,全部选中,并下载源码。
然后点击OpenAPIService进入了public class OpenAPIService implements ApplicationContextAware,
再点击OpenAPIService,即可弹窗看到调用了此服务的相关类,
在里面找到new OpenAPIService的地方,点击进去。就可以看到如下方法
可以看到,此方法有三个注解:
@Bean
@ConditionalOnMissingBean
@Lazy(false)
其中,
@Bean表示方法产生一个由Spring管理的bean,
@ConditionalOnMissingBean,它是修饰bean的一个注解,主要实现的是,当你的bean被注册之后,如果而注册相同类型的bean,就不会成功,它会保证你的bean只有一个,即你的实例只有一个,当你注册多个相同的bean时,会出现异常,以此来告诉人员。
@Lazy(false)SpringIoC容器会在启动的时候实例化所有单实例 bean 。如果我们想要实现 Spring 在启动的时候延迟加载 bean,即在首次调用bean的时候再去执行初始化,就可以使用 @Lazy 注解来解决这个问题。而加了(false)说明没有使用懒加载
关键的地方就在于@ConditionalOnMissingBean,说明可以通过自己注册一个Bean来替换掉这个方法,因此才有了开始的在SwaggerConfig中增加的那段代码。
如果源码中没有@ConditionalOnMissingBean,我们还可以直接在开头那段代码增加一个注解:@Primary(强制替换),也能达到目的。继而可以在OpenApiHandler 覆写相关方法。OpenApiHandler 中模仿OpenAPIService的结构,并找到读取控制器@Tag部分的代码,转为读取注释来达到无需写@Tag注解的目的。
总结的经验
多读spring源码,读源码前,先学习设计模式,多看别人分析源码的文章,然后自己在maven管理中,下载源码
譬如要找到注解的切面方法,就通过下载源码后,点击注解,找到xxx.class.getName() 就可以找到切面实现进而分析注解的作用。