快捷導(dǎo)航

nacos(SpringCloud)配置加載過(guò)程

更新時(shí)間：2024年12月10日 11:42:59 作者：ke_ek121

Nacos是Spring Cloud的配置中心,通過(guò)BootstrapApplicationListener和ConfigFileApplicationListener監(jiān)聽(tīng)器加載配置文件,并通過(guò)PropertySourceBootstrapConfiguration將Nacos配置加載到Spring Boot應(yīng)用的environment中

nacos(SpringCloud)配置加載

要說(shuō)nacos配置加載，首先說(shuō)一下bootstrap配置文件加載。

眾所周知，Springboot由run方法啟動(dòng)，這里就不展開(kāi)講了，我們主要看下面的代碼，創(chuàng)建Spring容器之前先準(zhǔn)備環(huán)境

org.springframework.boot.SpringApplication#prepareEnvironment

首先會(huì)創(chuàng)建或獲取一個(gè)environment,然后加載一些系統(tǒng)配置（環(huán)境變量等）

接下來(lái)關(guān)鍵了，發(fā)布ApplicationEnvironmentPreparedEvent事件

監(jiān)聽(tīng)器有很多，與此次有關(guān)的是

BootstrapApplicationListener （創(chuàng)建Spring容器和配置中心交互）
ConfigFileApplicationListener（讀取配置文件加載到environment）

首先是BootstrapApplicationListener，如下，可知默認(rèn)配置名字bootstrap,接著會(huì)進(jìn)入bootstrapServiceContext方法創(chuàng)建Spring容器

org.springframework.cloud.bootstrap.BootstrapApplicationListener#bootstrapServiceContext

這里會(huì)重走run方法進(jìn)行容器的創(chuàng)建，兩個(gè)容器是不同的

springboot容器為AnnotationConfigServletWebServerApplicationContext，cloud為AnnotationConfigApplicationContext，由上面的內(nèi)容可知這里又會(huì)重走監(jiān)聽(tīng)器，

BootstrapApplicationListener,不過(guò)會(huì)由于以下代碼返回

接下來(lái)我們看一下另一個(gè)重要的監(jiān)聽(tīng)器ConfigFileApplicationListener

由上可知，這里主要調(diào)用EnvironmentPostProcessor的postProcessEnvironment進(jìn)行處理；我們主要看的還是

org.springframework.boot.context.config.ConfigFileApplicationListener#postProcessEnvironment

這里沒(méi)有展開(kāi)，有興趣可以看源碼，我們主要看加載前后cloud 的environment的變化

加載前

加載后

可以看出主要就是多了bootstrap.yml配置。

接下來(lái)我們看boot的environment的變化

加載前

加載后

可以看出多了application.properties的配置

那么問(wèn)題來(lái)了，cloud的配置（bootstrap.yml）是如何加載到boot中的呢

listener看完了，接下來(lái)就到Initializer了

而Initializer的調(diào)用時(shí)機(jī)就在org.springframework.boot.SpringApplication#prepareContext

這里我們也重點(diǎn)看兩個(gè)

AncestorInitializer

創(chuàng)建時(shí)機(jī)，cloud的容器創(chuàng)建完成

initialize方法，添加了bootstrap.yml方法到boot 的environment中

另一個(gè)是PropertySourceBootstrapConfiguration

我們先來(lái)看一下它是如何引入的

在創(chuàng)建cloud 的容器時(shí)，會(huì)引入一個(gè)配置BootstrapImportSelectorConfiguration

又引入了BootstrapImportSelector

這里利用SPI加載了PropertySourceBootstrapConfiguration

接下來(lái)我們看看initialize方法

這里就是使用PropertySourceLocator.locate()方法加載配置，然后添加到environment。

比如NacosPropertySourceLocator

至此nacos(SpringCloud)配置加載完畢。

后續(xù)補(bǔ)充：naocs共享配置和擴(kuò)展配置

spring:
  profiles:
    active: dev
  application:
    name: alibaba-demo
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
      config:
        server-addr: 127.0.0.1:8848
        file-extension: yaml
        #共享配置
        shared-configs:
          - data-id: shard-test.yaml
            group: SHARD_GROUP
            refresh: true
        #擴(kuò)展配置
        extension-configs:
          - data-id: ext-test.yaml
            group: EXT_GROUP
            refresh: true

不管是shared-configs還是extension-configs，對(duì)應(yīng)的data-id都需要加上文件后綴，如.yaml

數(shù)組下標(biāo)越大的配置項(xiàng)優(yōu)先級(jí)越高

不同配置優(yōu)先級(jí) 默認(rèn)配置 > 擴(kuò)展配置 > 共享配置