SpringBoot統一配置中心

一直使用springboot搭建後端項目，全部的配置都寫到本身的resource目錄下，隨着微服務的項目愈來愈多，每一個項目都須要本身的各類配置文件。並且後期一旦想要修改配置文件，就得從新發布一遍很是的麻煩，如今就來教教你們怎麼統一在github上管理 這些配置，並作到一處修改到處生效，不須要從新發布項目。

1 建立統一服務項目

可使用STS來初始化項目，選擇本身的以來就好。

<?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.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.mike</groupId>
    <artifactId>config-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>config-server</name>
    <description>config server</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</artifactId>
        </dependency>
        <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>

建立bootstrap.yml文件，固然你可使用application.yml或application.properties

spring:
  application:
    name: config-repo
  cloud:
    config:
      server:
        git:
          uri: https://github.com/mike/config-repo.git   #github倉庫地址
          username: mike      # 用戶名
          password: 123456      # 密碼

在github上建立一個config-repo倉庫，並添加配置文件：

兩個不一樣環境的配置
hello-pj-dev.yml

hello:
  text: hello spring dev

hello-pj-uat.yml

hello:
  text: hello spring uat

建立啓動類：

@SpringBootApplication
@EnableConfigServer
public class ConfigServerApplication {

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

}

啓動應用，訪問：
http://localhost:8080/hello-pj-dev.yml
http://localhost:8080/hello-pj-uat.yml
你就能夠看到遠程的配置中心。

2 建立測試項目

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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.mike</groupId>
    <artifactId>hello-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>hello-server</name>
    <description>hello server</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>

建立bootstrap.yml文件，只能是這個文件，不能是application文件

server:
  port: 8082
spring:
  application:
    name: hello-pj
  cloud:
    config:
      profile: dev
      uri: http://localhost:8080/

這裏面配置了讀取遠程配置文件的uri，注意application.name必須對應github上的文件名，最終訪問的是application.name+profile

建立測試controller

@RestController
public class TestController {
    @Value("${hello.text}")
    private String text;
    
    @GetMapping("/say")
    public String sayHello(){
        return text;
    }
}

訪問 http://localhost:8082/say，你就能夠看到對應的配置。這樣你只須要在github上管理全部的配置就好了，可是記得'config-server'工程得一直啓動，經過它咱們才能獲取github上的配置。

3 動態刷新配置

目前若是咱們修改了github上的配置並不能立刻生效，須要咱們的客戶端工程重啓才行，如今須要改形成自動刷新。

在客戶端工程中加入新的依賴：

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

修改bootstrap.yml文件

server:
  port: 8082
spring:
  application:
    name: hello-pj
  cloud:
    config:
      profile: dev
      uri: http://localhost:8080/
    bus:
      trace:
        enabled: true
rabbitmq:
    host: localhost
    port: 5672
    username: guest
    password: guest

注意須要藉助rabbitmq，因此本地須要啓動rabbitmq。

在須要刷新的地方加入註解@RefreshScope

@RestController
@RefreshScope
public class TestController {
    @Value("${hello.text}")
    private String text;
    
    @GetMapping("/say")
    public String sayHello(){
        return text;
    }
}

這樣咱們既能夠隨時修改github上的配置文件，而不須要重啓應用。

若是對你有幫助，但願能夠關注下個人公衆號：