Spring cloud Config客户端和服务端快速入门环境搭建

最新推荐文章于 2022-10-15 18:33:42 发布

立小言先森

最新推荐文章于 2022-10-15 18:33:42 发布

阅读量1.8k

点赞数 2

CC 4.0 BY-SA版权

分类专栏：【spring系列】文章标签： spring cloud config 微服务配置中心 spring boot

本文链接：https://blog.youkuaiyun.com/yaomingyang/article/details/83685022

【spring系列】专栏收录该内容

203 篇文章

订阅专栏

本文详细介绍了如何使用Spring Cloud Config构建分布式配置中心，包括配置中心的搭建、配置规则解析及客户端应用程序的配置映射。通过实例演示了如何在微服务应用中获取和使用配置中心的配置信息。

一.构建配置中心

通过Spring Cloud Config构建一个配置中心非常简单，可以分为三步：

创建一个基础的spring boot项目，命名为config-server,并在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.config</groupId>
    <artifactId>server</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>server</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </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>Greenwich.M1</spring-cloud.version>
    </properties>

    <dependencies>
        <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>

    <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>

创建spring boot的程序主类，并添加你@EnableConfigServer注解，开启Spring Cloud Config的服务端功能：

package com.config.server;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;
@EnableConfigServer
@SpringBootApplication
public class ServerApplication {

    public static void main(String[] args) {

        SpringApplication.run(ServerApplication.class, args);
    }
}

在application.properties中添加配置服务的基本信息以及Git仓库的相关信息，我是使用GitHub做的测试：

spring.applica七ion.name=config-server 
server.port=7001
spring.cloud.config.server.git.uri=git@github.com:xxxx/config-center.git
spring.cloud.config.server.git.searchPaths=spring-cloud-config
spring.cloud.config.server.git.username=1xxxxxxx68@qq.com
spring.cloud.config.server.git.password=6xxxx8

其中Git的配置信息分别表示如下：

其中spring.cloud.config.server.git.uri：配置Git仓库的位置。
spring.cloud.config.server.git.searchPaths：配置仓库路径下的相对搜索位置，可以配置多个。
spring.cloud.config.server.git.username：访问Git仓库的用户名。
spring.cloud.config.server.g江.password：访问Git仓库的用户密码。
到这一步我们通过Spring Cloud Config实现，并使用Git管理配置内容的分布式配置中心就完成了；然后我们启动服务器看有没有报错，没有说明以上的配置就是OK的，运行结果如下：

二、配置规则详解

为了验证上面完成的分布式配置中心config-server,根据Git配置信息中指定的仓库位置，在git@github.com:xxxx/config-center.git下创建一个spring-cloud-config目录作为配置仓库，并根据不同的环境新建4个配置文件：

server.properties
server-dev.properties
server-test.properties
server-prod.properties
在上面的4个文件中均设置了一个from属性，并未每个配置文件分别设置了不同的值，如下所示：
from=git-default-1.0
from=git-test-1.0
from=git-dev-1.0
from=git-prod-1.0

将上面的4个配置文件提交到GitHub上：
在这里插入图片描述
为了测试版本控制，在该Git仓库的master分支中，我们为from属性加入1.0的后缀，同时创建了一个dev分支，并将配置文件中的值用2.0做后缀。

完成了上面这些工作之后我们可以在浏览器中访问我们的配置了，访问配置信息的URL与配置文件的映射关系如下所示：

