由于对 SpringBoot 的版本升级，从 knife4j-spring-boot-starter 3.0.3 版本迭代到 knife4j-openapi2-spring-boot-starter 4.2.0 版本，其中 host 与 basePath 参数不能动态修改的问题，结合源码进行扩展。



# 源码分析
从页面的展示现象上与代码的配置上结合分析，两个版本之间的文档属性 host 与 basePath 应该为接口内部自动处理。
当我配置域名后，host、basepath 不能检测变更，导致接口调用全部失败。

基于以上问题，我决定找到源码中对应的点进行扩展，将 host、basepath 也作为动态可配置的参数。

## 查找切入点

首先通过 `F12` doc.html 文档页面，发现主体数据是通过 `/V2/docs-api` 接口返回数据进行页面填充，知道了接口是什么，接下来分析接口在源码的哪个类中。

![image.png](/static/img/2aad84faef6b4ef143aced542b788f68.image.webp)


:::tip{title="思考"}
**怎么快速定位到源码中的接口？**
:::


结合学习过的源码知识，我此时想到了通过 SpringMVC 的执行流程源码来定位，打开 `DispatcherServlet #doDispatch` 方法，在处理器执行链那一行打个断点

![image.png](/static/img/388148ee304a65d5a183bbb2fecacb74.image.webp)

刷新 doc.html 页面，看断点进来的接口有哪些，几次过后就发现了 `/V2/docs-api` 接口的调用

![image.png](/static/img/e9feb6f8a737df180504e29242f5a86d.image.webp)

通过控制台查看 mappedHandler 对象内部的 handler 属性，同时能查看到处理器的实现类，点击 `Navigate` 可定位到处理器的实现类

![image.png](/static/img/64cc444c558137aab6e4060596b5e497.image.webp)

找到接口的出处 `Swagger2ControllerWebMvc`类，查看接口，发现其内部获取 `Swagger` 对象后，单独设置了 host 与 basePath 属性，到了此时，已经定位了接口在源码中的位置，逻辑也已经完全清晰，接下来开始思考如何改造才能动态扩展出 host 与 basePath 属性？

![image.png](/static/img/8bd90ca6e33f8e5b18c12bde9957849f.image.webp)

## 切入方式的选择


:::tip{title="思考"}
**怎么扩展源码中Controller接口返回的数据？**
:::

对于 Controller 接口的处理，切入点还是比较多的，例如 HandlerInterceptor、ResponseBodyAdvice。

不过由于处理的是Jar包中的 Controller，它在加载到Spring容器的时候，方法的 HandlerInterceptor 已经确认，所以只能使用 ResponseBodyAdvice 方式。

## 代码实现

定义动态的属性配置，通过 application.yaml 隔离

```yml
# dev
knife4j:
  base-path: /
  host: localhost:${server.port}
```

```yml
# prod
knife4j:
  base-path: /yonger
  host: liushigong.cn
```

声明 @RestControllerAdvice 的类，实现 ResponseBodyAdvice 接口

```java 
@RestControllerAdvice
public class Knife4jResponseAdvice implements ResponseBodyAdvice<Json> {

    @Value("${knife4j.base-path}")
    private String basePath;

    @Value("${knife4j.host}")
    private String host;

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return returnType.getDeclaringClass().equals(Swagger2ControllerWebMvc.class);
    }

    @SneakyThrows
    @Override
    public Json beforeBodyWrite(Json body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        if (body != null) {
            // 重写host 和 basePath
            Swagger swagger = JSONObject.parseObject(body.value(), Swagger.class);
            swagger.setHost(host);
            swagger.setBasePath(basePath);
            return new Json(JSONObject.toJSONString(swagger));
        }
        return null;
    }
}
```

**思路：**

- 实现 ResponseBodyAdvice 接口，由于 `/V2/docs-api` 接口返回的是 Json 对象，所以泛型是 Json
- 声明了动态的 host 、 basePath 属性进行注入
- 调用 #supports 方法校验是否需要拦截，如果处理类是 `Swagger2ControllerWebMvc.class` 方法返回true
- #supports为true后，会调用 #beforeBodyWrite 方法，内部将Json中返回的对象值转换为 Swagger对象，填充动态配置的 host、basePath 属性。

## 实现效果

![image.png](/static/img/eb30b2bbc942047e8dc82eae02d24fb4.image.webp)

## 总结
在平常遇到问题时，会去想如何去解决，当有一定的技术深度，掌握部分源码以后，遇到此类问题，脑海中会立马构思出一套思路，排查此类问题就会轻而易举，这就体现出了学习源码的价值。<span style="color:#ff9900;">**解决问题最重要的就是思路，提高深度就是拓展思路最好的方式!** </span>

SpringBoot 整合 Knife4J 文档动态 host 与 basePath 处理

