第六篇: 分布式配置中心(Spring Cloud Config)(Finchley版本)V2.0_dev

一、简介

在分布式系统中，由于服务数量巨多，为了方便服务配置文件统一管理，实时更新，所以需要分布式配置中心组件。
在Spring Cloud中，有分布式配置中心组件spring cloud config ，它支持配置服务放在配置服务的内存中（即本地），也支持放在远程Git仓库中。

在spring cloud config 组件中，分两个角色，
一是config server，二是config client。

在企业中这2个应用都应该要注册到Eureka-server上面，这样可以更好的监控服务的状态。

二、构建Config Server

第1步：创建父工程(maven)，父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.0.3.RELEASE</version>
        <relativePath/>
    </parent>

    <modules>
        <module>config-server</module>
        <module>eureka-server</module>
        <module>config-client</module>
    </modules>

    <groupId>com.gblfy</groupId>
    <artifactId>sc-f-chapter6</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>pom</packaging>

    <name>sc-f-chapter6</name>
    <description>Demo project for Spring Boot</description>

    <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.RELEASE</spring-cloud.version>
    </properties>

    <dependencies>
        <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步： 创建一个spring-boot项目，取名为config-server

• 其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>
    <parent>
        <groupId>com.gblfy</groupId>
        <artifactId>sc-f-chapter6</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <groupId>com.gblfy</groupId>
    <artifactId>config-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>

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

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
    </dependencies>
</project>

第3步：在程序的入口Application类加上@EnableConfigServer注解开启配置服务器的功能

• 代码如下：

@SpringBootApplication
@EnableConfigServer
public class ConfigServerApplication {

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

}

第4步：需要在程序的配置文件application.properties文件配置以下：

#注册中心地址
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
#服务端口号
server:
  port: 8888
#应用名称
#git远程仓库的配置信息 地址 账号 秘钥 本地保存配置文件的路径
spring:
  application:
    name: config-server
  cloud:
    config:
      server:
        git:
          uri: [email protected]:gb-heima/config-rep.git
          username:
          password:
          basedir: /Users/Administrator.PC-20180929LWLP/Desktop/springcloud-practical-column/sc-f-chapter6/config/basedir

• spring.cloud.config.server.git.uri：配置git仓库地址
• spring.cloud.config.server.git.searchPaths：配置仓库路径
• spring.cloud.config.server.git.username：访问git仓库的用户名
• spring.cloud.config.server.git.password：访问git仓库的用户秘钥
• spring.cloud.config.server.git.basedir：保存配置文件的本地路径
  如果Git仓库为公开仓库，可以不填写用户名和密码，如果是私有仓库需要填写，本例子是公开仓库，放心使用。

第5步：在远程仓库创建仓库和新增配置文件

• 在远程仓库创建一个仓库名称为config-re
• 在config-rep仓库中新建一个文件名为config-client-dev.properties
• 文件中的内容属性如下：

#应用名称
spring:
  application:
    name: config-client
#环境分支
env: dev
# 测试远程拉取信息1
girl:
  name: yuxin
  age: 1

• 远程仓库地址：https://github.com/gb-heima/config-rep.git

场景测试1：

1. config-server服务成功注册到eureka-server(注册中心)
2. config-server成功从远程git仓库拉取文件并在浏览器正常显示仓库配置的信息

操作流程如下：

• 先启动eureka-server工程，端口号8761
• 再启动config-server工程，端口号8888
• 启动程序：访问http://localhost:8888/config-client-dev.yml
• 测试效果图1：
  
  
• 也可以访问:http://localhost:8888/gblfy/dev
• 效果图2：
• 

{
"name": "girl",
"profiles": [
"dev"
],
"label": null,
"version": "cfab60b6d3e093ab5227f0694f0f4b5e8a80e9e2",
"state": null,
"propertySources": []
}

证明配置服务中心可以从远程程序获取配置信息

注：配置好远程仓库信息后，可以通过配置中心验证配置信息是否正确，正确会正常显示，不正确会有提示，根据提示进行修改即可

http请求地址和资源文件映射如下:

• /{application}/{profile}[/{label}]
• /{application}-{profile}.yml
• /{label}/{application}-{profile}.yml
• /{application}-{profile}.properties
• /{label}/{application}-{profile}.properties

