SpringCloud第七篇-Spring Cloud Config

痛定思痛。 2022-06-06 00:59 120阅读 0赞

### 简介 ###

在分布式系统中，由于服务数量巨多，为了方便服务配置文件统一管理，实时更新，所以需要分布式配置中心组件。在Spring Cloud中，有分布式配置中心组件spring cloud config ，它支持配置服务放在配置服务的内存中（即本地），也支持放在远程Git仓库中。在spring cloud config 组件中，分两个角色，一是config server，二是config client。  
![这里写图片描述][SouthEast]

### 项目准备 ###

新建两个项目  
\- config-server配置服务  
\- config-client客户端

这里使用另一个作者的git仓库中的配置

### 构建项目 ###

#### config-server ####

服务端项目创建

##### 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>
    
        <groupId>com.bamboo</groupId>
        <artifactId>config-server</artifactId>
        <packaging>pom</packaging>
        <version>1.0-SNAPSHOT</version>
        <modules>
            <module>../config-client</module>
        </modules>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.2.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>
        </properties>
    
        <dependencies>
    
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-config-server</artifactId>
            </dependency>
    
        </dependencies>
    
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>Camden.SR6</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>
    
        <repositories>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
            </repository>
        </repositories>
    
    </project>

##### yml #####

在程序的配置文件application.properties

spring.application.name=config-server
    server.port=8888
    
    
    spring.cloud.config.server.git.uri=https://github.com/forezp/SpringcloudConfig/
    spring.cloud.config.server.git.searchPaths=respo
    spring.cloud.config.label=master
    spring.cloud.config.server.git.username=your username
    spring.cloud.config.server.git.password=your password

*  spring.cloud.config.server.git.uri：配置git仓库地址  
    \-spring.cloud.config.server.git.searchPaths：配置仓库路径  
    \-spring.cloud.config.label：配置仓库的分支  
    \-spring.cloud.config.server.git.username：访问git仓库的用户名  
    \-spring.cloud.config.server.git.password：访问git仓库的用户密码

如果Git仓库为公开仓库，可以不填写用户名和密码，如果是私有仓库需要填写，本例子是公开仓库，放心使用。

远程仓库[https://github.com/forezp/SpringcloudConfig/][https_github.com_forezp_SpringcloudConfig] 中有个文件config-client-dev.properties文件中有一个属性：

foo = foo version 3

##### java #####

@EnableConfigServer注解开启配置服务器的功能

package com.bamboo;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.config.server.EnableConfigServer;
    
    /** * Created by xialeme on 2017/10/25. */
    @SpringBootApplication
    @EnableConfigServer//注解开启配置服务器的功能
    public class ConfigServerApplication { 
    
        public static void main(String[] args) {
            SpringApplication.run(ConfigServerApplication.class, args);
        }
    }

##### 启动程序：访问[http://localhost:8888/foo/dev][http_localhost_8888_foo_dev] #####

{"name":"foo","profiles":["dev"],"label":"master",
    "version":"792ffc77c03f4b138d28e89b576900ac5e01a44b","state":null,"propertySources":[]}

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

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

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

#### 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">
    
        <groupId>com.bamboo</groupId>
        <version>1.0-SNAPSHOT</version>
        <modelVersion>4.0.0</modelVersion>
        <artifactId>config-client</artifactId>
    
    
    
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.2.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>
        </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>Dalston.RC1</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>
    
        <repositories>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
            </repository>
        </repositories>
    
    </project>

##### yml #####

配置文件bootstrap.properties

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

*  spring.cloud.config.label 指明远程仓库的分支
 *  spring.cloud.config.profile  
    
    
     *  dev开发环境配置文件
     *  test测试环境
     *  pro正式环境
 *  spring.cloud.config.uri= [http://localhost:8888/][http_localhost_8888] 指明配置服务中心的网址。

##### java #####

package com.bamboo;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * Created by xialeme on 2017/10/25. */
    @SpringBootApplication
    @RestController
    public class ConfigClientApplication { 
    
        public static void main(String[] args) {
            SpringApplication.run(ConfigClientApplication.class, args);
        }
    
        @Value("${foo}")
        String foo;
        //提供客户端调用的接口
        @RequestMapping(value = "/hello")
        public String hi(){
            return foo;
        }
    }

##### 打开网址访问：[http://localhost:8881/hello][http_localhost_8881_hello]，网页显示 #####

foo version 3

这就说明，config-client从config-server获取了foo的属性，而config-server是从git仓库读取的,如图：

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

### 参考资料 ###

[http://projects.spring.io/spring-cloud/spring-cloud.html\#\_spring\_cloud\_config][http_projects.spring.io_spring-cloud_spring-cloud.html_spring_cloud_config]

[SouthEast]: /images/20220606/157ac7ad3f7243559ecbb90379390fd6.png
[https_github.com_forezp_SpringcloudConfig]: https://github.com/forezp/SpringcloudConfig/
[http_localhost_8888_foo_dev]: http://localhost:8888/foo/dev
[http_localhost_8888]: http://localhost:8888/
[http_localhost_8881_hello]: http://localhost:8881/hello
[600]: /images/20220606/a18653b33a4b4150896b204151df5fc1.png
[http_projects.spring.io_spring-cloud_spring-cloud.html_spring_cloud_config]: http://projects.spring.io/spring-cloud/spring-cloud.html#_spring_cloud_config