跟我學SpringCloud | 第六篇：Spring Cloud Config Github配置中心

時間  2020-05-30
標籤 springcloud 第六 spring cloud config github 配置 中心 欄目 Spring 简体版
原文   原文鏈接

SpringCloud系列教程 | 第六篇：Spring Cloud Config Github配置中心

Springboot: 2.1.6.RELEASEhtml

SpringCloud: Greenwich.SR1java

如無特殊說明，本系列教程全採用以上版本node

隨着分佈式項目愈來愈大，勤勞的程序猿們會開始面臨一個挑戰，配置文件會愈來愈繁雜，雖然spring提供了一個雞肋版的解決方案，spring.profiles.active，在大型的分佈式項目體系中，聊勝於無吧，手動維護配置文件的痛苦，生產，UAT，測試，開發環境的隔離，額外的配置文件，如：logback.xml日誌的配置文件，bootstrap.properties配置文件，當系統中有幾十個服務，相應的會有上百個配置文件，簡直就是史詩級的災難大片，每次發佈上線，都要手動去檢查配置文件，相應的服務都須要重啓，那麼，有沒有一種方案，能夠自動更新配置，而且對版本作出相應的控制，剛好，springcloud爲咱們提供了這樣一種工具，雖然不少方面都還不完善，配置能力比較弱，可是也給咱們提供了一種思路。git

市面上有不少配置中心，BAT每家都出過，360的QConf、淘寶的diamond、百度的disconf都是解決這類問題。國外也有不少開源的配置中心Apache Commons Configuration、owner、cfg4j等等。這些開源的軟件以及解決方案都很優秀，也存在這樣或者那樣的缺陷。今天咱們要了解的Spring Cloud Config，能夠無縫的和spring體系相結合，夠方便夠簡單顏值高。github

1. Spring Cloud Config

在介紹Spring Cloud Config以前，咱們能夠先憑空想一下一個配置中心須要提供的核心功能有哪些：web

  • 提供客戶端和服務端的支持
  • 提供各個環境的配置
  • 配置文件修改後能夠快速生效
  • 能夠提供不一樣版本的管理
  • 能夠支持不一樣的語言（java、.Net、Delphi、node等）
  • 支持必定數量的併發
  • 高可用（防止意外宕機致使配置不可用）

Spring Cloud Config項目是一個解決分佈式系統的配置管理方案。它包含了Client和Server兩個部分，server提供配置文件的存儲、以接口的形式將配置文件的內容提供出去，client經過接口獲取數據、並依據此數據初始化本身的應用。Spring cloud使用git或svn存放配置文件，默認狀況下使用git，咱們先以git爲例作一套示例。spring

首先在github上面建立了一個文件夾springcloud-config用來存放配置文件，爲了模擬生產環境，咱們建立如下三個配置文件：apache

// 開發環境
springcloud-config-dev.properties
// 測試環境
springcloud-config-test.properties
// 生產環境
springcloud-config-pro.properties

每一個配置文件中都寫一個屬性springcloud.hello,屬性值分別是 hello dev/test/pro。下面咱們開始配置server端bootstrap

2. Server端

1. pom.xml

<?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>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.6.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.springcloud</groupId>
	<artifactId>config-server</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>config-server</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
		<spring-cloud.version>Greenwich.SR1</spring-cloud.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-config-server</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-dependencies</artifactId>
				<version>${spring-cloud.version}</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

2. 配置文件

server:
  port: 8080
spring:
  application:
    name: spring-cloud-config-server
  cloud:
    config:
      server:
        git:
          uri: https://github.com/meteor1993/SpringCloudLearning # git倉庫的地址
          search-paths: chapter6/springcloud-config  # git倉庫地址下的相對地址，能夠配置多個，用,分割。
          username: #Git倉庫用戶名
          password: #Git倉庫密碼

Spring Cloud Config也提供本地存儲配置的方式。咱們只須要設置屬性spring.profiles.active=native，Config Server會默認從應用的src/main/resource目錄下檢索配置文件。也能夠經過spring.cloud.config.server.native.searchLocations=file:E:/properties/屬性來指定配置文件的位置。雖然Spring Cloud Config提供了這樣的功能，可是爲了支持更好的管理內容和版本控制的功能，仍是推薦使用git的方式。瀏覽器

3. 啓動類 ConfigServerApplication

package com.springcloud.configserver;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;

@SpringBootApplication
@EnableConfigServer
public class ConfigServerApplication {

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

}

增長@EnableConfigServer註解，激活對配置中心的支持

4. 測試