三、构建一个config client

第1步：重新创建一个springboot项目，取名为config-client,
引入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>com.gblfy</groupId>
        <artifactId>sc-f-chapter6</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <groupId>com.gblfy</groupId>
    <artifactId>config-client</artifactId>
    <version>0.0.1-SNAPSHOT</version>

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

    <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>
    </dependencies>
</project>

在上面依赖基础上再添加以下3个依赖：

• lombok：省区写getset
• spring-boot-starter-data-jpa：控制台输出sql 操作数据库
• mysql-connector-java：数据库依赖及驱动等信息

<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

第2步：添加启动主类

@SpringBootApplication
@EnableEurekaClient
@EnableDiscoveryClient
public class ConfigClientApplication {

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

}

第3步：全局配置文件bootstrap.yml
mysql和jpa的配置信息配置到git远程仓库中的config-client-dev.yml文件中
config-client-dev.yml文件内容如下所示：

#应用名称
spring:
  application:
    name: config-client
#    数据库配置
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    username: root
    password: root
    url: jdbc:mysql://127.0.0.1:3306/springcloud_sell?characterEnconding=utf-8&useSSL=false
#  控制台输出sql
  jpa:
    show-sql: true
#环境分支
env: dev
# 测试远程拉取信息
girl:
  name: yuxin
  age: 1

本地bootstrap.yml配置内容如下：

#应用名称
spring:
  application:
    name: config-client
  cloud:
    config:
      discovery:
        enabled: true
#        服务端应用名称
        service-id: CONFIG-SERVER
      profile: dev
#注册中心地址
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka
#服务端口号
server:
  port: 8881

spring.cloud.config.profile

• dev开发环境配置文件
• test测试环境
• pro正式环境

注意，这里配置文件名称不是application.yml而是替换成bootstrap.yml

理由如下：
1、当全局配置文件为application.yml时，应用启动就会从配置文件中读取配置信息，再去将自己的服务注册到eureka-server上面
2、当全局配置文件为bootstrap.yml时，应用启动就会先将服务注册中eureka-server注册中心，然后通过应用名称在注册中心找到配置中心的应用也就是(CONFIG-SERVER)
3、CONFIG-SERVER就会从git远程仓库中拉取配置信息

举个栗子：
在config-client服务中配置了mysq数据库的配置，而mysql的配置信息放到了远程的git仓库中，在本地是没有的。用application.yml当配置文件时，就是启动报错，异常信息时，找不到jdbc的信息。

解决方案：
将application.yml配置文件更名为bootstrap.yml(注文件后缀名.properties也支持)

本地的bootstrap.yml和远程的bootstrap.yml是通过config-server端，连接git远程仓库拉取配置信息，再通过应用名称，来取配置信息，应用名称一致，config-server就可以成功拉取配置信息，config-client在从config-server服务中拉取配置信息。

架构如图所示:

第4步：写一个与bootstrap.yml配置文件中信息对应的配置类GirlConfig(用户去配置文件中的信息)

@Data
@Component
@ConfigurationProperties(prefix = "girl")
public class GirlConfig {

    private String name;

    private Integer age;
}

第5步：程序的入口类GirlController，写一个API接口“/girl//info”，返回从配置中心读取的girl对象变量的值
代码如下：

@RestController
@RequestMapping("/girl")
public class GirlController {

    @Autowired
    private GirlConfig girlConfig;

    @GetMapping("/info")
    public String getGirlInfo() {
        return "name:" + girlConfig.getName() + "," + girlConfig.getAge();
    }
}
启动config-client，查看控制台：发现config-client从config-server应用中拉取配置信息

Fetching config from server at : http://PC-20180929LWLP:8888/

打开网址访问：http://localhost:8881/girl//info，网页显示：

这就说明，config-client从config-server获取了girl对象的属性，而config-server是从git远程仓库再区配应用名称读取的

本文源码下载：

master分支(企业实战)：
https://github.com/gb-heima/springcloud-practical-column/tree/dev/sc-f-chapter6

master分支(入门)：
https://github.com/gb-heima/springcloud-practical-column/tree/master/sc-f-chapter6