詳解使用spring cloud config來統(tǒng)一管理配置文件

更新時(shí)間：2018年12月14日 14:09:28 作者：mazhen1991

這篇文章主要介紹了詳解使用spring cloud config來統(tǒng)一管理配置文件，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

當(dāng)一個(gè)系統(tǒng)中的配置文件發(fā)生改變的時(shí)候，我們需要重新啟動(dòng)該服務(wù)，才能使得新的配置文件生效，spring cloud config可以實(shí)現(xiàn)微服務(wù)中的所有系統(tǒng)的配置文件的統(tǒng)一管理，而且還可以實(shí)現(xiàn)當(dāng)配置文件發(fā)生變化的時(shí)候，系統(tǒng)會自動(dòng)更新獲取新的配置。

其架構(gòu)原理圖大致如下：

我們將配置文件放入git或者svn等服務(wù)中，通過一個(gè)Config Server服務(wù)來獲取git中的配置數(shù)據(jù)，而我們需要使用的到配置文件的Config Client系統(tǒng)可以通過Config Server來獲取對應(yīng)的配置。

下面我們通過一個(gè)示例來演示一下config是如何被各個(gè)微服務(wù)系統(tǒng)獲取到的。

1.向git中上傳示例配置文件

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/taotao?useUnicode=true&characterEncoding=utf8&autoReconnect=true&allowMultiQueries=true
jdbc.username=root
jdbc.password=root

文件名分別為：

microservice-dev.properties
microservice-production.properties
microservice-test.properties

對應(yīng)不同的三個(gè)環(huán)境。

該文件的命名規(guī)則是：{application}-{profile}.properties

2.搭建Config Server

2.1 添加依賴

<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>1.5.4.RELEASE</version>
</parent>

<!-- 導(dǎo)入Spring Cloud的依賴管理 -->
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-dependencies</artifactId>
      <version>Dalston.SR3</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-eureka-server</artifactId>
      <exclusions>
        <exclusion>           
          <groupId>com.fasterxml.jackson.dataformat</groupId>
          <artifactId>jackson-dataformat-xml</artifactId>
        </exclusion>
      </exclusions>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
  </dependency>
  <!-- 使用bus總線的方式通知所有的微服務(wù)配置文件需要刷新 -->
  <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bus-amqp</artifactId>
  </dependency>
</dependencies>

<build>
  <finalName>${project.artifactId}</finalName>
  <plugins>
    <!-- 資源文件拷貝插件 -->
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-resources-plugin</artifactId>
      <configuration>
        <encoding>UTF-8</encoding>
      </configuration>
    </plugin>
    <!-- java編譯插件 -->
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <encoding>UTF-8</encoding>
      </configuration>
    </plugin>
  </plugins>
</build>

2.2 編寫ConfigApplication

@EnableDiscoveryClient
@EnableConfigServer //開啟配置服務(wù)
@SpringBootApplication
public class ConfigApplication {

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

}

2.3 編寫yml配置文件

server:
 port: 6688 #服務(wù)端口

spring: 
 application: 
  name: microservice-config-server #指定服務(wù)名
 cloud: 
  config:
   server:
    git: #配置git倉庫地址
     uri: 具體的配置文件的git地址
     #username: 
     #password:
 rabbitmq: #RabbitMQ相關(guān)的配置
  host: 127.0.0.1
  port: 5672
  username: guest
  password: guest

eureka: 
 client:
  registerWithEureka: true #是否將自己注冊到Eureka服務(wù)中，默認(rèn)為true
  fetchRegistry: true #是否從Eureka中獲取注冊信息，默認(rèn)為true
  serviceUrl: #Eureka客戶端與Eureka服務(wù)端進(jìn)行交互的地址
   defaultZone: http://cloud:cloud@127.0.0.1:6868/eureka/
 instance: 
  prefer-ip-address: true #將自己的ip地址注冊到Eureka服務(wù)中
  ipAddress: 127.0.0.1
management:
 security:
  enabled: false #是否開啟actuator安全認(rèn)證

這是我們啟動(dòng)該服務(wù)，訪問該配置文件，訪問路徑示例如下(以該配置為例)： 127.0.0.1:6688/microservice-dev.properties

訪問路徑的寫法也有多種方式：

/{application}/{profile}/[label]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
其中{label}是指分支，默認(rèn)是master。

3. Config Client的搭建

3.1 添加依賴

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>

3.2 添加yml配置文件

eureka:
 client:
  serviceUrl: #Eureka客戶端與Eureka服務(wù)端進(jìn)行交互的地址
   defaultZone: http://cloud:cloud@127.0.0.1:6868/eureka/
spring:
 cloud:
  config:
   name: microservice #對應(yīng)的配置服務(wù)中的應(yīng)用名稱
   profile: dev #對應(yīng)配置服務(wù)中的{profile}
   label: master #對應(yīng)的分支
   discovery: 
    enabled: true #啟用發(fā)現(xiàn)服務(wù)功能
    service-id: microservice-config-server #指定服務(wù)名稱
 spring: 
 application: 
  name: itcasst-microservice-config-server #指定服務(wù)名
 cloud: 
  config:
   server:
    git: #配置git倉庫地址
     uri: http://172.16.55.138:10080/zhangzhijun/itcast-config-server.git
     #username: zhangzhijun
     #password: 123456
 rabbitmq: #RabbitMQ相關(guān)的配置
  host: 127.0.0.1
  port: 5672
  username: guest
  password: guest

注意，這里的yml配置文件是：bootstrap.yml，它和application.yml文件一樣，會被spring boot加載，但是bootstrap.yml會優(yōu)先加載。

3.3 在application.yml文件中添加配置

management:
 security:
  enabled: false #是否開啟actuator安全認(rèn)證

3.4 利用git的webhook實(shí)現(xiàn)實(shí)時(shí)更新通知

這個(gè)時(shí)候，我么通過@Value的方式，就可以獲取到對應(yīng)的配置了。

@RefreshScope
@Component//加入到Spring容器
public class JdbcConfigBean {

  @Value("${jdbc.url}")
  private String url;

  @Value("${jdbc.username}")
  private String username;

  @Value("${jdbc.password}")
  private String password;

  @Value("${jdbc.driverClassName}")
  private String driverClassName;

  public String getUrl() {
    return url;
  }

  public void setUrl(String url) {
    this.url = url;
  }

  public String getUsername() {
    return username;
  }

  public void setUsername(String username) {
    this.username = username;
  }

  public String getPassword() {
    return password;
  }

  public void setPassword(String password) {
    this.password = password;
  }

  public String getDriverClassName() {
    return driverClassName;
  }

  public void setDriverClassName(String driverClassName) {
    this.driverClassName = driverClassName;
  }

  @Override
  public String toString() {
    return "JdbcConfigBean [url=" + url + ", username=" + username
        + ", password=" + password + ", driverClassName="
        + driverClassName + "]";
  }

}

再次測試，我們發(fā)現(xiàn)當(dāng)我們修改了git中的配置文件的內(nèi)容之后，client系統(tǒng)中讀取到的屬性也是修改之后的了。

到此為止，其架構(gòu)變成如下：