SpringCloud之分布式配置中心-本地配置文件(Spring Cloud Config) |第十章 -yellowcong

柔光的暖阳◎ 2022-05-29 05:12 509阅读 0赞

> Springcloud的配置文件服务，可以配置在本地的机器上，也可以同Git搞基，配置他远程的配置文件，这一章，我们讲解如何将配置 文件配置到本地，下一章再讲解配置到远程的git仓库上。springcloud配置文件服务，解决的问题是，每个微服务，都有自己的配置文件，如果都统一的交给了springcloud的配置服务 来管理，这样大大的方便了服务的管理。本文主要分两部分，1、介绍SpringCloud 配置服务的服务端搭建（基于本地文件，而不是git），2、介绍Springcloud的客户端的搭建。在这个地方，我是实力踩坑啊，对于设定配置服务端的信息，必须是在bootstrap.yml或bootstrap.properties文件中配置，不然就会走默认的路径 [http://localhost:8888][http_localhost_8888]

## 代码地址 ##

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

### 目录架构 ###

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

### 项目架构 ###

ps：实际测试的时候，可以不用eureka注册发现服务，我这个地方之所以加，是在正常开发中，还是要的，只是测试不用而已。

<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>配置服务端</td> 
   <td>config-server</td> 
   <td>2</td> 
  </tr> 
  <tr> 
   <td>yellowcong.com:8763</td> 
   <td>配置客户端</td> 
   <td>config-client</td> 
   <td>3</td> 
  </tr> 
 </tbody> 
</table>

## 第一节：配置文件服务端搭建 ##

配置服务搭建，也是很简单的，具体有下面及步骤：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 1]

### 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 2]

config-client-dev.properties 的配置文件内容

env.name=dev  
    env.password=dev123456

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

env.name=product  
    env.password=product123456

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