/{application}/{profile}[/{label}]
{/application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
上面的url会映射到{application}-{profile}.properties对应的配置文件，其中{label}对应Git上不同的分支，默认是master分支；如下我们通过http://localhost:7001/server/test/master访问的结果：

{
    "name": "server",
    "profiles": [
        "test"
    ],
    "label": "master",
    "version": "2f64482a317ebe84e0ab47196d05c80623438b8c",
    "state": null,
    "propertySources": [
        {
            "name": "git@github.com:yaomy2072608191/config-center.git/spring-cloud-config/server-test.properties",
            "source": {
                "from": "git-test-1.0"
            }
        },
        {
            "name": "git@github.com:yaomy2072608191/config-center.git/spring-cloud-config/server.properties",
            "source": {
                "from": "git-default-1.0"
            }
        }
    ]
}

我们将{label}更换为dev分支访问结果是：

{
    "name": "server",
    "profiles": [
        "test"
    ],
    "label": "dev",
    "version": "18e4edba793210ff965050ce447061b4e3e5977a",
    "state": null,
    "propertySources": [
        {
            "name": "git@github.com:yaomy2072608191/config-center.git/spring-cloud-config/server-test.properties",
            "source": {
                "from": "git-test-2.0"
            }
        },
        {
            "name": "git@github.com:yaomy2072608191/config-center.git/spring-cloud-config/server.properties",
            "source": {
                "from": "git-default-2.0"
            }
        }
    ]
}

我们可以看到JSON中返回了应用名server,环境名test,分支名dev/master;以及default和dev环境的配置内容。另外还有一个version版本号，它对应的是在Git上的commit号。

同时，我们可以看到config-server的控制台中还输出了下面的内容，配置服务器从Git中获取配置信息后，会存储一份在config-server的文件系统中，实质上config-server是通过git clone命令将配置内容复制了一份在本地存储，然后读取这些内容并返回给微服务应用进行加载。

2018-11-03 11:38:53.043  INFO 3695 --- [nio-7001-exec-8] o.s.c.c.s.e.NativeEnvironmentRepository  : Adding property source: file:/var/folders/zx/tkgn67q979j6wxk0lqd9t2fm0000gn/T/config-repo-4776505257090435200/spring-cloud-config/server-test.properties
2018-11-03 11:38:53.043  INFO 3695 --- [nio-7001-exec-8] o.s.c.c.s.e.NativeEnvironmentRepository  : Adding property source: file:/var/folders/zx/tkgn67q979j6wxk0lqd9t2fm0000gn/T/config-repo-4776505257090435200/spring-cloud-config/server.properties

config-server通过Git在本地仓库暂存，可以有效防止当Git仓库出现故障而引起无法加载配置信息的情况。

三、客户端应用程序配置映射

上面我们完成了配置中心得配置，并且可以正常的运行，下面我们尝试如何在微服务应用中获取上述配置信息。

创建一个spring boot应用，命名为config-client,并在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.config</groupId>
    <artifactId>client</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>client</name>
    <description>Spring config client</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </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>Greenwich.M1</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>

    <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>

创建一个spring boot主类，如下：

package com.config.client;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;


@SpringBootApplication
public class ClientApplication {

    public static void main(String[] args) {

        SpringApplication.run(ClientApplication.class, args);
    }
}

创建bootstrap.properties配置，来指定获取配置文件的config-server位置，如下配置：

spring.application.name=server 
spring.cloud.config.profile=prod
spring.cloud.config.label=master
spring.cloud.config.uri=http://localhost:7001/
server.port=7002

上述配置参数与Git中存储的配置文件中的各个部分的对应关系如下：

spring.application.name：对应配置文件规则中的{application}部分。
spring.cloud.config.profile：对应配置文件规则中的{profile}部分。
spring.cloud.config.label：对应配置文件中的{label}部分。
spring.cloud.config.uri：对应config-server配置中心的地址。

到这里可能会产生疑问，这些配置为什么要放在bootstrap.properties配置文件中，而不是放在application.properties配置文件中呢？这与spring boot的加载顺序有关，bootstrap.properties配置文件会优先于application.properties配置文件加载，因此会去加载远程的配合文件信息，到此客户端中配置完成。

创建一个RestFul接口，获取配置中心得配置信息：

package com.config.client;

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;

@RefreshScope
@RestController
public class TestController {

    @Value("${from}")
    private String from;

    @RequestMapping("/from")
    public String from(){
        System.out.println("-----///////");
        return this.from;
    }
}

启动config-client，通过http://localhost:7002/from来访问可以获取不同环境的内容。