1.概述
Netflix Archaius 是一個功能強大的配置管理庫窗宇。它是一個可用于從許多不同來源收集配置屬性的框架措伐,提供對配置信息的快速及線程安全訪問。
除此之外军俊,Archaius允許屬性在運行時動態(tài)更改废士,使系統(tǒng)無需重新啟動應(yīng)用程序即可獲得這些變化。
在這個介紹性文章中蝇完,我們將設(shè)置一個簡單的Spring Cloud Archaius配置官硝,我們將解釋底層發(fā)生了什么矗蕊,最后,我們將看到Spring如何擴展基本設(shè)置氢架。
2. Netflix Archaius功能
眾所周知傻咖,Spring Boot已經(jīng)提供了管理外部化配置的工具,為什么還要設(shè)置不同的機制呢岖研?
因為Archaius提供了一些其他任何配置框架都沒有考慮過的方便有趣的功能卿操。其中的一些關(guān)鍵點是:
- 動態(tài)和類型屬性
- 在屬性改變時調(diào)用的回調(diào)機制
- 動態(tài)配置源(如URL,JDBC和Amazon DynamoDB)的實現(xiàn)
- Spring Boot Actuator或JConsole可以訪問的JMX MBean孙援,用于檢查和操作屬性
- 動態(tài)屬性驗證
因此害淤,Spring Cloud已經(jīng)開發(fā)了一個庫,可以輕松配置“Spring Environment Bridge”拓售,以便Archaius可以從Spring Environment中讀取屬性窥摄。
3.依賴性
讓我們將 spring-cloud-starter-netflix-archaius 添加到我們的應(yīng)用程序中,它將為我們的項目添加所有必要的依賴項础淤。
或者崭放,我們也可以將spring-cloud-netflix添加到我們的 dependencyManagement 部分,并依賴于其工件版本的規(guī)范:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-archaius</artifactId>
</dependency>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-netflixartifactId>
<version>2.0.1.RELEASEversion>
<type>pomtype>
<scope>importscope>
<dependency>
<dependencies>
<dependencyManagement>
4.用法
一旦我們添加了所需的依賴項鸽凶,我們就能夠訪問框架管理的屬性:
DynamicStringProperty propertyOneWithDynamic = DynamicPropertyFactory.getInstance()
.getStringProperty("springcloud.archaius.properties.one", "not found!");
String propertyCurrentValue = dynamicProperty.get();
讓我們以一個簡短的例子來看看它是如何開箱即用的币砂。
4.1 快速示例
默認情況下,它動態(tài)管理應(yīng)用程序類路徑中名為config.properties的文件中定義的所有屬性玻侥。
所以我們將它添加到我們的資源文件夾中决摧,其中包含一些任意屬性:
springcloud.archaius.properties.one=one FROM:config.properties
springcloud.archaius.properties.three=three FROM:config.properties
現(xiàn)在我們需要一種在任何特定時刻檢查屬性值的方法。在這種情況下凑兰,我們將創(chuàng)建一個RestController蜜徽,將值作為JSON響應(yīng)檢索:
@RestController
public class ConfigPropertiesController {
private DynamicStringProperty propertyOneWithDynamic = DynamicPropertyFactory.getInstance()
.getStringProperty("springcloud.archaius.properties.one", "not found!");
private DynamicStringProperty propertyTwoWithDynamic = DynamicPropertyFactory.getInstance()
.getStringProperty("springcloud.archaius.properties.two", "not found!");
private DynamicStringProperty propertyThreeWithDynamic = DynamicPropertyFactory.getInstance()
.getStringProperty("springcloud.archaius.properties.three", "not found!");
private DynamicStringProperty propertyFourWithDynamic = DynamicPropertyFactory.getInstance()
.getStringProperty("springcloud.archaius.properties.four", "not found!");
@GetMapping("/properties-from-dynamic")
public Map<String, String> getPropertiesFromDynamic() {
Map<String, String> properties = new HashMap<>();
properties.put(propertyOneWithDynamic.getName(), propertyOneWithDynamic.get());
properties.put(propertyTwoWithDynamic.getName(), propertyTwoWithDynamic.get());
properties.put(propertyThreeWithDynamic.getName(), propertyThreeWithDynamic.get());
properties.put(propertyFourWithDynamic.getName(), propertyFourWithDynamic.get());
return properties;
}
}
我們來試試吧。我們可以向/properties-from-dynamic發(fā)送請求票摇,服務(wù)將按預(yù)期檢索存儲在config.properties中 的值拘鞋。
到目前為止沒什么大不了的,對吧矢门?好的盆色,讓我們繼續(xù)并更改類路徑文件中屬性的值,而無需重新啟動服務(wù)祟剔。在一分鐘左右之后隔躲,對端點的調(diào)用應(yīng)檢索出新值。
接下來物延,我們將嘗試了解幕后發(fā)生的事情宣旱。
5.它是如何工作的?
首先叛薯,讓我們試著理解大局浑吟。
Archaius是Apache的Commons Configuration庫的擴展笙纤,添加了一些很好的功能,如動態(tài)源的輪詢框架组力,具有高吞吐量和線程安全的實現(xiàn)省容。
然后 spring-cloud-netflix-archaius 庫進入,合并所有不同的屬性源燎字,并使用這些源自動配置Archaius工具腥椒。
5.1 Netflix Archaius庫
它定義了一個復(fù)合配置,是可以從不同來源獲得的各種配置的集合候衍。
此外笼蛛,其中一些配置源可以支持在運行時輪詢更改。Archaius提供接口和一些預(yù)定義的實現(xiàn)來配置這些類型的源蛉鹿。
源集合是分層的滨砍,因此如果屬性存在于多個配置中,則最終值將是最頂部插槽中的值榨为。
最后, ConfigurationManager處理系統(tǒng)范圍的配置和部署上下文煌茴。它可以安裝最終的復(fù)合配置随闺,或檢索已安裝的復(fù)合配置進行修改。
5.2 Spring Cloud支持
Spring Cloud Archaius庫的主要任務(wù)是將所有不同的配置源合并為 ConcurrentCompositeConfiguration蔓腐,并使用ConfigurationManager進行安裝 矩乐。
庫定義源的優(yōu)先順序是:
- 上下文中定義的任何Apache公共配置AbstractConfiguration bean
- Autowired Spring ConfigurableEnvironment中定義的所有源代碼
- 默認的Archaius源,我們在上面的例子中看到過
- Apache的SystemConfiguration和EnvironmentConfiguration 源
Spring Cloud庫提供的另一個有用功能是定義一個Actuator Endpoint 來監(jiān)控屬性并與之交互回论。
6.調(diào)整和擴展Archaius配置
現(xiàn)在我們已經(jīng)更好地理解了Archaius的工作原理散罕,我們很好地分析了如何使配置適應(yīng)我們的應(yīng)用程序,或者如何使用我們的配置源擴展功能傀蓉。
6.1 Archaius支持的配置屬性
如果我們希望Archaius考慮類似于config.properties的其他配置文件 欧漱,我們可以定義 archaius.configurationSource.additionalUrls系統(tǒng)屬性。
該值被解析為由逗號分隔的URL列表葬燎,因此误甚,例如,我們可以在啟動應(yīng)用程序時添加此系統(tǒng)屬性:
-Darchaius.configurationSource.additionalUrls="classpath:other-dir/extra.properties,file:///home/user/other-extra.properties"
Archaius將首先讀取config.properties文件谱净,然后按指定的順序讀取其他文件窑邦。因此,后面文件中定義的屬性將優(yōu)先于先前的屬性壕探。
我們可以使用幾個其他系統(tǒng)屬性來配置Archaius默認配置的各個方面:
- archaius.configurationSource.defaultFileName:類路徑中的默認配置文件名
- archaius.fixedDelayPollingScheduler.initialDelayMills:讀取配置源之前的初始延遲
- archaius.fixedDelayPollingScheduler.delayMills:兩次讀取源之間的延遲; 默認值為1分鐘
6.2 使用Spring添加其他配置源
我們?nèi)绾翁砑右粋€不同的配置源來由所描述的框架管理冈钦?我們?nèi)绾喂芾韮?yōu)先級高于Spring環(huán)境中定義的動態(tài)屬性?
回顧我們在4.2節(jié)中提到的內(nèi)容李请,我們可以發(fā)現(xiàn)Spring定義的Composite Configuration中的最高配置是在上下文中定義的 AbstractConfiguration bean瞧筛。
因此厉熟,我們需要做的就是使用Archaius提供的一些功能將這個Apache的抽象類的實現(xiàn)添加到我們的Spring Context中,Spring的自動配置會自動將它添加到托管配置屬性中驾窟。
為了簡單起見庆猫,我們將看到一個示例,我們配置一個類似于默認config.properties的屬性文件绅络,但其優(yōu)先級高于Spring環(huán)境和應(yīng)用程序?qū)傩缘钠溆嗖糠郑?/p>
@Configuration
public class ApplicationPropertiesConfigurations {
@Bean
public AbstractConfiguration addApplicationPropertiesSource() {
PolledConfigurationSource source = new URLConfigurationSource("classpath:other-config.properties");
return new DynamicConfiguration(source, new FixedDelayPollingScheduler());
}
}
幸運的是月培,它考慮了幾個配置源,我們幾乎可以毫不費力地設(shè)置恩急。
7.結(jié)論
總而言之杉畜,我們已經(jīng)了解了Archaius以及它為利用配置管理提供的一些很酷的功能。
此外衷恭,我們還看到了Spring Cloud自動配置庫如何發(fā)揮作用此叠,使我們可以方便地使用該庫的API。
本文中顯示的示例的Github倉庫随珠。