這篇文章主要介紹Spring Cloud覆寫(xiě)遠(yuǎn)端配置屬性的示例分析，文中介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們一定要看完！

創(chuàng)新互聯(lián)公司是專業(yè)的天壇街道網(wǎng)站建設(shè)公司，天壇街道接單;提供成都網(wǎng)站建設(shè)、成都網(wǎng)站制作,網(wǎng)頁(yè)設(shè)計(jì),網(wǎng)站設(shè)計(jì),建網(wǎng)站,PHP網(wǎng)站建設(shè)等專業(yè)做網(wǎng)站服務(wù);采用PHP框架,可快速的進(jìn)行天壇街道網(wǎng)站開(kāi)發(fā)網(wǎng)頁(yè)制作和功能擴(kuò)展;專業(yè)做搜索引擎喜愛(ài)的網(wǎng)站,專業(yè)的做網(wǎng)站團(tuán)隊(duì),希望更多企業(yè)前來(lái)合作!

應(yīng)用的配置源通常都是遠(yuǎn)端的Config Server服務(wù)器，默認(rèn)情況下，本地的配置優(yōu)先級(jí)低于遠(yuǎn)端配置倉(cāng)庫(kù)。如果想實(shí)現(xiàn)本地應(yīng)用的系統(tǒng)變量和config文件覆蓋遠(yuǎn)端倉(cāng)庫(kù)中的屬性值，可以通過(guò)如下設(shè)置：

spring:
cloud:
config:
allowOverride: true
overrideNone: true
overrideSystemProperties: false

• overrideNone：當(dāng)allowOverride為true時(shí)，overrideNone設(shè)置為true，外部的配置優(yōu)先級(jí)更低，而且不能覆蓋任何存在的屬性源。默認(rèn)為false

• allowOverride：標(biāo)識(shí)overrideSystemProperties屬性是否啟用。默認(rèn)為true，設(shè)置為false意為禁止用戶的設(shè)置

• overrideSystemProperties：用來(lái)標(biāo)識(shí)外部配置是否能夠覆蓋系統(tǒng)屬性，默認(rèn)為true

客戶端通過(guò)如上配置，可以實(shí)現(xiàn)本地配置優(yōu)先級(jí)更高，且不能被覆蓋。由于我們基于的Spring Cloud當(dāng)前版本是 Edgware.RELEASE ，上面的設(shè)置并不能起作用，而是使用了 PropertySourceBootstrapProperties 中的默認(rèn)值。具體情況見(jiàn)issue： https://github.com/spring-cloud/spring-cloud-commons/pull/250 ，我們?cè)谙旅娣治鰰r(shí)會(huì)講到具體的bug源。

源碼分析

ConfigServicePropertySourceLocator

覆寫(xiě)遠(yuǎn)端的配置屬性歸根結(jié)底與客戶端的啟動(dòng)時(shí)獲取配置有關(guān)，在獲取到配置之后如何處理？我們看一下spring cloud config中的資源獲取類 ConfigServicePropertySourceLocator 的類圖。

ConfigServicePropertySourceLocator 實(shí)質(zhì)是一個(gè)屬性資源定位器，其主要方法是 locate(Environment environment) 。首先用當(dāng)前運(yùn)行應(yīng)用的環(huán)境的application、profile和label替換configClientProperties中的占位符并初始化RestTemplate，然后遍歷labels數(shù)組直到獲取到有效的配置信息，最后還會(huì)根據(jù)是否快速失敗進(jìn)行重試。主要流程如下：

locate(Environment environment) 調(diào)用 getRemoteEnvironment(restTemplate, properties, label, state) 方法通過(guò)http的方式獲取遠(yuǎn)程服務(wù)器上的配置數(shù)據(jù)。實(shí)現(xiàn)也很簡(jiǎn)單，顯示替換請(qǐng)求路徑path中占位符，然后進(jìn)行頭部headers組裝，組裝好了就可以發(fā)送請(qǐng)求，最后返回結(jié)果。

在上面的實(shí)現(xiàn)中，我們看到獲取到的配置信息存放在 CompositePropertySource ，那是如何使用它的呢？這邊補(bǔ)充另一個(gè)重要的類是PropertySourceBootstrapConfiguration，它實(shí)現(xiàn)了ApplicationContextInitializer接口，該接口會(huì)在應(yīng)用上下文刷新之前 refresh() 被回調(diào)，從而執(zhí)行初始化操作，應(yīng)用啟動(dòng)后的調(diào)用棧如下：

SpringApplicationBuilder.run() -> SpringApplication.run() -> SpringApplication.createAndRefreshContext() -> SpringApplication.applyInitializers() -> PropertySourceBootstrapConfiguration.initialize()
PropertySourceBootstrapConfiguration

而上述 ConfigServicePropertySourceLocator 的locate方法會(huì)在initialize中被調(diào)用，從而保證上下文在刷新之前能夠拿到必要的配置信息。具體看一下initialize方法：