访问 [http://yellowcong.com:8762/config-client/product][http_yellowcong.com_8762_config-client_product] 或者 [http://yellowcong.com:8762/config/client-product][http_yellowcong.com_8762_config_client-product],两个都可以访问到config-client-product.properties 配置文件  
![这里写图片描述][SouthEast 3]

下图是两个链接访问的效果，可以发现返回的配置文件内容是一样的。  
![这里写图片描述][SouthEast 4]

路径访问说明， 只是将app名称+ 配置文件版本即可获取到对应的配置文件信息。  
![这里写图片描述][SouthEast 5]

## 第二节：配置文件客户端搭建 ##

配置文件客户端搭建，有点坑啊，注意要将调用配置服务的信息，配置到bootstrap.yml中，不然，只会跑到默认的配置服务[http://localhost:8888][http_localhost_8888]。 客户端搭建流程：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 ###

在启动配置文件中，设定配置服务器地址，以及引用的文件。

#配置服务名称
    #访问的配置文件名称为
    #{application.name}/{profile}/{label}
    #${spring.application.name}-${spring.cloud.config.profile}-${spring.cloud.config.label}
    spring:
      application:
        name: config-client #服务名称
      cloud:
        config:
          uri: http://yellowcong.com:8762 #配置服务的地址 bootstrap.yml
          enabled: true #开启配置
          profile: dev  #版本
          label: ""     #git配置的分支信息，master类似的

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

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

对于这个地方的配置文件信息，可以都直接放到配置文件服务器上，这个地方我懒，就直接写了

#配置eureka 的注册中心
    eureka:
      client:
        serviceUrl:
          defaultZone: http://yellowcong.com:8761/eureka/
    
    #配置服务器访问地址
    server:
      context-path: / 
      port: 8763

### 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:8763/refresh][http_yellowcong.com_8763_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:8763/app][http_yellowcong.com_8763_app] 访问配置信息。 可以看到正常获取到配置服务的信息。

下图可以看到，我们直接访问[http://yellowcong.com:8763/refresh][http_yellowcong.com_8763_refresh]，告诉我们请求的方法不对，当我们使用表单提交，通过post方法时，告诉我们权限不足。  
![这里写图片描述][SouthEast 7]

当我把配置服务端和客户端都关掉后，只重启配置服务客户端，看到如下结果，没有获取到配置服务的信息。客户端的控制台，也打印出了错误消息，说找不到配置文件信息。

Could not locate PropertySource: I/O error on GET request for "http://yellowcong.com:8762/config-client/dev": Connection refused: connect; nested exception is java.net.ConnectException: Connection refused: connect

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

## 常见问题 ##

### 1、Fetching config from server at: [http://localhost:8888][http_localhost_8888] ###

我在客户端，配置了配置服务的地址，但是仍然请求的是8888端口的服务。解决办法1、将配置服务改为8888端口，这种方式比较的low，不建议，2、配置`bootstrap.properties或bootstrap.yml`文件（ps:必须是bootstrap文件，在application.yml设定不生效啊。），设定`spring.cloud.config.uri: http://yellowcong.com:8762`,指定配置服务地址。

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

当它运行它将从端口8888上的默认本地配置服务器接收外部配置，如果它正在运行。要修改启动行为，您可以使用bootstrap.properties更改配置服务器的位置，但用于应用程序上下文的引导阶段），例如

spring.cloud.config.uri: http://yellowcong.com:8762

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

修改后，再次启动配置服务器的客户端，查看控制台输出,可以看到从[http://yellowcong.com:8762][http_yellowcong.com_8762] 这个服务器端，来拉取配置文件信息了。

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

### 2、Could not locate PropertySource: I/O error on GET request for “[http://yellowcong.com:8762/config-client/dev][http_yellowcong.com_8762_config-client_dev]“: Connection refused: connect; nested exception is java.net.ConnectException: Connection refused: connect ###

出现这个问题的原因，就是由于配置文件服务端，没有启动导致的，解决办法，就是1、确认配置文件服务端启动，2、确认配置文件没有毛病。

## 参考文章 ##

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

2、[springcloud config 配置中心][springcloud config]

[http_localhost_8888]: http://localhost:8888
[SouthEast]: /images/20220529/8bff6e0464184f9fbb1c7c8750b68ca6.png
[SouthEast 1]: /images/20220529/e08388fe4e8643b6998b3e7e5874bbc3.png
[SouthEast 2]: /images/20220529/0844d60d89024976ae7824f59d7ed13c.png
[http_yellowcong.com_8762_config-client_product]: http://yellowcong.com:8762/config-client/product
[http_yellowcong.com_8762_config_client-product]: http://yellowcong.com:8762/config/client-product
[SouthEast 3]: /images/20220529/565fb83de6024fdfb34b218899788443.png
[SouthEast 4]: /images/20220529/1cc5b1aab2ae4aea9b84b0a6dc84b391.png
[SouthEast 5]: /images/20220529/87270ddcf4db473baaecd271d793cb79.png
[SouthEast 6]: /images/20220529/cc23fea01dbd44df9528d25d3e9009e5.png
[http_yellowcong.com_8763_refresh]: http://yellowcong.com:8763/refresh
[http_yellowcong.com_8763_app]: http://yellowcong.com:8763/app
[SouthEast 7]: /images/20220529/23630d257c744537a2eb826faf986bec.png
[SouthEast 8]: /images/20220529/db56e680c75b41b8aa81cdccf07def77.png
[SouthEast 9]: /images/20220529/fc7b2a6da76646ccb2ae37559dc2637f.png
[SouthEast 10]: /images/20220529/7fab7b8c85e44529a93310c1d290925a.png
[http_yellowcong.com_8762]: http://yellowcong.com:8762
[SouthEast 11]: /images/20220529/5277ab99bbf849239172b00682ac5658.png
[http_yellowcong.com_8762_config-client_dev]: http://yellowcong.com:8762/config-client/dev
[SpringCloud_ _ _ _Spring Cloud Config]: http://blog.csdn.net/forezp/article/details/70037291
[springcloud config]: http://blog.csdn.net/xiaojianhx/article/details/73695421