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