Spring Cloud—十、使用Spring Cloud Config统一管理微服务

10.1、Spring Cloud Config简介

Spring Cloud Config为分布式系统外部化配置提供了服务器和客户端的支持,它包括Config Server和Config Client两部分。由于Config Server和Config Client都实现了对Spring Environment和PropertySource抽象的映射,因此,Spring Cloud Config非常合适Spring应用程序,当然也可与任何其他语言编写的应用程序配合使用。

Config Server是一个可横向扩展、集中式的配置服务器,它用于集中管理应用程序各个环境下的配置,默认使用Git存储配置文件内容,也可以使用SVN存储,或者是本地文件存储。

Config Client是Config Server的客户端,用于操作存储在Config Server中的配置内容。微服务在启动时会请求Config Server获取配置文件的内容,请求到后再启动容器。

使用Spring Cloud Config的架构:


Spring Cloud Config架构.png

10.2、快速入门-搭建Config Server

10.2.1、准备3个配置文件,推送git服务器

准备3个文件:

  • demo-dev.properties
  • demo-production.properties
  • demo-test.properties
    该文件的命名规则是:{application}-{profile}.properties
    其内容是(另外2个文件内容稍有不同即可):
 jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/demo?userUnicode=true&characterEncoding=utf8
jdbc.username=root
jdbc.password=root

推送到git服务器,这里使用github。


github.png
10.2.2、创建工程springcloud-demo-config

pom依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
</dependency>
10.2.3、再启动类上增加注解@EnableConfigServer
@EnableConfigServer.png
10.2.4、编写application.properties
 server.port=9999
spring.application.name=springcloud-demo-config
spring.cloud.config.server.git.uri=https://github.com/zuoqiyin/spring-cloud-config.git
spring.cloud.config.server.git.username=zuoqiyin@foxmail.com
spring.cloud.config.server.git.password=*****
10.2.5、启动测试
测试.png

测试已经看到配置文件的内容。

请求配置文件的规则如下:
/{application}/{profile}/[label]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
其中{label}是指分支,默认是master。

10.3、快速入门-搭建Config Client

我们再springclouf-demo-item项目中添加Config Client的支持。来读取JDBC的配置文件的内容。

10.3.1、导入依赖
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>
10.3.2、创建配置文件boostrap.properties
 #对应的配置服务中的引用名称
spring.cloud.config.name=demo
#对应配置服务地址
spring.cloud.config.uri=http://127.0.0.1:9999
# 对应配置服务中的{perfile}
spring.cloud.config.profile=dev
#对应分支
spring.cloud.config.label=master
10.3.3、编写JdbcConfigBean
package cn.zuoqy.springclouddemoitem.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

/**
* Created by zuoqy on 14:18 2018/11/22.
*/
@Component // 加入到Spring容器
public class JdbcConfigBean {

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

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

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

    @Value("${jdbv.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 + '\'' +
            '}';
    }
}
10.3.4、编写测试方法进行测试

再ItemController中编写test方法

@Autowired
private JdbcConfigBean jdbcConfigBean;

@GetMapping(value = "test")
public String test() {
    return this.jdbcConfigBean.toString();
}
10.3.5、启动测试
测试.png

测试结果显示已经从Config Server中获取到配置文件的内容。

10.4、手动更新运行中的配置文件

10.4.1、再springcloud-demo-item项目中加入依赖
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
10.4.2、为JdbcConfigBean添加@RefreshScope
@RefreshScope.png
10.4.3、再application.properties加上
#是否开启actuator安全认证
management.security.enabled=false
10.4.4、post请求/refresh来更新配置内容:
post请求.png
10.4.5、测试结果
测试结果.png

发现可以更新配置信息。

10.5、借助与git的webhook(web钩子)实现自动跟新

github等git服务器提供了web hook功能:再仓库中的资源发生更新时会通知给谁,这里的谁是一个url地址。


git

git

添加完成接下来测试发现,配置文件内容会动态更到Bean中。


架构图

10.6、Config Client配置的优化

10.6.1、再springcloud-demo-config中添加Eureka的依赖
<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>
10.6.2、再application.properties文件中增加
#是否将自己注册到Eureka服务中,默认为true
eureka.client.register-with-eureka=true
#是否从Eureka中获取信息
eureka.client.fetch-registry=true
#Eureka服务端与Eureka客户端交互地址
eureka.client.serviceUrl.defaultZone=http://zuo:123456@127.0.0.1:8888/eureka/
10.6.3、再启动类中增加注解@EnableDiscoveryClient注解
启动类
10.6.4、重新启动
重新启动

可以看到再Eureka中已经又配置中心得服务

10.6.5、再springcloud-demo-item中修改bootstrap.properties配置
bootstrap.png

这里配置Eureka信息,因为Spring boot中bootstrap再application之前加载。

10.6.6、测试
测试

Spring Cloud—一、微服务架构
Spring Cloud—二、Spring Cloud简介
Spring Cloud—三、使用Spring Cloud实现微服务
Spring Cloud—四、Spring Cloud快速入门
Spring Cloud—五、注册中心Eureka
Spring Cloud—六、使用Ribbon实现负载均衡
Spring Cloud—七、容错保护:Hystrix
Spring Cloud—八、使用Feign实现声明式的Rest调用
Spring Cloud—九、服务网关Spring Cloud Zuul
Spring Cloud—十、使用Spring Cloud Config统一管理微服务
Spring Cloud—十一、使用Spring Cloud Bus(消息总线)实现自动更新

demo源码

推荐阅读更多精彩内容