SpringCloud之高可用的分布式配置中心(Spring Cloud Config) |第十二章 -yellowcong

怼烎@ 2022-05-29 05:13 182阅读 0赞

> 微服务，讲究的就是高可用的特点，对于配置服务器这个重要的部分，肯定是更加的需要高可用的，需要将配置服务器做一个集群，然后后面的系统来访问。做一个集群的分布式配置文件系统和普通系统没太大的区别，就是将系统都给Eureka托管起来，然后子系统访问配置服务，不再是通过具体的ip进行访问了，而是通过注册的服务名称访问。

## 代码地址 ##

https://gitee.com/yellowcong/springcloud/tree/master/chapter12

### 目录结构 ###

![这里写图片描述][SouthEast]

### 系统架构 ###

<table> 
 <thead> 
  <tr> 
   <th>节点</th> 
   <th>服务</th> 
   <th>项目名</th> 
   <th>启动顺序</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>yellowcong.com:8761</td> 
   <td>eureka注册服务</td> 
   <td>eureka-server</td> 
   <td>1</td> 
  </tr> 
  <tr> 
   <td>yellowcong.com:8762</td> 
   <td>配置服务端1</td> 
   <td>config-server</td> 
   <td>2</td> 
  </tr> 
  <tr> 
   <td>yellowcong.com:8763</td> 
   <td>配置服务端2</td> 
   <td>config-server2</td> 
   <td>3</td> 
  </tr> 
  <tr> 
   <td>yellowcong.com:8765</td> 
   <td>配置客户端</td> 
   <td>config-client</td> 
   <td>4</td> 
  </tr> 
 </tbody> 
</table>

### 系统架构图 ###

这个地方有两台配置服务集群，大家也可以做多台，然后提供给一帮小弟们访问连接，这一切的服务，都依赖于Eurake的注册服务中西

![这里写图片描述][SouthEast 1]

## 第一节：配置服务端 ##

客户端配置，同[SpringCloud之分布式配置中心-本地配置文件(Spring Cloud Config) |第十章 -yellowcong][SpringCloud_-_Spring Cloud Config_ _ -yellowcong] 这一章是一样的，我就复制粘贴了，但是不一样的地方是，config-client-dev.properties 中env.name 字段的值是不一样了，通过这个值，来区分访问的是哪一个配置服务器。  
配置服务搭建，也是很简单的，具体有下面及步骤：1、配置pom.xml，添加`spring-cloud-config-server`依赖，2、配置`application.yml`,设置配置文件的启动模式（本地 or git）,以及本地配置目录，3、配置启动类，添加`@EnableConfigServer`注解，开启配置服务；4、添加配置文件；5、测试访问

## 1、配置pom.xml ##

添加`spring-cloud-config-server`依赖

<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-config-server</artifactId>
        <version>1.3.0.RELEASE</version>
    </dependency>

下面是完整的pom.xml配置

<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>yellowcong.com</groupId>
        <artifactId>cas-client-springboot</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>cas-client-springboot</name>
        <url>http://maven.apache.org</url>
    
        <repositories>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
            </repository>
        </repositories>
    
        
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.10.RELEASE</version>
        </parent>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
    
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka-server</artifactId>
                <version>1.3.0.RELEASE</version>
                <exclusions>
                    <exclusion>
                        <groupId>javax.servlet</groupId>
                        <artifactId>servlet-api</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-config-server</artifactId>
                <version>1.3.0.RELEASE</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
        </dependencies>
        <build>
            <plugins>
                
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <dependencies>
                        <dependency>
                            <groupId>org.springframework</groupId>
                            <artifactId>springloaded</artifactId>
                            <version>1.2.4.RELEASE</version>
                        </dependency>
                    </dependencies>
                </plugin>
            </plugins>
        </build>
    </project>

### 2、配置application.yml ###

下面的配置，主要是注意如何配置本地文件的配置文件，

#配置eureka 的注册中心
    eureka:
      client:
        serviceUrl:
          defaultZone: http://yellowcong.com:8761/eureka/
    
    # 注册服务的端口
    server:
      port: 8762
    
    #配置当前服务的名称
    spring:
      application:
        name: service-config #配置服务名称
      profiles:
        active: native #设置为本地启动的方式，而不是通过git
      cloud:
        config:
          server:
            native:
              searchLocations: classpath:/config   # 配置文件所在目录，classpath（类路径）和（系统文件路径） file两种

![这里写图片描述][SouthEast 2]

### 3、配置启动类 ###

启动类，加入`@EnableConfigServer`注解，就表示大兄弟，俺的配置服务开启了。

