白話SpringCloud | 第八章：分布式配置中心的服務化及動態刷新

前言

上一章節，簡單介紹了分布式配置中心Spring Cloud Config的使用。同時，我們也遺漏了一些問題，比如如何配置實時生效，當服務端地址變更或者集群部署時，如何指定服務端地址？回想，在服務注冊章節，服務提供者和服務消費者，同時往注冊中心進行注冊和獲取服務地址，而本身注冊中心又支持高可用配置。所以，對於配置中心，我們也可以將Server端和Client端往注冊中心進行注冊，借此實現配置中心的服務化，無需指定具體的ip地址，直接根據服務名稱進行調用。

• 關於高可用
• Server端
• Client端
• refresh實現刷新
• 參考資料
• 總結
• 最后
• 老生常談

前言

關於高可用

將配置中心服務化，本身是為了實現高可用。而實現高可用的手段是很多的，最常用的就是負載均衡。客戶端不直連服務端，而是訪問負載均衡服務，由負載均衡來動態選擇需要訪問的服務端。只是Spring Cloud Config天然的就能進行服務化配置，所以，實際中可以根據實際的業務需求來進行合理化抉擇的。

其次，對於使用了git或者svn作為存儲方式時，本身配置倉庫的高可用也是一個需要考慮的事項。本身如github或者碼雲這些第三方git倉庫而言，已經實現了高可用了。但一般上部署的微服務都是內網服務，所以一般上是使用如gitlab開源的git倉庫管理系統進行自建，此時就需要考慮本身倉庫的高可用了。

---

注意：本身教程為了不混淆各知識點，所以都是獨立項目進行實例，而不是在原工程上進行修改。
本章節教程采用了多模塊工程進行構建實例。父類項目名為：spring-cloud-config-ha。同時創建服務化的配置文件：my-config-client-ha-dev.properties和my-config-client-ha-test.properties

my-config-client-ha-dev.properties

config=this is dev!

my-config-client-ha-dev.properties

config=this is test!

---

Server端

創建子工程：spring-cloud-confg-ha-server
0.加入pom依賴。

        <!-- config server 依賴 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
        <!-- 客戶端依賴 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>

1.配置文件加入注冊中心相關配置。

spring.application.name=spring-cloud-config-ha-server
server.port=15678

#配置文件git配置
spring.cloud.config.server.git.uri=https://github.com/xie19900123/spring-cloud-learning.git
# 搜索路徑，即配置文件的目錄，可配置多個，逗號分隔。默認為根目錄。
spring.cloud.config.server.git.searchPaths=spring-cloud-config-repo
# git用戶名和密碼 針對私有倉庫而言需要填寫
spring.cloud.config.server.git.username=
spring.cloud.config.server.git.password=

#添加注冊中心配置
# 注冊中心地址 -此為單機模式
eureka.client.service-url.defaultZone=http://127.0.0.1:1000/eureka
# 啟用ip配置 這樣在注冊中心列表中看見的是以ip+端口呈現的
eureka.instance.prefer-ip-address=true
# 實例名稱  最后呈現地址：ip:15678
eureka.instance.instance-id=${spring.cloud.client.ip-address}:${server.port}

2.啟動類加入@EnableDiscoveryClient和@EnableConfigServer,前者開啟服務發現功能，后者聲明一個config server。

/**
 * config server 服務化
 * 
 * @author oKong
 *
 */
@SpringBootApplication
@EnableConfigServer
//注意這里也可使用@EnableEurekaClient
//但由於springcloud是靈活的，注冊中心支持eureka、consul、zookeeper等
//若寫了具體的注冊中心注解，則當替換成其他注冊中心時，又需要替換成對應的注解了。
//所以 直接使用@EnableDiscoveryClient 啟動發現。
//這樣在替換注冊中心時，只需要替換相關依賴即可。
@EnableDiscoveryClient
@Slf4j
public class ConfigServerHaApplication {
    public static void main(String[] args) throws Exception {
        SpringApplication.run(ConfigServerHaApplication.class, args);
        log.info("spring-cloud-config-ha-server啟動!");
    }
}

關於Eureka相關知識點，可以查看：《第二章：服務注冊與發現(Eureka)-上》和《第三章：服務注冊與發現(Eureka)-下》，這里就不加以闡述了。

3.啟動應用，同時啟動Eureka服務端。訪問下Eureka服務端地址：http://127.0.0.1:1000/ ，可以看見服務注冊成功了。

訪問：http://127.0.0.1:15678/my-config-client-ha-dev.properties 可以看見配置信息了。

Client端

創建子工程：spring-cloud-confg-ha-client
0.加入pom依賴。

        <!-- config client 依賴 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>
        <!-- eureka client 依賴 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

1.配置文件修改，bootstrap.properties添加注冊中心配置。
bootstrap.properties

# 設置分支
spring.cloud.config.label=master
# 環境變量
spring.cloud.config.profile=dev
# 是否使用注冊中心方式進行獲取
spring.cloud.config.discovery.enabled=true
# 服務端地址 
# 在不使用注冊中心模式下 直接填寫實際地址
#spring.cloud.config.uri=http://127.0.0.1:5678
# 注冊中心應用id
spring.cloud.config.discovery.service-id=spring-cloud-config-ha-server

