SpringCloud(6)分散式配置中心Config
1.Spring Cloud Config 簡介
在分散式系統中,由於服務數量巨多,為了方便服務配置檔案統一管理,實時更新,所以需要分散式配置中心元件。在Spring Cloud中,有分散式配置中心元件spring cloud config ,它支援配置服務放在配置服務的記憶體中(即本地),也支援放在遠端Git倉庫中。在spring cloud config 元件中,分兩個角色,一是Config-Server,二是Config-Client。
2.Config Server從本地讀取配置檔案
建立一個spring-boot專案,取名為 config-server,其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>1.5.3.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.example</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>Dalston.RELEASE</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>
註解 @EnableConfigServer 開啟配置伺服器
@SpringBootApplication
@EnableConfigServer //開啟配置伺服器
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
需要在程式的配置檔案application.properties檔案配置以下。通過 spring.profile.active=native 來配置 ConfigServer 從本地讀取配置,讀取的路徑為 classpath 下的 shared 目錄。
server:
port: 8769
spring:
application:
name: config-server
profiles:
active: native
cloud:
config:
server:
native:
search-locations: classpath:/shared
在 resources 目錄下新建 shared 資料夾,在 shared 資料夾下新建 config-client-dev.yml 檔案。
server:
port: 8762
foo: foo version 1
啟動 config-server 工程!
3.構建Config-Client
新建Spring Boot工程,取名為 config-client,其 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>1.5.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</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>Dalston.RELEASE</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</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>
在 resources 目錄下新建 bootstrap.yml 檔案,因為 bootstrap 相對於 application 具有優先的執行順序。
變數{spring.application.name}和{spring.profiles.active},兩者以“-”相連,構成了向 Config Server 讀取的配置檔名。
spring:
application:
name: config-client
cloud:
config:
uri: http://localhost:8769
fail-fast: true #讀取沒有成功,執行快速失敗
profiles:
active: dev
編寫一個介面,測試讀取配置檔案的 foo 變數,並通過 API 介面返回.
@SpringBootApplication
@RestController
public class ConfigClientApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigClientApplication.class, args);
}
@Value("${foo}")
String foo;
@RequestMapping(value = "/foo")
public String hi(){
return foo;
}
}
啟動 config-client 工程,訪問 http://localhost:8762/foo,顯示
foo version 1
可見 config-client 成功向 config-server 工程讀取了配置檔案中 foo 變數的值。
4.Config Server從遠端Git倉庫讀取配置檔案
修改 config-server 的配置檔案 application.yml,程式碼如下.
server:
port: 8769
spring:
application:
name: config-server
cloud:
config:
server:
git:
uri: https://github.com/forezp/SpringcloudConfig
search-paths: respo
username: [email protected]
password:
label: master
如果Git倉庫為公開倉庫,可以不填寫使用者名稱和密碼,如果是私有倉庫需要填寫,本例子是公開倉庫,放心使用。
配置 | 解釋 |
---|---|
spring.cloud.config.server.git.uri | 配置git倉庫地址 |
spring.cloud.config.server.git.searchPaths | 配置倉庫路徑 |
spring.cloud.config.label | 配置倉庫的分支 |
spring.cloud.config.server.git.username | 訪問git倉庫的使用者名稱 |
spring.cloud.config.server.git.password | 訪問git倉庫的使用者密碼 |
遠端倉庫 https://github.com/forezp/SpringcloudConfig/ 中有個檔案config-client-dev.properties檔案中有一個屬性:
foo = foo version 2
但是沒有規定 server.port 屬性,所以會以預設 的 8080 啟動,啟動程式:訪問http://localhost:8080/foo
foo version 2
可見,config-server 從遠端 Git 倉庫讀取了配置檔案,config-client 從config-server 讀取了配置檔案.
5.構建高可用的 Config Server
將配置中心 config-server 做成一個微服務,並且將其叢集化,從而達到高可用。
1.啟動一個Eureka-Server工程,埠為8761,步驟參考前面的文章。
2.改造 config-server
引入 spring-cloud-starter-eureka-server 起步依賴.
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka-server</artifactId>
</dependency>
在工程啟動類上加上註解 @EnableEurekaClient,開啟 EurekaClient的功能。
在配置檔案 application.yml 加入服務註冊地址.
eureka:
client:
service-url:
defaultZone: http://locahost:8761/eureka/
3.改造 config-client
引入 spring-cloud-starter-eureka-server 起步依賴.
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka-server</artifactId>
</dependency>
在工程啟動類上加上註解 @EnableEurekaClient,開啟 EurekaClient的功能。
在配置檔案 application.yml 加入相關配置,向 service-id 為 config-server 的配置服務讀取配置檔案.
spring:
application:
name: config-client
cloud:
config:
fail-fast: true
discovery:
enabled: true
service-id: config-server
profiles:
active: dev
server:
port: 8762
eureka:
client:
service-url:
defaultZone: http://localhost:8761/eureka/
啟動 config-server、config-client 工程,訪問 http://localhost:8762/foo,瀏覽器顯:
foo version 2
只需要啟動多個 config-server 例項即可搭建高可用的 config-server。
6.使用Spring Cloud Bus重新整理配置
Spring Cloud Bus 將分散式的節點用輕量的訊息代理連線起來。它可以用於廣播配置檔案的更改或者服務之間的通訊,也可以用於監控。本文要講述的是用Spring Cloud Bus實現通知微服務架構的配置檔案的更改。
1.改造config-client
在pom檔案加上起步依賴spring-cloud-starter-bus-amqp.
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>
在工程 application 檔案新增 RabbitMQ 的相關配置,包括RabbitMq的地址、埠,使用者名稱、密碼。為了方便驗證,將 management.security.enabled 改為 false。
spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=guest
spring.rabbitmq.password=guest
management.security.enabled=false
最後,在需要更新的配置類上加 @RefreshScope 註解。
依次啟動工程,將 config-client 開啟兩個例項,埠分別為 8762 和 8763。啟動完成後,在瀏覽器上訪問 http://localhost:8762/foo 或者 http://localhost:8763/foo,瀏覽器顯示:
foo version 2
更改遠端 Git 倉庫,將 foo 的值改為“foo version 2”。訪問 http://localhost:8762/bus/refresh 請求重新整理配置,使用“destination”引數,例如 “/bus/refresh?destination=eureka-client:**”,即重新整理服務名為 eureka-client 的所有服務例項。