package com.yellowcong;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    import org.springframework.cloud.config.server.EnableConfigServer;
    
    
    @SpringBootApplication
    @EnableDiscoveryClient
    //开启配置服务
    @EnableConfigServer  
    public class ConfigMain {
    
        public static void main(String[] args) {
            SpringApplication.run(ConfigMain.class, args);
        }
    }

### 4、添加配置文件 ###

配置文件名称，项目名（springcloud里面的应用名称） + 版本（dev 表示开发版本， product表示产品） 等，这个版本信息可以自定义。 项目名和版本中间，需要通过 `-` 隔开，这个地方，我重点说这个东西，是由于配置文件的获取，也是基于这个文件名称格式的

![这里写图片描述][SouthEast 3]

config-client-dev.properties 的配置文件内容（配置服务器2的env.name=dev\_2，来区分访问了哪一个配置服务器。）

env.name=dev_1  
    env.password=dev123456

config-client-product.properties 文件配置类容

env.name=product  
    env.password=product123456

### 5、启动服务，测试访问 ###

访问 [http://yellowcong.com:8763/config-client-dev.properties][http_yellowcong.com_8763_config-client-dev.properties]和[http://yellowcong.com:8764/config-client-dev.properties][http_yellowcong.com_8764_config-client-dev.properties],两个都可以访问到config-client-dev.properties 配置文件,但是两个服务器的配置文件信息是不一样的，由此来区分访问了哪一个配置文件系统

![这里写图片描述][SouthEast 4]

## 第二节：配置客户端 ##

这个客户端的搭建，和之前的有所不同，不同点，在于bootstrap.yml的配置上，  
客户端搭建流程：1、配置pom.xml文件，添加`spring-cloud-config-client`的依赖，2、配置`bootstrap.yml`,设置配置服务器信息，3、配置`application.yml`,设置eurake服务注册的访问地址，以及服务端口（对于这些端口以及注册地址的配置信息，也可以都放到配置服务器上。）4、配置启动器类，5、设置测试类，引用配置文件信息

### 1、配置pom.xml ###

添加`spring-cloud-config-client`和`spring-boot-starter-actuator`的依赖

<dependency>  
       <groupId>org.springframework.cloud</groupId>  
       <artifactId>spring-cloud-config-client</artifactId> 
       <version>1.3.0.RELEASE</version> 
    </dependency>  
    
    <dependency>  
       <groupId>org.springframework.boot</groupId>  
       <artifactId>spring-boot-starter-actuator</artifactId>  
    </dependency>

下面是完整的pom.xml信息

<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>yellowcong.com</groupId>
        <artifactId>cas-client-springboot</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>cas-client-springboot</name>
        <url>http://maven.apache.org</url>
    
        <repositories>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
            </repository>
        </repositories>
    
        
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.10.RELEASE</version>
        </parent>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
    
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka-server</artifactId>
                <version>1.3.0.RELEASE</version>
                <exclusions>
                    <exclusion>
                        <groupId>javax.servlet</groupId>
                        <artifactId>servlet-api</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
    
            <dependency>  
                <groupId>org.springframework.cloud</groupId>  
                <artifactId>spring-cloud-config-client</artifactId> 
                <version>1.3.0.RELEASE</version> 
            </dependency>  
    
            <dependency>  
                <groupId>org.springframework.boot</groupId>  
                <artifactId>spring-boot-starter-actuator</artifactId>  
            </dependency>  
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
        </dependencies>
        <build>
            <plugins>
                
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <dependencies>
                        <dependency>
                            <groupId>org.springframework</groupId>
                            <artifactId>springloaded</artifactId>
                            <version>1.2.4.RELEASE</version>
                        </dependency>
                    </dependencies>
                </plugin>
            </plugins>
        </build>
    </project>

### 2、配置bootstrap.yml ###

在启动配置文件中，设定配置服务器地址，以及引用的文件。这个bootstrap.yml配置文件中，配置了spring.cloud.config.discovery.enabled=true  
spring.cloud.config.discovery.serviceId=config-server ， 直接通过eureka 的服务id进行配置服务的访问，而不是通过具体的ip来设置配置服务,同时还设定了endpoints.restart.enabled=true 表示可以通过域名的方式，来重启服务。

#配置eureka 的注册中心
    eureka:
      client:
        serviceUrl:
          defaultZone: http://yellowcong.com:8761/eureka/
    
    #配置服务的服务名称，和开启通过
    spring:
      cloud:
        config:
          discovery:
            serviceId: service-config
            enabled: true
    #配置服务名称
    #访问的配置文件名称为
    #{application.name}/{profile}/{label}
    #${spring.application.name}-${spring.cloud.config.profile}-${spring.cloud.config.label}
    ---
    spring:
      application:
        name: config-client #服务名称
      cloud:
        config:
          enabled: true #开启配置
          profile: dev  #版本
          label: ""     #git配置的分支信息，master类似的
    
    #取消权限验证
    management:
      security:
        enabled: false
    
    # 启用/restart端点重新启动应用程序上下文。
    endpoints:
      restart:
        enabled: true

配置文件的指向，可以大致明白为毛配置文件名称，不是 瞎起的，都是套路  
![这里写图片描述][SouthEast 5]

### 3、配置application.yml ###

对于这个地方的配置文件信息，这个地方只配置了端口信息，其余的啥也没有配置。

#配置服务器访问地址
    server:
      context-path: / 
      port: 8764

### 4、配置启动类 ###

启动类里面，啥也没有，就是一个普通的springboot程序。

package com.yellowcong;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    
    @SpringBootApplication
    @EnableDiscoveryClient
    public class ConfigMain {
    
        public static void main(String[] args) {
            SpringApplication.run(ConfigMain.class, args);
        }
    }

### 5、配置测试类 ###

这个测试类中，注入了配置文件中的`env.name`,同时说一下这个注入的写法`@Value("${env.name:config server not found}")`,表示如果我们没有注入成功`env.name`的值，就默认走后面的默认值。  
`@RefreshScope` 表示的是，这个配置服务刷新的，我也会同时获取到最新的配置服务信息。我们如果修改了配置文件系统中的配置文件信息，需要发送POST请求到[http://yellowcong.com:8764/refresh][http_yellowcong.com_8764_refresh](也就是客户端)，来让配置信息生效。

package com.yellowcong.controller;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.cloud.context.config.annotation.RefreshScope;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * 创建日期:2018年3月17日 <br/> * 创建用户:yellowcong <br/> * 功能描述: */
    @RestController  
    @RefreshScope 
    public class HomeController { 
    
        // ${env.name} + world 
        //相当于引用了yml文件中的 env.name配置
        //如果没有获取到env.name 的值，就会默认读取 :后面的值，相当于一个默认值了
        @Value("${env.name:config server not found}")
        private String bar;
    
        @RequestMapping("/app")
        String hello() {
            return "Hello " + bar + "!";
        }
    }

### 6、测试客户端 ###

这个测试的动态图，有点大，想看的，得等加载出来  
访问[http://yellowcong.com:8761][http_yellowcong.com_8761] 访问eurake管控台,查看注册的服务。

![这里写图片描述][SouthEast 6]

我先访问了配置服务的客户端[http://yellowcong.com:8764/app][http_yellowcong.com_8764_app] ，然后查询到的配置文件数据是 dev\_1,然后通过post访问[http://yellowcong.com:8764/refresh][http_yellowcong.com_8764_refresh] 刷新配置文件，刷新了三次后，访问的是另一个配置文件服务器，返回的结果是 dev\_2。说明高可用的效果达到了。两个配置服务都起了作用。  
![这里写图片描述][SouthEast 7]

## 参考文章 ##

1、[上最简单的SpringCloud教程 | 第七篇: 高可用的分布式配置中心(Spring Cloud Config)][SpringCloud_ _ _ _Spring Cloud Config]

[SouthEast]: /images/20220529/09ad6eb46138492aa1f2f1e7e51aec01.png
[SouthEast 1]: /images/20220529/66db67a9ce764743898063b4b2eb66fe.png
[SpringCloud_-_Spring Cloud Config_ _ -yellowcong]: http://blog.csdn.net/yelllowcong/article/details/79593809
[SouthEast 2]: /images/20220529/6823e13b541542e093c6e26b7f0a3e93.png
[SouthEast 3]: /images/20220529/f7e1bc5f557d4eba88917f6f957c7f9c.png
[http_yellowcong.com_8763_config-client-dev.properties]: http://yellowcong.com:8763/config-client-dev.properties
[http_yellowcong.com_8764_config-client-dev.properties]: http://yellowcong.com:8764/config-client-dev.properties
[SouthEast 4]: /images/20220529/44b06211f5414a1fbc6c1df94fd17c0e.png
[SouthEast 5]: /images/20220529/f931a500aae745e295791817583fce5d.png
[http_yellowcong.com_8764_refresh]: http://yellowcong.com:8764/refresh
[http_yellowcong.com_8761]: http://yellowcong.com:8761
[SouthEast 6]: /images/20220529/d6cd4b9abe5549ea949d18e0f9fe7931.png
[http_yellowcong.com_8764_app]: http://yellowcong.com:8764/app
[SouthEast 7]: /images/20220529/1eeac6683435437a910b3b9576b332b7.png
[SpringCloud_ _ _ _Spring Cloud Config]: http://blog.csdn.net/forezp/article/details/70037513