#添加注冊中心配置
# 注冊中心地址 -此為單機模式
eureka.client.service-url.defaultZone=http://127.0.0.1:1000/eureka
# 啟用ip配置 這樣在注冊中心列表中看見的是以ip+端口呈現的
eureka.instance.prefer-ip-address=true
# 實例名稱  最后呈現地址：ip:15678
eureka.instance.instance-id=${spring.cloud.client.ip-address}:${server.port}

application.properties

# 設置應用名稱，需要和配置文件匹配
spring.application.name=my-config-client-ha
server.port=15666

注意：注冊中心的相關配置需要放在bootstrap.properties中，這樣才能利用注冊中心進行服務端服務地址獲取。

2.啟動類，加入@EnableDiscoveryClient，開啟服務發現功能。

/**
 * 服務化方式調用config server
 * 
 * @author oKong
 *
 */
@SpringBootApplication
@EnableDiscoveryClient
@Slf4j
public class ConfigClientHaApplication {
    public static void main(String[] args) throws Exception {
        SpringApplication.run(ConfigClientHaApplication.class, args);
        log.info("spring-cloud-config-ha-client啟動!");
    }

}

3.創建控制層，測試配置參數。

/**
 * config client 簡單示例
 * @author oKong
 *
 */
@RestController
public class DemoController {

    @Value("${config}")
    String config;
    
    @GetMapping("/")
    public String demo() {
        return "返回的config參數值為:" + config;
    }
}

4.啟動應用。一般上應用能啟動成功，就說明服務化已經成功了。
啟動時，可以看見已經往注冊中心去獲取服務端地址了。

2018-10-10 23:15:15.302  INFO 26412 --- [           main] c.c.c.ConfigServicePropertySourceLocator : Fetching config from server at : http://192.168.2.102:15678/
2018-10-10 23:15:20.728  INFO 26412 --- [           main] c.c.c.ConfigServicePropertySourceLocator : Located environment: name=my-config-client-ha, profiles=[dev], label=master, version=f2645253a37db433d806914b1d04d6aba428831c, state=null

此時，我們訪問：http://127.0.0.1:15666/ ，即可看見配置信息返回了。

refresh實現刷新

在默認情況下，客戶端是不會自動感知配置的變化的。此時，我們可以使用/refresh端點來進行配置更新。
現在，我們改造下客戶端。
0.加入端點依賴。

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

1.修改下變量使用類，加入@RefreshScope注解，標記在訪問/refresh時，進行變量的更新操作。

/**
 * config client 簡單示例
 * @author oKong
 *
 */
@RestController
@RefreshScope//使用該注解的類，會在接到SpringCloud配置中心配置刷新的時候，自動將新的配置更新到該類對應的字段中。
public class DemoController {

    @Value("${config}")
    String config;
    
    @GetMapping("/")
    public String demo() {
        return "返回的config參數值為:" + config;
    }
}

重點就是注解@RefreshScope了。
2.配置文件開啟端點refresh。這里需要注意,2.0之后，默認只開啟了端點info、health。其他的需要通過management.endpoints.web.exposure.include進行額外配置。

#開啟監控端點
management.endpoints.web.exposure.include=refresh

3.啟動應用，此時，動態修改下遠程倉庫的參數值為：config=this is dev refresh!!!，
使用Postman使用POST訪問：http://127.0.0.1:15666/actuator/refresh。

返回值即為有變動的參數值。

再次訪問：http://127.0.0.1:15666/ 可以看見已經是最新的配置參數值了。

參考資料

1. https://cloud.spring.io/spring-cloud-static/Finchley.SR1/single/spring-cloud.html#_spring_cloud_config

2. https://cloud.spring.io/spring-cloud-static/Finchley.SR1/single/spring-cloud.html#refresh-scope

總結

本章節主要講解了如何將配置中心注冊為一個服務，客戶端像普通的服務消費者一樣，根據服務名即可獲取服務端地址，進而進行參數的獲取。同時講解了當屬性參數有變時，客戶端如何進行感知變化進行參數動態更新。大家應該可以想到，當我們客戶端越來越多時，一個個去執行refresh時不太現實的，雖然我們可以通過類似webhook功能當有提交記錄時，主動去觸發各客戶端的refresh方法，在前期項目比較少的情況下，不失為一個好方法，只需要維護一份待更新的客戶端地址列表即可。但當服務越來越多時，維護此列表也是令人頭疼的。此時，我們可以使用Spring cloud bus消息總線進行通知。由於目前Spring cloud bus知識點尚未開始講解，同時作者也比較少使用消息總線，所以待查閱相關之后介紹Spring Cloud bus章節時，再來進行講解如何使用消息總線進行全自動的配置更新操作。

最后

目前互聯網上大佬都有分享SpringCloud系列教程，內容可能會類似，望多多包涵了。原創不易，碼字不易，還希望大家多多支持。若文中有錯誤之處，還望提出，謝謝。

老生常談

• 個人QQ：499452441
• 微信公眾號：lqdevOps

個人博客：http://blog.lqdev.cn

源碼示例：https://github.com/xie19900123/spring-cloud-learning

原文地址：http://blog.lqdev.cn/2018/10/11/SpringCloud/chapter-eight/