Spring Cloud Config 基礎示例
阿新 • • 發佈：2018-11-27
Spring Cloud Config 簡介
什麼是Srping Cloud Config?
- Spring Cloud Config 是一種分散式配置中心框架， 為分散式系統中的外部化配置提供伺服器和客戶端支援。(同類技術還有vault，zookeeper，Consul)
- 使用Config Server，可以在所有環境中管理應用程式的外部屬性。客戶端和伺服器上的概念對映與Spring Environment和PropertySource抽象，因此它們非常適合Spring應用程式，但可以與任何語言執行的任何應用程式一起使用。當應用程式通過部署管道從開發到測試並進入生產時，您可以管理這些環境之間的配置，並確保應用程式具有遷移時需要執行的所有內容。伺服器儲存後端的預設實現使用git，因此它可以輕鬆支援配置環境的標記版本，以及可用於管理內容的各種工具。
- Spring Cloud Config也主要由兩部分組成：
- Config-Server: 用於配置外部的資原始檔,支援對屬性值進行加解密
- Config-client：繫結到config server使用遠端配置檔案初始化spring，支援對屬性值進行加解密
###本文示例說明###
- 為了更直觀的理解spring cloud config，本文通過server獲取整個配置，效果上與通過配置springboot的active 來切換環境一致；通過介面查詢資料庫以檢視效果；
- 採用高可用架構；此處使用eureka去做服務註冊發現（暫時也只會這個。。），eureka配置說明可以檢視springCloud之eureka
新建ConfigServer
為了減少文章長度，儘量乾貨，建立過程就不截說明了，建議使用Intellij idea進行建立；
- POM檔案：
<?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> <groupId>com.lc.springcloud</groupId> <artifactId>config-server</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>config-server</name> <description>Demo project for Spring Boot</description> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.0.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <java.version>1.8</java.version> <spring-cloud.version>Greenwich.M2</spring-cloud.version> </properties> <dependencies> <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> <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> <repositories> <repository> <id>spring-milestones</id> <name>Spring Milestones</name> <url>https://repo.spring.io/milestone</url> <snapshots> <enabled>false</enabled> </snapshots> </repository> </repositories> </project>
- application.yml配置如
server:
port: 8100
spring:
application:
name: config-server
cloud:
config:
server:
git:
uri: https://github.com/lvchaogit/SpringCloud
eureka:
client:
service-url:
defaultZone: http://localhost:8081/eureka/ # 服務註冊中心地址
通過配置不難理解，該配置是從git上獲取配置，更多配置後續詳解；
- application.java
@SpringBootApplication
@EnableConfigServer
@EnableDiscoveryClient
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
主要是加上**@EnableConfigServer**註解，開啟configserver功能
搭建 Config Client
- POM檔案
<?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>
<groupId>com.lc.springcloud</groupId>
<artifactId>config-client</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>config-client</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.0.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.M2</spring-cloud.version>
</properties>
<dependencies>
<!-- config starter begin-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<!-- config starter end-->
<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>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
<version>2.5.0</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.10</version>
</dependency>
<!-- mybatis-plus begin -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>2.1.9</version>
<exclusions>
<exclusion>
<artifactId>tomcat-jdbc</artifactId>
<groupId>org.apache.tomcat</groupId>
</exclusion>
</exclusions>
</dependency>
<!--config監控模組 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.13</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</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>
<repositories>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://repo.spring.io/milestone</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
</project>
- bootstrap.yml
spring:
application:
name: config-client
cloud:
config:
profile: dev
label: master
discovery:
enabled: true
service-id: config-server
server:
port: 2001
eureka:
client:
register-with-eureka: false #因此處只是消費，不提供服務，所以不需要向eureka server註冊
service-url:
defaultZone: http://localhost:8081/eureka/ # 服務註冊中心地址
- 首先注意配置檔名稱為：bootstartp.yml，並不是~~application.yml~~
- 通過配置discovery，並設定enabled為true，使client通過服務發現去獲取server，server-id為註冊中心裡配置的服務名稱
- label=git的標籤；profile=配置檔案版本（類似於spring boot中的active）
###常用configserver配置### ####採用URI佔位符####
spring:
cloud:
config:
server:
git:
uri: https://github.com/lvchaogit/{application}
- 使用{application} 和 {profile}（如果使用{label}，請記住它是使用在git標籤中的）。因此你可以輕鬆的支援“一個應用一個倉庫”的原則
####模式匹配和多倉庫####
spring:
cloud:
config:
server:
git:
uri: https://github.com/lvchaogit/SpringCloud
repos:
simple: https://github.com/simple/config-repo
special:
pattern: special*/dev*,*special*/dev*
uri: https://github.com/special/config-repo
local:
pattern: local*
uri: file:/home/configsvc/config-repo
- 在{application}和{profile}引數中使用模式匹配可以支援更多複雜的需求。模式的格式是一組逗號分隔的{application}/{profile}，其中的引數可以使用萬用字元.
- 如果{application}/{profile}沒有匹配到任何模式，它將使用預設的倉庫地址:spring.cloud.config.server.git.uri。上面的例子中，"simple"倉庫匹配的是“simple/”（它僅僅匹配一個倉庫simple，在所有的環境下）。"local"倉庫將匹配所有{application}的名字以“local”開頭的，並且也是在所有的環境下。“/”字首自動新增到所有沒有設定{profile}的模式中。
####匹配倉庫子目錄####
spring:
cloud:
config:
server:
git:
uri: https://github.com/spring-cloud-samples/config-repo
searchPaths: foo,bar*
- 在foo和以bar開頭的目錄中，搜尋配置檔案。
####克隆遠端的倉庫####
spring:
cloud:
config:
server:
git:
uri: https://git/common/config-repo.git
repos:
team-a:
pattern: team-a-*
cloneOnStart: true
uri: http://git/team-a/config-repo.git
team-b:
pattern: team-b-*
cloneOnStart: false
uri: http://git/team-b/config-repo.git
team-c:
pattern: team-c-*
uri: http://git/team-a/config-repo.git
- 伺服器預設在第一次請求配置檔案時克隆遠端的倉庫，也可以配置在啟動的時候克隆倉庫
- team-a的倉庫將在服務端啟動時進行克隆，其他的倉庫將在第一次請求時克隆。
####倉庫認證####
spring:
cloud:
config:
server:
git:
uri: https://github.com/spring-cloud-samples/config-repo
username: trolley
password: strongpassword
- 輸入使用者名稱密碼
常用配置參考：configServer常用配置
文中示例程式碼：SpringCloudConfig 示例