帶你入門SpringCloud統一配置 | SpringCloud Config

時間 2020-01-04

標籤入門 springcloud 統一配置 config 简体版

原文原文鏈接

前言

在微服務中衆多服務的配置必然會出現相同的配置，若是配置發生變化須要修改，一個個去修改而後重啓項目的方案是絕對不可取的。而 SpringCloud Config 就是一個能夠幫助你實現統一配置選擇之一。html

若是你不懂 SpringCloud Config 環境搭建，那麼該篇博客將會幫助到你，文中經過具體操做帶你瞭解 SpringCloud Config 環境搭建的入門操做。java

閱讀本文須要你熟悉 SpringBoot 項目的基本使用便可，還有一點須要注意的是在操做過程當中儘可能和我本地環境一致，由於環境不一致可能會帶來一些問題。我本地環境以下：git

SpringBoot Version: 2.1.0.RELEASE
SpringCloud Version: Greenwich.RELEASE
Apache Maven Version： 3.6.0
Java Version： 1.8.0_144
IDEA：Spring Tools Suite (STS)

接下來就開始 SpringCloud Config 環境搭建操做介紹！github

搭建 SpringCloud Config 環境

SpringCloud Config 環境搭建最小環境須要 3個 SpringCloud 項目：一臺 Eureka Server 端、一臺 Config Server 端（也是Eureka Client 端）、一臺普通服務端（便是 Config Client 也是 Eureka Client）。web

關於Eureka環境的搭建請參考個人另外一篇博客帶你入門SpringCloud服務發現 | Eurka搭建和使用spring

Config Server 端搭建

在 SpringBoot 項目中引入 spring-cloud-config-server 和 spring-cloud-starter-netflix-eureka-client 依賴，具體代碼以下：bootstrap

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

在 SpringBoot Application 上聲明 @EnableDiscoveryClient 和 @EnableConfigServer，具體代碼以下：segmentfault

@SpringBootApplication
@EnableDiscoveryClient
@EnableConfigServer
public class SpringCloudConfigServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringCloudConfigServerApplication.class, args);
    }

}

在 GitHub上建立私有倉庫

而後添加配置信息到 GitHub 上。

app

product.properties 配置能夠添加一些公共的配置他會覆蓋到 product-dev.properties上

在 application.properties 添加配置信息maven

spring.application.name=CONFIGSERVER
eureka.client.service-url.defaultZone=http://localhost:8761/eureka/

spring.cloud.config.server.git.uri=https://github.com/zhuoqianmingyue/config-repo
spring.cloud.config.server.git.username=github賬號
spring.cloud.config.server.git.password=github賬號密碼
spring.cloud.config.server.git.basedir=config-repo/config-repo

spring.application.name：服務的名稱
eureka.client.service-url.defaultZone：Eureka Server 地址
spring.cloud.config.server.git.uri：配置GitHub 私有倉庫 HTTP 克隆地址
spring.cloud.config.server.git.username：配置你的 github賬號
spring.cloud.config.server.git.password：配置你的github賬號密碼
spring.cloud.config.server.git.basedir：克隆配置文件存儲地址

Config Server 端高可用只須要配置多臺Config Server註冊到Eureka 服務端便可。

測試

第一步啓動 Eurka Server 端（具體代碼請從個人GitHub項目獲取，GitHub地址下面有介紹）

將 spring-cloud-config-eureka-service 進行打包，經過 mvn clean package -Dmaven.test.skip=true。

進入 target 目錄經過 java -jar 方式啓動。

第二步啓動 Config Server 端

第三步最後訪問 Eurka Server 端，以下圖所示：

CONFIGSERVER 已經註冊到 Eurka Server 服務端。

訪問 Config Server 端獲取配置信息，具體訪問地址：http://localhost:8080/product-dev.properties。訪問結果以下圖所示：

到這裏 Config Server 端搭建介紹完畢！接下來開始 Config Client 端搭建介紹。

Config Client 端搭建(商品服務)

在商品服務 SpringBoot 項目中引入 spring-cloud-config-client 和 spring-cloud-starter-netflix-eureka-client 依賴。具體代碼以下：

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

在 SpringBoot Application上聲明 @EnableDiscoveryClient

@SpringBootApplication
@EnableDiscoveryClient
public class SpringCloudConfigProductServiceApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringCloudConfigProductServiceApplication.class, args);
    }

}

在 srcmainresources 目錄下建立 bootstrap.properties，具體代碼以下：

spring.cloud.config.discovery.service-id=CONFIGSERVER
spring.cloud.config.discovery.enabled=true
spring.cloud.config.profile=dev
spring.application.name=product

eureka.client.service-url.defaultZone=http://localhost:8761/eureka/

spring.cloud.config.discovery.service-id：Config Server 服務名
spring.cloud.config.discovery.enabled：是否開啓配置發現
spring.cloud.config.profile：啓用那個後綴的配置文件
eureka.client.service-url.defaultZone：Eureka Server 地址
spring.application.name：服務的名稱

鏈接接Config Server配置 spring.cloud.config.xx 和 eureka Server 端配置eureka.client.service-url.defaultZone= http://localhost:8761/eureka/ 必定要配置到bootstrap.properties中，不然根不獲取不到 Config Server 的配置信息。

測試

第一步啓動 Eurka Server端和 Config Server 端。
第二步啓動 Config Client (商品服務) 端
第三步訪問 Eurka Server 端，以下圖所示：

PRODUCT 已經註冊到 Eurka Server 服務端。

第四步：編寫獲取 Config Server 上配置信息的 Controller，具體代碼以下：

獲取的就是紅色框的 env 配置項的值。

@RestController
public class EvnController {
    @Value("${env}")
    private String env;
    
    @RequestMapping("/env")
    public String evn() {
        return this.env;
    }
}

遊覽器訪問 localhost:8763/product/env 進行測試，具體結果以下：