学习源码之前先思考一个问题，我们为什么要学习源码？有什么用？



**工作这么多年我总结了以下几点原因**

- 第一点：应付面试！现在Java开发人员越来越多，公司的要求也变得越来越高，源码成为我们必不可少的面点！
- 第二点：核心竞争！现在氛围好点的公司中，大家工作中对技术讨论还是比较多的，如果你不懂源码的话就没办法参与到源码这部分的讨论中，更不用说参与一些核心代码的开发工作
- 第三点：学以致用！之前部署一套新Cloud服务的时候，同事遇到Feign调用其他服务报 ClientException 异常的问题，在大家轮番上场都一筹莫展的时候，我运用学习源码时的思路，逐步分析Ribbon源码，最终解决了问题
- 第四点：组件封装！学会源码以后，就可以根据源码扩展出各种组件，是高级开发必备技能

## 开篇
我在学习Spring源码的过程中略有心得，通过流程图记录下源码执行流程、各种扩展点以及一些自己的理解。

![image.png](/static/img/711ae8688cc430077f5accc24f7a0205.image.webp)

- Spring在启动时会先创建 BeanFactory，默认是ConfigurableListableBeanFactory，
- 通过BeanDefinitionReader解析xml、注解等定义的Bean信息包装成BeanDefinition存到BeanFactory中的BeanDefinitionMap中，
- 然后调用BeanFactoryPostProcessor接口进行扩展，
- 进行实例化前的准备工作：注册BeanPostProcesser、初始化国际化资源、初始化事件多播器、注册监听器。
- 准备完成后对所有非延迟加载的单例进行实例化，通过反射的形式创建对象，进行属性填充，然后进行相应的Aware接口的感知调用，
- 执行BeanPostProcesser的前置处理，在初始化方法调用之后执行BeanPostProcesser的后置处理，
- 此时Bean的对象创建完成

源码的学习，都是从上面的流程学起，面试经常问题的Spring Bean的生命周期，就是上面图中，Bean创建的流程，在`BeanFactory`中有对应的注释，如下：

![image.png](/static/img/ecac93392373e15e125aa5106d5b9978.image.webp)

在源码中 AbstractApplicationContext #refresh 方法即为Spring Bean完整生命周期的体现
```java
public void refresh() throws BeansException, IllegalStateException {
    synchronized (this.startupShutdownMonitor) {
        StartupStep contextRefresh = this.applicationStartup.start("spring.context.refresh");

        // Prepare this context for refreshing.
        prepareRefresh();

        // Tell the subclass to refresh the internal bean factory.
        ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

        // Prepare the bean factory for use in this context.
        prepareBeanFactory(beanFactory);

        try {
            // Allows post-processing of the bean factory in context subclasses.
            postProcessBeanFactory(beanFactory);

            StartupStep beanPostProcess = this.applicationStartup.start("spring.context.beans.post-process");
            // Invoke factory processors registered as beans in the context.
            invokeBeanFactoryPostProcessors(beanFactory);

            // Register bean processors that intercept bean creation.
            registerBeanPostProcessors(beanFactory);
            beanPostProcess.end();

            // Initialize message source for this context.
            initMessageSource();

            // Initialize event multicaster for this context.
            initApplicationEventMulticaster();

            // Initialize other special beans in specific context subclasses.
            onRefresh();

            // Check for listener beans and register them.
            registerListeners();

            // Instantiate all remaining (non-lazy-init) singletons.
            finishBeanFactoryInitialization(beanFactory);

            // Last step: publish corresponding event.
            finishRefresh();
        }

        catch (BeansException ex) {
            if (logger.isWarnEnabled()) {
                logger.warn("Exception encountered during context initialization - " +
                                    "cancelling refresh attempt: " + ex);
            }

            // Destroy already created singletons to avoid dangling resources.
            destroyBeans();

            // Reset 'active' flag.
            cancelRefresh(ex);

            // Propagate exception to caller.
            throw ex;
        }

        finally {
            // Reset common introspection caches in Spring's core, since we
            // might not ever need metadata for singleton beans anymore...
            resetCommonCaches();
            contextRefresh.end();
        }
    }
}

```


## 总结

想要掌握Spring源码应该先掌握Spring的生命周期（Bean信息是怎么加载、解析、实例化、初始化、使用、销毁的），脑海中有一个框架轮廓，知道Spring先做了什么，后做了什么，有一个大概了解。

脑海中有了Spring的轮廓之后，开始思考细节，例如：Bean信息是怎么加载的？加载的Bean信息是直接生成可用的Bean吗？每一步流程都动脑思考扩展点，怎么应用到业务中，这个扩展适合哪些业务场景等。

在看源码的过程中，要学会关联思考，源码中往往是初始化数据后，n个方法后会用到的。