首先測試咱們的server端可否從github上獲取到咱們須要的信息，直接訪問：http://localhost:8080/springcloud-config/pro， 注意： springcloud-config是文件夾的前綴命名，能夠看到以下結果：

{
    "name":"springcloud-config",
    "profiles":[
        "pro"
    ],
    "label":null,
    "version":"4e3d1a93e869fb336254c480ed1e5b36d58124aa",
    "state":null,
    "propertySources":[
        {
            "name":"https://github.com/meteor1993/SpringCloudLearning/chapter6/springcloud-config/springcloud-config-pro.properties",
            "source":{
                "springcloud.hello":"hello pro"
            }
        }
    ]
}

上述的返回的信息包含了配置文件的位置、版本、配置文件的名稱以及配置文件中的具體內容，說明server端已經成功獲取了git倉庫的配置信息。

若是直接查看配置文件中的配置信息可訪問：http://localhost:8080/springcloud-config-dev.properties， 返回：springcloud.hello: hello dev

修改配置文件springcloud-config-dev.properties中配置信息爲：springcloud.hello=hello dev update，再次在瀏覽器訪問http://localhost:8080/springcloud-config-dev.properties，返回：springcloud.hello: hello dev update。說明server端會自動讀取自動提交功能。

倉庫中的配置文件會被轉換成web接口，訪問能夠參照如下的規則：

  • /{application}/{profile}[/{label}]
  • /{application}-{profile}.yml
  • /{label}/{application}-{profile}.yml
  • /{application}-{profile}.properties
  • /{label}/{application}-{profile}.properties

以springcloud-config-dev.properties爲例，它的application是springcloud-config，profile是dev，label是分支的意思，若是隻有一個主分支，能夠不寫，默認會訪問master分支，client會根據填寫的參數來選擇讀取對應的配置。

3. client端

主要展現如何在業務項目中去獲取server端的配置信息。

1. pom.xml

<?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>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.6.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.springcloud</groupId>
	<artifactId>config-client</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>config-client</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
		<spring-cloud.version>Greenwich.SR1</spring-cloud.version>
	</properties>

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

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-dependencies</artifactId>
				<version>${spring-cloud.version}</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

2. 配置文件

這裏配置文件分兩個，application.yml和bootstrap.properties

application.yml以下：

server:
  port: 8081
spring:
  application:
    name: spring-cloud-config-client

bootstrap.properties以下：

spring.cloud.config.name=springcloud-config
spring.cloud.config.profile=dev
spring.cloud.config.uri=http://localhost:8080/
spring.cloud.config.label=master
  • spring.application.name：對應{application}部分
  • spring.cloud.config.profile：對應{profile}部分
  • spring.cloud.config.label：對應git的分支。若是配置中心使用的是本地存儲，則該參數無用
  • spring.cloud.config.uri：配置中心的具體地址
  • spring.cloud.config.discovery.service-id：指定配置中心的service-id，便於擴展爲高可用配置集羣。

注意：上面這些與spring-cloud相關的屬性必須配置在bootstrap.properties中，config部份內容才能被正確加載。由於config的相關配置會先於application.properties，而bootstrap.properties的加載也是先於application.yml。

3. 啓動類

package com.springcloud.configclient;

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

@SpringBootApplication
public class ConfigClientApplication {

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

}

啓動類只須要@SpringBootApplication註解就能夠，常規操做。

4. 訪問類

package com.springcloud.configclient.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Author: shiyao.wei
 * @Date: 2019/7/4 16:19
 * @Version: 1.0
 * @Desc:
 */
@RestController
public class HelloController {

    @Value("${springcloud.hello}")
    private String hello;

    @RequestMapping("/hello")
    public String from() {
        return this.hello;
    }
}

使用@Value註解來獲取server端參數的值

5. 測試

啓動client端，訪問連接：http://localhost:8081/hello， 返回：hello dev update，說明已經正確的從server端獲取到了參數。到此一個完整的服務端提供配置服務，客戶端獲取配置參數的例子就完成了。

能夠再進行一個小實驗，咱們再次修改springcloud-config-dev.properties中的內容爲：hello dev update1，提交至github後，再次訪問http://localhost:8081/hello，能夠發現，返回的內容仍是hello dev update，這是爲何呢？由於springboot項目只有在啓動的時候纔會獲取配置文件的值，修改github信息後，client端並無在次去獲取，因此致使這個問題。如何去解決這個問題呢？留到下一篇咱們在介紹。

示例代碼-Github

參考：http://www.ityouknow.com/springcloud/2017/05/22/springcloud-config-git.html

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程