public class PropertySourceBootstrapConfigurationimplements
 ApplicationContextInitializer, Ordered {
 private int order = Ordered.HIGHEST_PRECEDENCE + 10;
 @Autowired(required = false)
 private List propertySourceLocators = new ArrayList<>();
 @Override
 public void initialize(ConfigurableApplicationContext applicationContext){
 CompositePropertySource composite = new CompositePropertySource(
 BOOTSTRAP_PROPERTY_SOURCE_NAME);
 //對(duì)propertySourceLocators數(shù)組進(jìn)行排序，根據(jù)默認(rèn)的AnnotationAwareOrderComparator
 AnnotationAwareOrderComparator.sort(this.propertySourceLocators);
 boolean empty = true;
 //獲取運(yùn)行的環(huán)境上下文
 ConfigurableEnvironment environment = applicationContext.getEnvironment();
 for (PropertySourceLocator locator : this.propertySourceLocators) {
 //遍歷this.propertySourceLocators
 PropertySource source = null;
 source = locator.locate(environment);
 if (source == null) {
 continue;
 }
 logger.info("Located property source: " + source);
 //將source添加到PropertySource的鏈表中
 composite.addPropertySource(source);
 empty = false;
 }
 //只有source不為空的情況，才會(huì)設(shè)置到environment中
 if (!empty) {
 //返回Environment的可變形式，可進(jìn)行的操作如addFirst、addLast
 MutablePropertySources propertySources = environment.getPropertySources();
 String logConfig = environment.resolvePlaceholders("${logging.config:}");
 LogFile logFile = LogFile.get(environment);
 if (propertySources.contains(BOOTSTRAP_PROPERTY_SOURCE_NAME)) {
 //移除bootstrapProperties
 propertySources.remove(BOOTSTRAP_PROPERTY_SOURCE_NAME);
 }
 //根據(jù)config server覆寫(xiě)的規(guī)則，設(shè)置propertySources
 insertPropertySources(propertySources, composite);
 reinitializeLoggingSystem(environment, logConfig, logFile);
 setLogLevels(environment);
 //處理多個(gè)active profiles的配置信息
 handleIncludedProfiles(environment);
 }
 }
 //...
}

下面我們看一下，在 initialize 方法中進(jìn)行了哪些操作。

• 根據(jù)默認(rèn)的 AnnotationAwareOrderComparator 排序規(guī)則對(duì)propertySourceLocators數(shù)組進(jìn)行排序

• 獲取運(yùn)行的環(huán)境上下文ConfigurableEnvironment

• 遍歷propertySourceLocators時(shí)

•             調(diào)用 locate 方法，傳入獲取的上下文environment

•              將source添加到PropertySource的鏈表中

•              設(shè)置source是否為空的標(biāo)識(shí)標(biāo)量empty

• source不為空的情況，才會(huì)設(shè)置到environment中

返回Environment的可變形式，可進(jìn)行的操作如addFirst、addLast

移除propertySources中的bootstrapProperties

根據(jù)config server覆寫(xiě)的規(guī)則，設(shè)置propertySources

處理多個(gè)active profiles的配置信息

初始化方法 initialize 處理時(shí)，先將所有PropertySourceLocator類型的對(duì)象的 locate 方法遍歷，然后將各種方式得到的屬性值放到CompositePropertySource中，最后調(diào)用 insertPropertySources(propertySources, composite) 方法設(shè)置到Environment中。Spring Cloud Context中提供了覆寫(xiě)遠(yuǎn)端屬性的 PropertySourceBootstrapProperties ，利用該配置類進(jìn)行判斷屬性源的優(yōu)先級(jí)。

private void insertPropertySources(MutablePropertySources propertySources,
 CompositePropertySource composite) {
 MutablePropertySources incoming = new MutablePropertySources();
 incoming.addFirst(composite);
 PropertySourceBootstrapProperties remoteProperties = new PropertySourceBootstrapProperties();
 new RelaxedDataBinder(remoteProperties, "spring.cloud.config")
 .bind(new PropertySourcesPropertyValues(incoming));
 //如果不允許本地覆寫(xiě)
 if (!remoteProperties.isAllowOverride() || (!remoteProperties.isOverrideNone()
 && remoteProperties.isOverrideSystemProperties())) {
 propertySources.addFirst(composite);
 return;
 }
 //overrideNone為true，外部配置優(yōu)先級(jí)最低
 if (remoteProperties.isOverrideNone()) {
 propertySources.addLast(composite);
 return;
 }
 if (propertySources
 .contains(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME)) {
 //根據(jù)overrideSystemProperties，設(shè)置外部配置的優(yōu)先級(jí)
 if (!remoteProperties.isOverrideSystemProperties()) {
 propertySources.addAfter(
  StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME,
  composite);
 }
 else {
 propertySources.addBefore(
  StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME,
  composite);
 }
 }
 else {
 propertySources.addLast(composite);
 }
}

上述實(shí)現(xiàn)主要是根據(jù) PropertySourceBootstrapProperties 中的屬性，調(diào)整多個(gè)配置源的優(yōu)先級(jí)。從其實(shí)現(xiàn)可以看到 PropertySourceBootstrapProperties 對(duì)象的是被直接初始化，使用的是默認(rèn)的屬性值而并未注入我們?cè)谂渲梦募性O(shè)置的。

修復(fù)后的實(shí)現(xiàn)：

@Autowired(required = false)
 private PropertySourceBootstrapProperties remotePropertiesForOverriding;
 @Override
 public int getOrder(){
 return this.order;
 private void insertPropertySources(MutablePropertySources propertySources,
 CompositePropertySource composite) {
 MutablePropertySources incoming = new MutablePropertySources();
 incoming.addFirst(composite);
 PropertySourceBootstrapProperties remoteProperties = remotePropertiesForOverriding == null
 ? new PropertySourceBootstrapProperties()
 : remotePropertiesForOverriding;

以上是“Spring Cloud覆寫(xiě)遠(yuǎn)端配置屬性的示例分析”這篇文章的所有內(nèi)容，感謝各位的閱讀！希望分享的內(nèi)容對(duì)大家有幫助，更多相關(guān)知識(shí)，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道！

網(wǎng)站欄目：SpringCloud覆寫(xiě)遠(yuǎn)端配置屬性的示例分析-創(chuàng)新互聯(lián)
當(dāng)前鏈接：http://weahome.cn/article/cdhdjo.html