最后一点，学过源码后一定要思考、做笔记，回头来看学过的知识点能在脑海中立马回忆起来，争取做到对源码为所欲为的境界！！！

Spring 源码分析之 Bean 的全生命周期

对于想要研究SpringBoot源码的小伙伴来说，在本地编译源码环境，然后在研究源码的时候可以添加对应的注释是必须的，本文就给大家来介绍下如何来搭建我们的源码环境。



# SpringBoot源码环境准备

## 1.官方源码下载

首先大家要注意SpringBoot项目在2.3.0之前是使用Maven构建项目的，在2.3.0之后是使用Gradle构建项目的。后面分析的源码以SpringBoot2.2.5为案例，所以本文就介绍下SpringBoot2.2.5的编译过程。

官网地址：https://github.com/spring-projects/spring-boot

![image.png](https://blog.liushigong.cn/static/img/f9889a5f13d58a38c912a470ddad9a48.image.webp)

直接下载对于的压缩文件即可

![image.png](https://blog.liushigong.cn/static/img/4ed1d3f6f781e5ed5f2b39c15329aa26.image.webp)
下载后直接解压缩即可

## 2.本地源码编译

把解压缩的源码直接导入到IDEA中，修改pom文件中的版本号。

![image.png](https://blog.liushigong.cn/static/img/9928aebd76b624f5da057a57d7c3c322.image.webp)

pom文件中提示 `disable.checks`属性找不到，我们添加一个即可。

```xml
	<properties>
		<revision>2.2.5.snapshot</revision>
		<main.basedir>${basedir}</main.basedir>
		
		<disable.checks>true</disable.checks>
	</properties>
```

然后执行编译命令

```cmd
mvn clean install -DskipTests
```

![image.png](https://blog.liushigong.cn/static/img/40a834fc06ba2b9f64728a2184468100.image.webp)

然后控制台出现如下错误

![image.png](https://blog.liushigong.cn/static/img/d95517f5c03093646b260087a58b9c26.image.webp)

按照提示，执行下面的 命令 就好了：


![image.png](https://blog.liushigong.cn/static/img/b7ea1bbde635b167ebfe942826f49184.image.webp)

![image.png](https://blog.liushigong.cn/static/img/04828d1fe9b1ed3428cd48e7ca4c79d3.image.webp)

在执行编译命令就可以了 `mvn clean install -DskipTests`

![image.png](https://blog.liushigong.cn/static/img/c90d74719866456cbdd539cbcfe23f8f.image.webp)

## 3.源码环境使用

既然源码已经编译好之后我们就可以在这个项目中来创建我们自己的SpringBoot项目了，我们在 `spring-boot-project`项目下创建 `module`,

![image.png](https://blog.liushigong.cn/static/img/7160a8543f24ab6fd464d382076c45a4.image.webp)

然后在我们的module中添加对应的start依赖

![image.png](https://blog.liushigong.cn/static/img/202b24f3adc72895b915a27ddb698da8.image.webp)

然后添加我们的启动类

![image.png](https://blog.liushigong.cn/static/img/7ff6f3927dfe8f567f878bf131625b2b.image.webp)

项目能够正常启动

![image.png](https://blog.liushigong.cn/static/img/a97a9440a6e09f70419858d178ca0ec1.image.webp)

同时点击run方法进去，我们可以添加注释了：

![image.png](https://blog.liushigong.cn/static/img/18eba21d7c6c59538411a41268ba4da2.image.webp)

在其他项目使用我们编译的源码，这个可能是大家比较感兴趣的一个点了，我们也来介绍下，依赖我们还是可以使用官方的依赖即可，不过最好还是和我们编译的版本保持一致。

主要是关联上我们编译的源码。

![image.png](https://blog.liushigong.cn/static/img/73b6cb8755b35e673503fd41736d7d0f.image.webp)

![image.png](https://blog.liushigong.cn/static/img/e08940b3938d67793ee9f0dfd637aaea.image.webp)

![image.png](https://blog.liushigong.cn/static/img/6383837028d71d8243365368dad43356.image.webp)

修改代码

![image.png](https://blog.liushigong.cn/static/img/dc91e8842c4c65b6adbf677ba6de2698.image.webp)

![image.png](https://blog.liushigong.cn/static/img/2df76cfffb26bb05c144af8d1befe3a3.image.webp)

好了到此我们就可以开启SpringBoot的源码探索之旅了。

:::tip{title="编译本地的源码"}
除了上面描述的 SpringBoot 可以将项目中的源码指向到本地项目中，对应其他项目的源码也是可以的，例如Spring、Nacos 等源码
:::

SpringBoot - 源码环境准备

数据库- Mysql 索引原理与高性能调优

RocketMQ 功能特性讲解

baidu-site-verification

本人自己的博客，对工作与学习过程中的总结、一些场景设计的实现方案、遇到过的疑难问题与解决、以及面试总结等。