真实的国产乱ⅩXXX66竹夫人,五月香六月婷婷激情综合,亚洲日本VA一区二区三区,亚洲精品一区二区三区麻豆

成都創(chuàng)新互聯(lián)網(wǎng)站制作重慶分公司

springcloudconfig配置讀取優(yōu)先級(jí)過程詳解

情景描述

成都創(chuàng)新互聯(lián)公司長(zhǎng)期為千余家客戶提供的網(wǎng)站建設(shè)服務(wù),團(tuán)隊(duì)從業(yè)經(jīng)驗(yàn)10年,關(guān)注不同地域、不同群體,并針對(duì)不同對(duì)象提供差異化的產(chǎn)品和服務(wù);打造開放共贏平臺(tái),與合作伙伴共同營(yíng)造健康的互聯(lián)網(wǎng)生態(tài)環(huán)境。為威信企業(yè)提供專業(yè)的做網(wǎng)站、成都網(wǎng)站建設(shè),威信網(wǎng)站改版等技術(shù)服務(wù)。擁有10年豐富建站經(jīng)驗(yàn)和眾多成功案例,為您定制開發(fā)。

最近在修復(fù)Eureka的靜態(tài)頁面加載不出的缺陷時(shí),最終發(fā)現(xiàn)是遠(yuǎn)程GIT倉庫將靜態(tài)資源訪問方式配置給禁用了(spring.resources.add-mappings=false)。雖然最后直接修改遠(yuǎn)程GIT倉庫的此配置項(xiàng)給解決了(spring.resources.add-mappings=true),但是從中牽涉出的配置讀取優(yōu)先級(jí)我們必須好好的再回顧下

springcloud config讀取倉庫配置

通過config client模塊來讀取遠(yuǎn)程的倉庫配置,只需要在boostrap.properties文件中配置如下屬性即可

spring.application.name=eureka
spring.cloud.config.uri=http://localhost:8888
spring.cloud.config.name=dev
spring.cloud.config.username=dev
spring.cloud.config.password=dev

其就會(huì)以GET方式去請(qǐng)求http://localhost:8888/eureka/dev地址從而將配置拉取下來。
當(dāng)然上述的API地址也是需要被訪問服務(wù)器部署了config server服務(wù)方可調(diào)用,具體的細(xì)節(jié)就不展開了

外部源讀取優(yōu)先級(jí)

我們都知道spring的配置屬性管理均是存放在Enviroment對(duì)象中,就以普通項(xiàng)目StandardEnvironment為例,其配置的存放順序可羅列如下

順位key來源說明
1commandLineArgs傳入main函數(shù)的參數(shù)列表Program arguments
2systemPropertiesSystem.getProperties()JDK屬性列表、操作系統(tǒng)屬性、-D開頭的VM屬性等
3systemEnvironmentSystem.getEnv()環(huán)境屬性,例如JAVA_HOME/M2_HOME
4${file_name}配置文件例如application.yml
5defaultPropertiesSpringApplicationBuilder#properties()

那么遠(yuǎn)程讀取的配置的存放應(yīng)該放在上述的哪個(gè)位置呢?

我們都知道boostrap上下文通過暴露org.springframework.cloud.bootstrap.config.PropertySourceLocator接口來方便集成第三方的外部源配置讀取,比如本文提及的config client模塊中的org.springframework.cloud.config.client.ConfigServicePropertySourceLocator實(shí)現(xiàn)類。

但最終將外部源配置讀取以及插入至Environment對(duì)象中則是通過org.springframework.cloud.bootstrap.config.PropertySourceBootstrapConfiguration類來完成的。

PropertySourceBootstrapConfiguration

此類也是ApplicationContextInitializer接口的實(shí)現(xiàn)類,閱讀過cloud源碼的都知道,此類被調(diào)用是在子類上下文初始化的時(shí)候,我們主要看下其復(fù)寫的initialize()方法

 @Override
 public void initialize(ConfigurableApplicationContext applicationContext) {
  CompositePropertySource composite = new CompositePropertySource(
    BOOTSTRAP_PROPERTY_SOURCE_NAME);
  // 對(duì)在boostrap上下文類型為PropertySourceLocator的bean集合進(jìn)行排序
  AnnotationAwareOrderComparator.sort(this.propertySourceLocators);
  boolean empty = true;
  ConfigurableEnvironment environment = applicationContext.getEnvironment();
  for (PropertySourceLocator locator : this.propertySourceLocators) {
   PropertySource<?> source = null;
   // 讀取外部配置源
   source = locator.locate(environment);
   if (source == null) {
    continue;
   }
   logger.info("Located property source: " + source);
   composite.addPropertySource(source);
   empty = false;
  }
  if (!empty) {
   MutablePropertySources propertySources = environment.getPropertySources();
   String logConfig = environment.resolvePlaceholders("${logging.config:}");
   LogFile logFile = LogFile.get(environment);
   if (propertySources.contains(BOOTSTRAP_PROPERTY_SOURCE_NAME)) {
    propertySources.remove(BOOTSTRAP_PROPERTY_SOURCE_NAME);
   }
   // 插入至Environment環(huán)境對(duì)象中
   insertPropertySources(propertySources, composite);
   reinitializeLoggingSystem(environment, logConfig, logFile);
   setLogLevels(applicationContext, environment);
   handleIncludedProfiles(environment);
  }
 }

