Spring Cloudt整合Netflix Archaius之多資料來源
1.概述
Netflix Archaius提供了用於連線許多資料來源的類庫和功能。
在本教程中，我們將學習如何獲取配置：
- 使用JDBC API連線到資料庫
- 讀取來自儲存在DynamoDB例項中的配置
- 通過Zookeeper配置為動態分散式配置
有關Netflix Archaius的介紹，請檢視本文。
2.將Netflix Archaius與JDBC連線一起使用
正如我們在介紹性教程中所解釋的，每當我們希望Archaius處理配置時，我們都需要建立一個Apache的AbstractConfiguration bean。
Bean將由Spring Cloud Bridge自動捕獲並新增到Archaius的Composite Configuration堆疊中。
2.1 依賴
使用JDBC連線到資料庫所需的所有功能都包含在核心庫中，因此除了我們在介紹性教程中提到的那些之外，我們不需要任何額外的依賴：
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-archaius</artifactId>
</dependency>
2.2 如何建立配置Bean
在這種情況下，我們需要使用JDBCConfigurationSource例項建立AbstractConfiguration bean 。
為了說明如何從JDBC資料庫獲取值，我們必須指定：
- 一個javax.sql.Datasource物件
- 一個SQL查詢字串，它將使用配置的鍵及其對應的值檢索至少兩列
- 兩列分別表示屬性鍵和值
讓我們繼續建立這個bean：
@Autowired DataSource h2DataSource; @Bean public AbstractConfiguration addApplicationPropertiesSource() { PolledConfigurationSource source = new JDBCConfigurationSource(h2DataSource, "select distinct key, value from properties", "key", "value"); return new DynamicConfiguration(source, new FixedDelayPollingScheduler()); }
2.3 示例
為了保持簡單並且仍然有一個操作示例，我們將使用一些初始資料設定H2記憶體資料庫例項。
為此，我們首先新增必要的依賴項：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>runtime</scope>
</dependency>
接下來，我們將宣告將包含我們的屬性的JPA實體：
@Entity
public class Properties {
@Id
private String key;
@SuppressWarnings("unused")
private String value;
}
我們將在我們的資源中包含一個data.sql檔案，用一些初始值填充記憶體資料庫：
insert into properties
values('springcloud.archaius.properties.one', 'one FROM:jdbc_source');
insert into properties
values('springcloud.archaius.properties.three', 'three FROM:jdbc_source');
最後，要檢查任何給定點的屬性值，我們可以建立一個端點來檢索由Archaius管理的值：
@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!");
@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());
return properties;
}
}
如果資料在任何時候發生變化，Archaius將在執行時檢測到它並開始檢索新值。
訪問地址 http://localhost:8082/properties-from-dynamic
3.如何使用DynamoDB例項建立配置源
DynamoDB是AWS上完全託管的NoSQL資料庫，類似於其他NoSQL資料庫，如Cassandra或MongoDB。DynamoDB提供快速，一致和可預測的效能，並且具有大規模可擴充套件性。
首先需要在本地啟動DynamoDB例項。可從官網下載dynamodb_local_latest.zip。
解壓後在命令列中輸入下面命令啟動
java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar -sharedDb
3.1 依賴
我們將以下庫新增到我們的pom.xml檔案中：
<dependencies>
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-dynamodb</artifactId>
</dependency>
<dependency>
<groupId>com.github.derjust</groupId>
<artifactId>spring-data-dynamodb</artifactId>
<version>${spring.dynamo.version}</version>
</dependency>
<dependency>
<groupId>com.netflix.archaius</groupId>
<artifactId>archaius-aws</artifactId>
<version>${archaius.version}</version>
</dependency>
</dependencies>
<properties>
<spring.dynamo.version>4.5.0</spring.dynamo.version>
<archaius.version>0.7.6</archaius.version>
</properties>
在 AWS-java的SDK-dynamodb依存庫將允許我們建立DynamoDB客戶端連線到資料庫。
使用 spring-data-dynamodb庫，我們將設定DynamoDB儲存庫。
最後，我們將使用archaius-aws庫來建立AbstractConfiguration。
3.2 使用DynamoDB作為配置源
這次，將使用DynamoDbConfigurationSource物件建立AbstractConfiguration ：
@Autowired
AmazonDynamoDB amazonDynamoDb;
@Bean
public AbstractConfiguration addApplicationPropertiesSource() {
initDatabase();
PolledConfigurationSource source = new DynamoDbConfigurationSource(amazonDynamoDb);
return new DynamicConfiguration(source, new FixedDelayPollingScheduler());
}
預設情況下，Archaius會搜尋名為“archaiusProperties”的表，其中包含Dynamo資料庫中的“key”和“value”屬性，以用作源。
如果我們想要覆蓋這些值，我們必須宣告以下系統屬性：
- com.netflix.config.dynamo.tableName
- com.netflix.config.dynamo.keyAttributeName
- com.netflix.config.dynamo.valueAttributeName
3.3 建立一個功能齊全的示例
我們將首先安裝一個本地DynamoDB例項來輕鬆測試功能。
要使用一些初始資料填充資料庫，我們將首先建立一個DynamoDBTable實體來對映資料：
@DynamoDBTable(tableName = "archaiusProperties")
public class ArchaiusProperties {
@DynamoDBHashKey
@DynamoDBAttribute
private String key;
@DynamoDBAttribute
private String value;
}
接下來，我們將為此實體建立一個CrudRepository：
public interface ArchaiusPropertiesRepository extends CrudRepository<ArchaiusProperties, String> {
}
最後，我們將使用儲存庫和AmazonDynamoDB例項建立表並在之後插入資料：
@Autowired
AmazonDynamoDB amazonDynamoDb;
@Autowired
private ArchaiusPropertiesRepository repository;
private void initDatabase() {
// Create the table
DynamoDBMapper mapper = new DynamoDBMapper(amazonDynamoDb);
CreateTableRequest tableRequest = mapper.generateCreateTableRequest(ArchaiusProperties.class);
tableRequest.setProvisionedThroughput(new ProvisionedThroughput(1L, 1L));
TableUtils.createTableIfNotExists(amazonDynamoDb, tableRequest);
// Populate the table
ArchaiusProperties property = new ArchaiusProperties("springcloud.archaius.properties.one", "one FROM:dynamoDB");
ArchaiusProperties property3 = new ArchaiusProperties("springcloud.archaius.properties.three", "three FROM:dynamoDB");
repository.save(Arrays.asList(property, property3));
}
我們可以在建立DynamoDbConfigurationSource之前呼叫此方法。
4.如何設定動態Zookeeper分散式配置
使用Zookeeper的一個好處是可以將它用作分散式配置儲存。
如果我們將它與Archaius結合起來，我們最終會得到一個靈活且可擴充套件的配置管理解決方案。
4.1 依賴
讓我們按照Spring Cloud的官方說明設定Apache的Zookeeper穩定的版本。
唯一的區別是我們只需要Zookeeper提供的部分功能，因此我們可以使用spring-cloud-starter-zookeeper-config依賴，而不是官方指南中使用的依賴：
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-zookeeper-config</artifactId>
<version>${cloud.zookeeper.version}</version>
<exclusions>
<exclusion>
<groupId>org.apache.zookeeper</groupId>
<artifactId>zookeeper</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.zookeeper</groupId>
<artifactId>zookeeper</artifactId>
<version>${zookeeper.version}</version>
<exclusions>
<exclusion>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<properties>
<cloud.zookeeper.version>2.0.0.RELEASE</cloud.zookeeper.version>
<zookeeper.version>3.4.13</zookeeper.version>
</properties>
4.2 Spring Cloud的自動配置
正如官方文件中所解釋的那樣，包括spring-cloud-starter-zookeeper-config依賴關係足以設定Zookeeper屬性源。
預設情況下，只有一個源是自動配置的，在config / application Zookeeper節點下搜尋屬性 。因此，此節點用作不同應用程式之間的共享配置源。
此外，如果我們使用spring.application.name屬性指定應用程式名稱，則會自動配置另一個源，這次在config/<app_name>節點中搜索屬性 。
這些父節點下的每個節點名稱將指示屬性鍵，其資料將是屬性值。
幸運的是，由於Spring Cloud將這些屬性源新增到上下文中，因此Archaius會自動管理它們。無需以程式設計方式建立AbstractConfiguration。
4.3 準備初始資料
在這種情況下，我們還需要一個本地Zookeeper伺服器來將配置儲存為節點。我們可以按照Apache的指南來設定在埠2181上執行的獨立伺服器。
要連線到Zookeeper服務並建立一些初始資料，我們將使用 Apache的Curator客戶端：
@Component
public class ZookeeperConfigsInitializer {
private static final String CONFIG_BASE_NODE_PATH = "/config";
private static final String APPLICATION_BASE_NODE_PATH = CONFIG_BASE_NODE_PATH + "/application";
@Autowired
CuratorFramework client;
@EventListener
public void appReady(ApplicationReadyEvent event) throws Exception {
String pathOne = APPLICATION_BASE_NODE_PATH + "/springcloud.archaius.properties.one";
String valueOne = "one FROM:zookeeper";
String pathThree = APPLICATION_BASE_NODE_PATH + "/springcloud.archaius.properties.three";
String valueThree = "three FROM:zookeeper";
createBaseNodes();
setValue(pathOne, valueOne);
setValue(pathThree, valueThree);
}
private void setValue(String path, String value) throws Exception {
if (client.checkExists()
.forPath(path) == null) {
client.create()
.forPath(path, value.getBytes());
} else {
client.setData()
.forPath(path, value.getBytes());
}
}
private void createBaseNodes() throws Exception {
if (client.checkExists()
.forPath(CONFIG_BASE_NODE_PATH) == null) {
client.create()
.forPath(CONFIG_BASE_NODE_PATH);
}
if (client.checkExists()
.forPath(APPLICATION_BASE_NODE_PATH) == null) {
client.create()
.forPath(APPLICATION_BASE_NODE_PATH);
}
}
}
我們可以檢查日誌以檢視屬性源，以驗證Netflix Archaius在更改後是否重新整理了屬性。
5.結論
在本文中，我們已經瞭解瞭如何使用Netflix Archaius設定高階配置源。我們必須考慮到它還支援其他來源，例如Etcd，Typesafe，AWS S3檔案和JCloud。
可以在Github倉庫中看到完整示例。