Spring Cloud之config server(配置中心)

朱雀 2020-11-28 17:15 810阅读 0赞

# Spring Cloud之config server(配置中心) #

## Spring Cloud之config server（上） ##

### 前言 ###

在spring cloud项目中，都会配置一个配置中心去管理各个服务的配置文件，而往往配置文件不会放到本地配置中心，一般都会放到git上，这里首先介绍一下一个服务如何从配置中心读取文件，配置中心如何从远程git读取配置文件

### 开始 ###

首先在IDEA上创建一个模块config-server，过程中要勾选的内容：  
![这里写图片描述][SouthEast]  
在程序入口Application中加上注解：@EnableConfigServer  
在git上创建一个project，存放远程配置文件，比如我的：  
![这里写图片描述][SouthEast 1]  
dev/application.yml:

user:
        userName: dev/wlg
        sex: 男
        age: 18

test/application.yml:

user:
        userName: test/wlg
        sex: 男
        age: 18

application-dev2.yml:

user:
        userName: 王立国-dev2
        sex: 男
        age: 18

application-test2.yml:

user:
        userName: 王立国-test2
        sex: 男
        age: 18

然后是resources下的application.yml:

spring:
      application:
        name: config-server
      cloud:
        config:
          server:
            git:
              uri: https://rdc.hand-china.com/gitlab/15433/config1314.git
              username: 
              password: 
              searchPaths: '{profile}'
    server:
      port: 8888

*  spring.cloud.config.server.git.uri：配置git仓库地址
 *  spring.cloud.config.server.git.searchPaths：配置仓库路径 –这里写成’\{profile\}’是为了能让后面的服务在不同环境下动态的去获得相对应的目录下的配置环境
 *  spring.cloud.config.label：配置仓库的分支
 *  spring.cloud.config.server.git.username：访问git仓库的用户名
 *  spring.cloud.config.server.git.password：访问git仓库的用户密码

启动config-server，看是否能访问到远程配置文件,比如：  
![这里写图片描述][SouthEast 2]  
![这里写图片描述][SouthEast 3]  
http请求地址和资源文件映射如下:  
\* /\{application\}/\{profile\}\[/\{label\}\]  
\* /\{application\}-\{profile\}.yml  
\* /\{label\}/\{application\}-\{profile\}.yml  
\* /\{application\}-\{profile\}.properties  
\* /\{label\}/\{application\}-\{profile\}.properties

### 服务 ###

再创建一个模块（服务），这个服务通过配置中心去获取git上配置文件信息。

1.  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.springcloud</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>1.5.10.RELEASE</version>
            <relativePath/> 
        </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>Edgware.SR1</spring-cloud.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-config</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</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>

application.yml:

spring:
      application:
        name: config-client
      cloud:
        config:
          label: master
          uri: http://localhost:8888/
    # profile: dev
    server:
      port: 8881

*  spring.cloud.config.label 指明远程仓库的分支
 *  spring.cloud.config.profile  
    
    
     *  dev开发环境
     *  test测试环境
     *  prod正式环境
 *  spring.cloud.config.uri= [http://localhost:8888/][http_localhost_8888] 指明配置服务中心的网址。  
    (spring.cloud.config.profile可以不在application.yml中说明，可以在该服务启动时配置，如下图：)  
    ![这里写图片描述][SouthEast 4]  
    接着在config-client服务中新建一个controller层，再新建一个类，写一个方法返回git上的user信息：  
    UserController：

package com.springcloud.configclient.Controller;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * Copyright Shanghai Hand Co. Ltd. * * @author liguo.wang@hand-china.com * @date 2018/2/1 9:32 * @version: 1.0 * @description */
    @RestController
    public class UserController { 
        @Value("${user.userName}")
        private String userName;
    
        @Value("${user.sex}")
        private String sex;
        @Value("${user.age}")
        private Integer age;
    
        @RequestMapping(value = "/user")
        public String getUserInfo(){
            return "userName:"+userName+" sex:"+sex+" age:"+age;
        }
    }

浏览器访问 [http://localhost:8881/user][http_localhost_8881_user]  
![这里写图片描述][SouthEast 5]

然后服务再配置test启动，访问浏览器：  
![这里写图片描述][SouthEast 6]

就这样，通过不同的环境名对应git上不同的目录名，从而达到了不同环境分别获取的是相对应的环境（目录）中的配置信息

## Spring Cloud之config server（下） ##

上面服务通过 spring.cloud.config.uri= [http://localhost:8888/][http_localhost_8888] 指明配置服务中心的网址。  
那如果 config-server 的server.port端口改变了所有的服务的uri都有手动改变，  
所以这时我们把配置中心和所有的服务都注册到注册中心去。

### config-server ###

1.  在config-server模块的pom.xml中添加依赖：

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka-server</artifactId>
    </dependency>

1.  application.yml:

spring:
      application:
        name: config-server
      cloud:
        config:
          server:
            git:
              uri: https://rdc.hand-china.com/gitlab/15433/config1314.git
              username: 15433
              password: Wangliguo1995
              searchPaths: '{profile}'
    server:
      port: 8888
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:8761/eureka/

1.  然后是配置中心程序入口ConfigServerApplication上加注解：@EnableEurekaClient

### 改造服务config-client ###

1.  pom.xml中追加依赖:

<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka-server</artifactId>
    </dependency>

1.  配置文件更名为bootstrap.yml，注意是bootstrap。加上服务注册地址为[http://localhost:8761/eureka/][http_localhost_8761_eureka]：

spring:
      application:
        name: config-client
      cloud:
        config:
          label: master
          discovery:
            enabled: true
            service-id: config-server
    # uri: http://localhost:8888/
    # profile: dev
    
    server:
      port: 8881
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:8761/eureka/

*  spring.cloud.config.discovery.enabled 是否从配置中心读取文件。
 *  spring.cloud.config.discovery.serviceId 配置中心的servieId，即服务名。

打开浏览器访问，可以看到：  
![这里写图片描述][SouthEast 7]  
![这里写图片描述][SouthEast 8]

[SouthEast]: /images/1606583687759.png
[SouthEast 1]: /images/1606583664990.png
[SouthEast 2]: /images/1606583642480.png
[SouthEast 3]: /images/1606583619694.png
[http_localhost_8888]: http://localhost:8888/
[SouthEast 4]: /images/1606583592888.png
[http_localhost_8881_user]: http://localhost:8881/user
[SouthEast 5]: /images/1606583567477.png
[SouthEast 6]: /images/1606583542999.png
[http_localhost_8761_eureka]: http://localhost:8761/eureka/
[SouthEast 7]: /images/1606583471394.png
[SouthEast 8]: /images/1606583417706.png