1. 程式人生 > >SpringCloud-統一配置中心

SpringCloud-統一配置中心

編寫Config

1. 在git倉庫https://gitee.com/lzc_lzc/config-repo新建兩個配置檔案

分別為

orderConfig-dev.properties

orderConfig.properties

內容分別為

user.name=dev-lzc
user.age=20
和
user.name=lzc
user.age=20

2. 新建一個config專案

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>

    <groupId>com.lzc</groupId>
    <artifactId>config</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>config</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.4.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>Finchley.SR1</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>


</project>

3. 在啟動類加上@EnableConfigServer註解

@SpringBootApplication
@EnableDiscoveryClient
@EnableConfigServer
public class ConfigApplication {

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

4. 編寫配置檔案application.properties

server.port=8081
spring.application.name=config
eureka.client.service-url.defaultZone=http://localhost:8080/eureka

spring.cloud.config.server.git.uri=https://gitee.com/lzc_lzc/config-repo
spring.cloud.config.server.git.username=username
spring.cloud.config.server.git.password=password
#設定config server從git倉庫中拉下來的檔案儲存的路徑
spring.cloud.config.server.git.basedir=C:\LZC\SpringCloud\SpringCloud-learning\config\basedir

這樣config就配置完成了。啟動config,我們可以使用Config的端點來獲取配置檔案的內容。端點與配置檔案的對映如下:

/{application}/{profile}[/{label}]

/{application}/-{profile}.yml

/{label}/{application}/-{profile}.yml

/{application}/-{profile}.properties

/{label}/{application}/-{profile}.properties

label是指對應的分支

通過訪問http://localhost:8081/orderConfig-dev.yml

即可訪問到orderConfig-dev.properties

編寫Config Client

1. 新建一個config-client專案,新增如下依賴

<?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.lzc</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.0.4.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>Finchley.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.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>


</project>

2. 啟動類

@SpringBootApplication
@EnableDiscoveryClient
public class ConfigClientApplication {

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

3. 將application.properties改成bootstrap.properties(原因:bootstrap.properties先於 application.properties載入)

server.port=8082
spring.application.name=orderConfig
eureka.client.service-url.defaultZone=http://localhost:8080/eureka

spring.cloud.config.discovery.enabled=true
#這個是配置中心的名字
spring.cloud.config.discovery.service-id=CONFIG
spring.cloud.config.profile=dev

4. 編寫一個User類來獲取配置檔案

@Component
@ConfigurationProperties(prefix = "user")
public class User {

    private String name;

    private Integer age;

    public User() {
    }

    // 省略get、set方法
}

5. 編寫一個Controller

@RestController
public class Controller {

   @Autowired
   private User user;

    @GetMapping("/print")
    public Object print() {
        return user.toString();
    }
}

啟動configclient,在瀏覽器輸入http://localhost:8082/print即可獲取到配置資訊。

 

很多情況下,需要在執行期間動態調整配置,如果配置發生了修改,微服務要如何實現配置的重新整理呢?看下面的兩種方法

使用/refresh手動重新整理配置

1. 在config-client基礎上,pom.xml新增如下依賴

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

2. User類加上@RefreshScope註解

@Component
@ConfigurationProperties(prefix = "user")
@RefreshScope
public class User {

    private String name;

    private Integer age;

    public User() {
    }

    // 省略get、set方法
}

這樣就完成程式碼改造了。

測試

(1)啟動config和config-client

(2)訪問http://localhost:8082/print,獲取如下內容

User{name='dev-lzc', age=11}

(2)修改orderConfig-dev.properties,內容如下

user.name=dev-lzc
user.age=18

(3)訪問http://localhost:8082/print,結果還是

User{name='dev-lzc', age=11}

(4)傳送post請求到localhost:8082/actuator/refresh

(5)訪問http://localhost:8082/print,發現內容已經改變

User{name='dev-lzc', age=18}

我們可以發現,有多少個微服務的配置檔案被修改了我們就得發多少個請求,還是有點麻煩。

使用SringCloud Bus自動重新整理

首先需要安裝RabbitMQ,安裝教程

還是使用前面的config專案和config-client專案

1. config

pom.xml新增如下依賴

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

啟動類


@SpringBootApplication
@EnableDiscoveryClient
@EnableConfigServer
public class ConfigApplication {

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

application.properties

eureka.client.service-url.defaultZone=http://localhost:8080/eureka

spring.cloud.config.server.git.uri=https://gitee.com/lzc_lzc/config-repo
spring.cloud.config.server.git.username=username
spring.cloud.config.server.git.password=password
#設定config server從git倉庫中拉下來的檔案儲存的路徑
spring.cloud.config.server.git.basedir=C:\LZC\SpringCloud\SpringCloud-learning\config\basedir

#將重新整理介面暴露出去
management.endpoints.web.exposure.include=*

spring.rabbitmq.host=192.168.192.132
spring.rabbitmq.port=5672
spring.rabbitmq.username=lzc
spring.rabbitmq.password=123456

2. config-client

pom.xml新增如下依賴

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

啟動類

@SpringBootApplication
@EnableDiscoveryClient
public class ConfigClientApplication {

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

User.java

@Component
@ConfigurationProperties(prefix = "user")
@RefreshScope
public class User {

    private String name;

    private Integer age;

    public User() {
    }

    // 省略get、set方法
}

bootstrap.properties

server.port=8082
spring.application.name=orderConfig
eureka.client.service-url.defaultZone=http://localhost:8080/eureka

spring.cloud.config.discovery.enabled=true
spring.cloud.config.discovery.service-id=CONFIG
spring.cloud.config.profile=dev

spring.rabbitmq.host=192.168.192.132
spring.rabbitmq.port=5672
spring.rabbitmq.username=lzc
spring.rabbitmq.password=123456

這樣就配置完成,將config和configclient啟動

方法(1)手動重新整理:修改配置檔案後,我們也可以通過post請求訪問localhost:8081/actuator/bus-refresh手動重新整理,這裡訪問的是config,所以即使有多個配置檔案被修改了,我們只需要訪問一次localhost:8081/actuator/bus-refresh就可以了。

方法(2)WebHooks自動重新整理:

這裡的遠端GIT使用的是Gitee(碼雲),其 WebHooks 配置方法(本地測試的話,還需要一個內網穿透,這裡使用的是natapp)

修改配置檔案後就可以實現自動更新了。

 

程式碼地址:https://github.com/923226145/SpringCloud-learning