直接觀察對(duì)應(yīng)的insertPropertySources()方法

 private void insertPropertySources(MutablePropertySources propertySources,
   CompositePropertySource composite) {
  // 外部源配置集合
  MutablePropertySources incoming = new MutablePropertySources();
  incoming.addFirst(composite);
  PropertySourceBootstrapProperties remoteProperties = new PropertySourceBootstrapProperties();
  // 從外部源配置源集合中讀取PropertySourceBootstrapProperties的相關(guān)屬性
  // 例如spring.cloud.config.overrideSystemProperties等屬性
  Binder.get(environment(incoming)).bind("spring.cloud.config",
    Bindable.ofInstance(remoteProperties));
  // spring.cloud.config.allow-override=false或者spring.cloud.config.override-none=false且spring.cloud.config.override-system-properties=true
  if (!remoteProperties.isAllowOverride() || (!remoteProperties.isOverrideNone()
    && remoteProperties.isOverrideSystemProperties())) {
   propertySources.addFirst(composite);
   return;
  }
  // spring.cloud.config.override-none=true則處于最低讀取位
  if (remoteProperties.isOverrideNone()) {
   propertySources.addLast(composite);
   return;
  }
  // 根據(jù)spring.cloud.config.override-system-properties屬性判斷是放在systemProperties前還是后
  if (propertySources
    .contains(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME)) {
   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);
  }
 }

對(duì)上述的代碼描述作下總結(jié)

1.上述的配置屬性均會(huì)映射到PropertySourceBootstrapProperties實(shí)體類中,且其中的默認(rèn)值羅列如下

屬性默認(rèn)值說明
spring.cloud.config.allow-overridetrue外部源配置是否可被覆蓋
spring.cloud.config.override-nonefalse外部源配置是否不覆蓋任何源
spring.cloud.config.override-system-propertiestrue外部源配置是否可覆蓋本地屬性

2.針對(duì)相應(yīng)的屬性的值對(duì)應(yīng)的外部源在Environment對(duì)象中的讀取優(yōu)先級(jí),羅列如下

屬性讀取優(yōu)先級(jí)
spring.cloud.config.allow-override=false最高
spring.cloud.config.override-none=false&&spring.cloud.config.override-system-properties=true最高(默認(rèn))
spring.cloud.config.override-none=true最低
spring上下文無systemEnvironment屬性最低
spring上下文有systemEnvironment屬性 && spring.cloud.config.override-system-properties=false在systemEnvironment之后
spring上下文有systemEnvironment屬性 && spring.cloud.config.override-system-properties=false在systemEnvironment之前

即默認(rèn)情況下,外部源的配置屬性的讀取優(yōu)先級(jí)是最高的。

且除了spring.cloud.config.override-none=true的情況下,其他情況下外部源的讀取優(yōu)先級(jí)均比本地配置文件高。
Note:值得注意的是,如果用戶想復(fù)寫上述的屬性,則放在bootstrap.yml|application.yml配置文件中是無效的,根據(jù)源碼分析只能是自定義一個(gè)PropertySourceLocator接口實(shí)現(xiàn)類并放置在相應(yīng)的spring.factories文件中方可生效。

自定義PropertySourceLocator接口

針對(duì)上文描述,假設(shè)有這么一個(gè)場(chǎng)景,遠(yuǎn)程倉庫的配置都是公有的,我們也不能修改它,我們只在項(xiàng)目中去復(fù)寫相應(yīng)的配置以達(dá)到兼容的目的。那么用戶就需要自定義去編寫接口了

1.編寫PropertySourceLocator接口實(shí)現(xiàn)類

package com.example.configdemo.propertysource;

import org.springframework.cloud.bootstrap.config.PropertySourceLocator;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.core.env.Environment;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.PropertySource;

import java.util.HashMap;
import java.util.Map;

/**
 * @author nanco
 * @create 19/9/22
 * @description 自定義的PropertySourceLocator的順序應(yīng)該要比遠(yuǎn)程倉庫讀取方式要優(yōu)先
 * @see org.springframework.cloud.config.client.ConfigServicePropertySourceLocator
 */
@Order(value = Ordered.HIGHEST_PRECEDENCE + 1)
public class CustomPropertySourceLocator implements PropertySourceLocator {

 private static final String OVERRIDE_ADD_MAPPING = "spring.resources.add-mappings";

 @Override
 public PropertySource<?> locate(Environment environment) {

  Map customMap = new HashMap<>(2);
  // 遠(yuǎn)程倉庫此配置為false,本地進(jìn)行復(fù)寫
  customMap.put(OVERRIDE_ADD_MAPPING, "true");

  return new MapPropertySource("custom", customMap);
 }
}

2.編寫B(tài)ootstrapConfiguration

package com.example.configdemo.propertysource;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author nanco
 * @create 19/9/22
 */
@Configuration
public class CustomBootstrapConfiguration {

 @Bean("customPropertySourceLocator")
 public CustomPropertySourceLocator propertySourceLocator() {
  return new CustomPropertySourceLocator();
 }
}

3.在src\main\resources目錄下創(chuàng)建META-INF\spring.factories文件

# Bootstrap components
org.springframework.cloud.bootstrap.BootstrapConfiguration=\
com.example.configdemo.propertysource.CustomBootstrapConfiguration

4.運(yùn)行main函數(shù)即可

小結(jié)

默認(rèn)情況下,外部源配置擁有最高的優(yōu)先級(jí)。在spring.cloud.config.override-none=false的情況下,外部源配置也比本地文件擁有更高的優(yōu)先級(jí)。

以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持創(chuàng)新互聯(lián)。


網(wǎng)站標(biāo)題:springcloudconfig配置讀取優(yōu)先級(jí)過程詳解
瀏覽地址:http://weahome.cn/article/iheggd.html

其他資訊

在線咨詢

微信咨詢

電話咨詢

028-86922220(工作日)

18980820575(7×24)

提交需求

返回頂部