SpringCloud组件六之Config- 配置中心（G版本）

偏执的太偏执、 2022-02-17 06:11 185阅读 0赞

## 一：简介 ##

*  在分布式项目中，配置文件多，需进行集中管理配置。
 *  SpringCloud Config就是总多的解决方案的一种，在spring cloud config 组件中，分两个角色，一是config server，二是config client，且配置文件通常存储在GitHub中。

## 二：ConfigServer ##

*  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.1.4.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.lll</groupId>
        <artifactId>config</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>config</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
            <spring-cloud.version>Greenwich.SR1</spring-cloud.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-config-server</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>

*  yml配置文件

server:
      port: 8086
    spring:
      cloud:
        config:
          server:
            git:
              uri: https://github.com/oldgarlic/spring-cloud
          label: master
      application:
        name: config-server

*  配置信息

> spring.cloud.config.server.git.uri：配置git仓库地址  
> spring.cloud.config.server.git.searchPaths：git仓库地址下的相对地址  
> spring.cloud.config.label：配置仓库的分支

*  公共仓库不需要配置，私有仓库才需要配置

> spring.cloud.config.server.git.username：访问git仓库的用户名  
> spring.cloud.config.server.git.password：访问git仓库的用户密码

*  启动类添加注解

@SpringBootApplication
    @EnableConfigServer
    public class ConfigApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(ConfigApplication.class, args);
        }
    
    }

*  GitHub项目  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMDA4NTM1_size_16_color_FFFFFF_t_70]
 *  config-client-dev.properties内容

> [people.name][] = Tom is happy

*  访问“[http://localhost:8086/config-client/dev”，出现下列表示server端已经成功获取了git仓库的配置信息。][http_localhost_8086_config-client_dev_server_git]

> \{“name”:“config-client”,“profiles”:\[“dev”\],“label”:null,“version”:“38f036f57993709d0dadbf824c0575d01f425f9a”,“state”:null,“propertySources”:\[\{“name”:“[https://github.com/oldgarlic/spring-cloud/config-client-dev.properties",“source”:\{“people.name”:"Tom][https_github.com_oldgarlic_spring-cloud_config-client-dev.properties_source_people.name_Tom] is happy”\}\}\]\}

*  仓库中的配置文件会被转换成web接口，访问可以参照以下的规则：
 *  /\{application\}/\{profile\}\[/\{label\}\]
 *  /\{application\}-\{profile\}.yml
 *  /\{label\}/\{application\}-\{profile\}.yml
 *  /\{application\}-\{profile\}.properties
 *  /\{label\}/\{application\}-\{profile\}.properties  
    例如：config-client-dev.properties，我们可以通过“[http://localhost:8086/config-client-dev.properties”，直接访问到配置内容。][http_localhost_8086_config-client-dev.properties]

## 三：ConfigClient ##

*  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.1.4.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.lll</groupId>
        <artifactId>config-client</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>config-client</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
            <spring-cloud.version>Greenwich.SR1</spring-cloud.version>
        </properties>
    
        <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.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>

*  yml文件配置

server:
      port: 8087
    spring:
      application:
        name: config-client
      cloud:
        config:
          label: master
          profile: dev
          uri: http://localhost:8086

*  注意要点

> 特别注意：上面这些与spring-cloud相关的属性必须配置在bootstrap.yml中,bootstrap.yml的加载也是先于application.yml。

*  Controller

@RestController
    public class ConfigClientController { 
    
        @Value("${people.name}")
        String name;
    
        @GetMapping("1")
        public String configClientTest(){ 
            return name;
        }
    }

*  访问“[http://localhost:8087/1”][http_localhost_8087_1]

> Tom is happy

### GitHub地址：[https://github.com/oldgarlic/spring-cloud][https_github.com_oldgarlic_spring-cloud] ###

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMDA4NTM1_size_16_color_FFFFFF_t_70]: /images/20220217/daa7a8c360b54ba6a7acaeea8406edd0.png
[people.name]: http://people.name
[http_localhost_8086_config-client_dev_server_git]: http://localhost:8086/config-client/dev%E2%80%9D%EF%BC%8C%E5%87%BA%E7%8E%B0%E4%B8%8B%E5%88%97%E8%A1%A8%E7%A4%BAserver%E7%AB%AF%E5%B7%B2%E7%BB%8F%E6%88%90%E5%8A%9F%E8%8E%B7%E5%8F%96%E4%BA%86git%E4%BB%93%E5%BA%93%E7%9A%84%E9%85%8D%E7%BD%AE%E4%BF%A1%E6%81%AF%E3%80%82
[https_github.com_oldgarlic_spring-cloud_config-client-dev.properties_source_people.name_Tom]: https://github.com/oldgarlic/spring-cloud/config-client-dev.properties%22,%22source%22:%7B%22people.name%22:%22Tom
[http_localhost_8086_config-client-dev.properties]: http://localhost:8086/config-client-dev.properties%E2%80%9D%EF%BC%8C%E7%9B%B4%E6%8E%A5%E8%AE%BF%E9%97%AE%E5%88%B0%E9%85%8D%E7%BD%AE%E5%86%85%E5%AE%B9%E3%80%82
[http_localhost_8087_1]: http://localhost:8087/1%E2%80%9D
[https_github.com_oldgarlic_spring-cloud]: https://github.com/oldgarlic/spring-cloud