覆寫遠端的配置屬性
應用的配置源通常都是遠端的Config Server伺服器，預設情況下，本地的配置優先順序低於遠端配置倉庫。如果想實現本地應用的系統變數和config檔案覆蓋遠端倉庫中的屬性值，可以通過如下設定：
spring:
cloud:
config:
allowOverride: true
overrideNone: true
overrideSystemProperties: false
複製程式碼- overrideNone：當allowOverride為true時，overrideNone設定為true，外部的配置優先順序更低，而且不能覆蓋任何存在的屬性源。預設為false
- allowOverride：標識overrideSystemProperties屬性是否啟用。預設為true，設定為false意為禁止使用者的設定
- overrideSystemProperties：用來標識外部配置是否能夠覆蓋系統屬性，預設為true
客戶端通過如上配置，可以實現本地配置優先順序更高，且不能被覆蓋。由於我們基於的Spring Cloud當前版本是Edgware.RELEASE，上面的設定並不能起作用，而是使用了PropertySourceBootstrapProperties中的預設值。具體情況見issue：https://github.com/spring-cloud/spring-cloud-commons/pull/250，我們在下面分析時會講到具體的bug源。
原始碼分析
ConfigServicePropertySourceLocator
覆寫遠端的配置屬性歸根結底與客戶端的啟動時獲取配置有關，在獲取到配置之後如何處理？我們看一下spring cloud config中的資源獲取類ConfigServicePropertySourceLocator的類圖。
ConfigServicePropertySourceLocator實質是一個屬性資源定位器，其主要方法是locate(Environment environment)。首先用當前執行應用的環境的application、profile和label替換configClientProperties中的佔位符並初始化RestTemplate，然後遍歷labels陣列直到獲取到有效的配置資訊，最後還會根據是否快速失敗進行重試。主要流程如下：
locate(Environment environment)呼叫getRemoteEnvironment(restTemplate, properties, label, state)方法通過http的方式獲取遠端伺服器上的配置資料。實現也很簡單，顯示替換請求路徑path中佔位符，然後進行頭部headers組裝，組裝好了就可以傳送請求，最後返回結果。
在上面的實現中，我們看到獲取到的配置資訊存放在CompositePropertySource，那是如何使用它的呢？這邊補充另一個重要的類是PropertySourceBootstrapConfiguration，它實現了ApplicationContextInitializer介面，該介面會在應用上下文重新整理之前refresh()被回撥，從而執行初始化操作，應用啟動後的呼叫棧如下：
SpringApplicationBuilder.run() -> SpringApplication.run() -> SpringApplication.createAndRefreshContext() -> SpringApplication.applyInitializers() -> PropertySourceBootstrapConfiguration.initialize()
複製程式碼PropertySourceBootstrapConfiguration
而上述ConfigServicePropertySourceLocator的locate方法會在initialize中被呼叫，從而保證上下文在重新整理之前能夠拿到必要的配置資訊。具體看一下initialize方法：
public class PropertySourceBootstrapConfiguration implements
ApplicationContextInitializer<ConfigurableApplicationContext>, Ordered {
private int order = Ordered.HIGHEST_PRECEDENCE + 10;
@Autowired(required = false)
private List<PropertySourceLocator> propertySourceLocators = new ArrayList<>();
@Override
public void initialize(ConfigurableApplicationContext applicationContext) {
CompositePropertySource composite = new CompositePropertySource(
BOOTSTRAP_PROPERTY_SOURCE_NAME);
//對propertySourceLocators陣列進行排序，根據預設的AnnotationAwareOrderComparator
AnnotationAwareOrderComparator.sort(this.propertySourceLocators);
boolean empty = true;
//獲取執行的環境上下文
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不為空的情況，才會設定到environment中
if (!empty) {
//返回Environment的可變形式，可進行的操作如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);
}
//根據config server覆寫的規則，設定propertySources
insertPropertySources(propertySources, composite);
reinitializeLoggingSystem(environment, logConfig, logFile);
setLogLevels(environment);
//處理多個active profiles的配置資訊
handleIncludedProfiles(environment);
}
}
//...
}
複製程式碼下面我們看一下，在initialize方法中進行了哪些操作。
- 根據預設的 AnnotationAwareOrderComparator 排序規則對propertySourceLocators陣列進行排序
- 獲取執行的環境上下文ConfigurableEnvironment
- 遍歷propertySourceLocators時
- 呼叫 locate 方法，傳入獲取的上下文environment
- 將source新增到PropertySource的連結串列中
- 設定source是否為空的標識標量empty
- source不為空的情況，才會設定到environment中
- 返回Environment的可變形式，可進行的操作如addFirst、addLast
- 移除propertySources中的bootstrapProperties
- 根據config server覆寫的規則，設定propertySources
- 處理多個active profiles的配置資訊
初始化方法initialize處理時，先將所有PropertySourceLocator型別的物件的locate方法遍歷，然後將各種方式得到的屬性值放到CompositePropertySource中，最後呼叫insertPropertySources(propertySources, composite)方法設定到Environment中。Spring Cloud Context中提供了覆寫遠端屬性的PropertySourceBootstrapProperties，利用該配置類進行判斷屬性源的優先順序。
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));
//如果不允許本地覆寫
if (!remoteProperties.isAllowOverride() || (!remoteProperties.isOverrideNone()
&& remoteProperties.isOverrideSystemProperties())) {
propertySources.addFirst(composite);
return;
}
//overrideNone為true，外部配置優先順序最低
if (remoteProperties.isOverrideNone()) {
propertySources.addLast(composite);
return;
}
if (propertySources
.contains(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME)) {
//根據overrideSystemProperties，設定外部配置的優先順序
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);
}
}
複製程式碼上述實現主要是根據PropertySourceBootstrapProperties中的屬性，調整多個配置源的優先順序。從其實現可以看到 PropertySourceBootstrapProperties 物件的是被直接初始化，使用的是預設的屬性值而並未注入我們在配置檔案中設定的。
修復後的實現：
@Autowired(required = false)
private PropertySourceBootstrapProperties remotePropertiesForOverriding;
private void insertPropertySources(MutablePropertySources propertySources, CompositePropertySource composite) {
MutablePropertySources incoming = new MutablePropertySources();
incoming.addFirst(composite);
PropertySourceBootstrapProperties remoteProperties = remotePropertiesForOverriding == null ? new PropertySourceBootstrapProperties() : remotePropertiesForOverriding;
...
}
複製程式碼訂閱最新文章，歡迎關注我的公眾號
