SpringCloud（第 036 篇）單點手動動態刷新ConfigClient配置

SpringCloud（第 036 篇）單點手動動態刷新ConfigClient配置

-

1、大體介紹

一、當ConfigServer啓動後，假如咱們新增配置內容的話，是否是要從新啓動一下ConfigServer呢？
二、答案確定是不須要從新啓動的，由於 SpringCloud 給咱們提供了一個刷新的觸發機制，這樣即可以在不從新的狀況下從新加載最新配置文件內容；

三、這裏還順便列舉下配置路徑的規則：
/****************************************************************************************
 * 配置服務的路勁規則：
 *
 * /{application}/{profile}[/{label}]
 * /{application}-{profile}.yml
 * /{label}/{application}-{profile}.yml
 * /{application}-{profile}.properties
 * /{label}/{application}-{profile}.properties
 ****************************************************************************************/

2、實現步驟

2.1 添加 maven 引用包

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <artifactId>springms-config-client-refresh</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <parent>
        <groupId>com.springms.cloud</groupId>
        <artifactId>springms-spring-cloud</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <dependencies>
        <!-- 客戶端配置模塊 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>

        <!-- web模塊 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- 監控和管理生產環境的模塊 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
    </dependencies>

</project>

2.2 添加應用配置文件（springms-config-client-refresh/src/main/resources/application.yml）

server:
  port: 8295


#####################################################################################################
# 配置服務客戶端Client應用入口（正常測試 ConfigClient ）
# profile: profile-dev
#####################################################################################################





#####################################################################################################
# 配置服務客戶端Client應用入口（連接 ClientServer 測試，同時本地也有一份配置文件，那麼該如何抉擇呢？）
# profile: profile-local-dev
#####################################################################################################

2.3 添加 bootstrap.yml 應用配置文件（springms-config-client-refresh/src/main/resources/bootstrap.yml）

#####################################################################################################
# 配置服務客戶端Client應用入口（連接 ClientServer 測試）
spring:
  cloud:
    config:
      uri: http://localhost:8220
      profile: refresh
      label: master #當 ConfigServer 的後端存儲的是 Git 的時候，默認就是 master

  application:
    name: foobar  #取 foobar-refresh.yml 這個文件的 application 名字，即爲 foobar 名稱
#####################################################################################################

2.4 添加Web控制層類(springms-config-client-refresh/src/main/java/com/springms/cloud/controller/ConfigClientRefreshController.java）

package com.springms.cloud.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 配置客戶端Controller。
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 17/10/18
 *
 */
@RestController
@RefreshScope
public class ConfigClientRefreshController {

    @Value("${profile}")
    private String profile;

    @GetMapping("/profile")
    public String getProfile(){
        return this.profile;
    }
}

2.5 添加應用啓動類（springms-config-client-refresh/src/main/java/com/springms/cloud/MsConfigClientRefreshApplication.java）

package com.springms.cloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * 單點手動動態刷新ConfigClient配置。<br/>
 *
 * ConfigClient 配置客戶端服務想要實現自動刷新配置的話，ConfigServer 一端是不要作任何處理，只須要在 ConfigClient 一端處理便可。
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 17/10/18
 *
 */
@SpringBootApplication
public class MsConfigClientRefreshApplication {

    public static void main(String[] args) {
        SpringApplication.run(MsConfigClientRefreshApplication.class, args);
        System.out.println("【【【【【【 ConfigClientRefresh微服務 】】】】】】已啓動.");
    }
}

3、測試

/****************************************************************************************
 application.yml 涉及到的連接文件內容展現以下：

 修改內容前：
 http://git.oschina.net/ylimhhmily/OpenSource_CustomCircleLineProgressBar/blob/master/foobar-refresh.yml
 profile: profile-refresh

 修改內容後：
 http://git.oschina.net/ylimhhmily/OpenSource_CustomCircleLineProgressBar/blob/master/foobar-refresh.yml
 profile: profile-refresh-refresh
 ****************************************************************************************/

/****************************************************************************************
 1、配置刷新服務客戶端Client應用入口（單點手動動態刷新配置服務客戶端配置）：

 一、添加註解 RefreshScope，而後添加引用模塊 spring-boot-starter-actuator 監控和管理生產環境的模塊；
 二、編輯 application.yml 文件，添加相關客戶端配置；
     spring:
         cloud:
             config:
                 uri: http://localhost:8220
                 profile: refresh
                 label: master #當 ConfigServer 的後端存儲的是 Git 的時候，默認就是 master
    
         application:
            name: foobar  #取 foobar-refresh.yml 這個文件的 application 名字，即爲 foobar 名稱
 三、啓動 springms-config-server 模塊服務，啓動1個端口；
 四、啓動 springms-config-client-refresh 模塊服務，啓動1個端口；
 五、在瀏覽器輸入地址 http://localhost:8295/profile 正常狀況下會輸出遠端服務的配置內容（內容爲：profile: profile-refresh）；

 六、修改 http://git.oschina.net/ylimhhmily/OpenSource_CustomCircleLineProgressBar/blob/master/foobar-refresh.yml 內容，修改後爲 profile: profile-refresh-refresh；
 七、打開windows命令窗口，執行命令： >curl.exe -X POST http://localhost:8295/refresh
 八、而後刷新 http://localhost:8295/profile 網頁，正常狀況下會輸出遠端服務的配置內容（內容爲：profile: profile-refresh-refresh）；

 總結：這裏經過執行刷新命令才得以將遠端配置內容刷新到配置服務客戶端。
 ****************************************************************************************/

4、下載地址

https://git.oschina.net/ylimhhmily/SpringCloudTutorial.git

SpringCloudTutorial交流QQ羣: 235322432

SpringCloudTutorial交流微信羣: 微信溝通羣二維碼圖片連接

歡迎關注，您的確定是對我最大的支持!!!