spring cloud 入门系列七：基于Git存储的分布式配置中心--Spring Cloud Config

时间：2023-03-08 23:24:40
spring cloud 入门系列七：基于Git存储的分布式配置中心--Spring Cloud Config

我们前面接触到的spring cloud组件都是基于Netflix的组件进行实现的，这次我们来看下spring cloud 团队自己创建的一个全新项目：Spring Cloud Config.
它用来为分布式系统中的基础设施和微服务提供集中化的外部配置支持，分为服务端和客户端两个部分。

其中服务端也称为分布式配置中心，他是独立的微服务应用，用来连接配置仓库并为客户端提供获取接口(这些接口返回配置信息、加密、解密信息等)；

客户端是微服务架构中的各个微服务应用或基础设施，它们通过制定的配置中心来管理应用资源与业务相关的配置内容，并在启动的时候从配置中心获取和加载配置信息。
由于配置中心默认采用Git来存储配置信息，因此我们会用到Git相关的内容，如果没有用过Git或者忘记怎么用了，可以参考下廖雪峰老师的Git教程。
另外，我自己用的Git远程仓库是码云。
====================华丽的分割线===================
接下来看下代码怎么实现。

一、准备远程Git仓库

  1. 在Gitee上新建一个项目https://gitee.com/sam-uncle/spring-cloud-learning
  2. 在项目下新建子目录spring-cloud-config-file，然后新建三个文件
    1. 　　spring cloud 入门系列七：基于Git存储的分布式配置中心--Spring Cloud Config
    2. 内容分别是from=git-dev-1.0、from=git-test-1.0、from=git-1.0
  3. 新建一个分支config-lable-test，新分支里面新建三个同名的文件，不过内容分别是from=git-dev-2.0、from=git-test-2.0、from=git-2.0

二、构建配置中心

　　先给出最终代码结构：

　　spring cloud 入门系列七：基于Git存储的分布式配置中心--Spring Cloud Config

　　搭建过程如下：

  1. 新建maven工程config-server
  2. 修改POM文件 
    <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.sam</groupId>
    
  <artifactId>config-server</artifactId>
    
  <version>0.0.1-SNAPSHOT</version>

  <parent>
    
        <groupId>org.springframework.boot</groupId>
    
        <artifactId>spring-boot-starter-parent</artifactId>
    
        <version>1.5.1.RELEASE</version>
    
    </parent>

    <properties>
    
        <javaVersion>1.8</javaVersion>
    
    </properties>
    
    <!-- 使用dependencyManagement进行版本管理 -->
    
    <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>

    <dependencies>
    
       <!-- 引入config server依赖 -->
    
        <dependency>
    
            <groupId>org.springframework.cloud</groupId>
    
            <artifactId>spring-cloud-config-server</artifactId>
    
        </dependency>

    </dependencies>

</project>
  3. 创建启动类 
    /**
    
 * @EnableConfigServer
    
 *
    
 * 开启Spring Cloud Config 的服务端功能
    
 *
    
 */
    
@SpringBootApplication
    
@EnableConfigServer
    
public class ConfigServerApp {

    public static void main(String[] args) {
    
        SpringApplication.run(ConfigServerApp.class, args);
    
    }
    
}
  4. 配置application.properties文件，指定远程仓库信息 
    server.port=7001
    
spring.application.name=config-server

#配置Git仓库的地址
    
spring.cloud.config.server.git.uri=https://gitee.com/sam-uncle/spring-cloud-learning/
    
#配置仓库路径下的相对搜索位置，可以配置多个
    
spring.cloud.config.server.git.search-paths=spring-cloud-config-file
    
#这里配置你的Git仓库的用户名
    
spring.cloud.config.server.git.username=用户名
    
#这里配置你的Git仓库的密码
    
spring.cloud.config.server.git.password=密码
  5. 启动并验证

　　　　访问配置信息的URL与配置文件的映射关系如下：

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

　　　　上面的url会映射{application}-{profile}.properties对应的配置文件，其中{label}对应Git上不同的分支，默认是master。

　　　　通过浏览器访问http://localhost:7001/sam/dev/config-label-test,结果如下：

　　　　spring cloud 入门系列七：基于Git存储的分布式配置中心--Spring Cloud Config

三、实现客户端

 　  最终代码结构：

　　spring cloud 入门系列七：基于Git存储的分布式配置中心--Spring Cloud Config

　　搭建过程如下：

  1. 新建maven工程config-client
  2. 修改POM文件 
    <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.sam</groupId>
    
    <artifactId>config-client</artifactId>
    
    <version>0.0.1-SNAPSHOT</version>

    <parent>
    
        <groupId>org.springframework.boot</groupId>
    
        <artifactId>spring-boot-starter-parent</artifactId>
    
        <version>1.5.1.RELEASE</version>
    
    </parent>

    <properties>
    
        <javaVersion>1.8</javaVersion>
    
    </properties>
    
    <!-- 使用dependencyManagement进行版本管理 -->
    
    <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>

    <dependencies>
    
        <!-- 引入config依赖 -->
    
        <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>

    </dependencies>

</project>
  3. 创建启动类 
    @SpringBootApplication
    
public class ConfigClientApp {

    public static void main(String[] args) {
    
        SpringApplication.run(ConfigClientApp.class, args);
    
    }

}
  4. 配置bootstrap.properties文件，指定config-server位置 
    server.port=7002
    
#{application}
    
spring.application.name=sam
    
#{profile}
    
spring.cloud.config.profile=dev
    
#{label}
    
spring.cloud.config.label=master

#config server uri
    
spring.cloud.config.uri=http://localhost:7001/
  5. 创建controller 
    @RefreshScope
    
@RestController
    
public class TestController {

    /**
    
     * 通过@Value 来讲配置文件中的值写入到代码中
    
     */
    
    @Value("${from}")
    
    private String from;

    @RequestMapping("/from")
    
    public String from() {
    
        return from;
    
    }
    
}
  6. 启动并测试

　　　　spring cloud 入门系列七：基于Git存储的分布式配置中心--Spring Cloud Config

四、工作原理
Spring Cloud Config配置中心的工作原理如下：

  1. 客户端启动时，根据bootstrap.properties中配置的应用名{application}、环境名{profile}、分支名{label}，向Config Server请求获取配置信息。
  2. Config Server根据自己维护的Git仓库信息和客户传递过来的配置定位信息去查找配置信息。
  3. 通过git clone命令将找到的配置信息下载到本地（Config Server的文件系统中）。在通过页面访问或启动客户端的时候，我们在服务端能看到如下下载的log： 
    -- ::58.055  INFO  --- [nio--exec-] o.s.c.c.s.e.NativeEnvironmentRepository  : Adding property source: file:/C:/Users/sam/AppData/Local/Temp/config-repo-/spring-cloud-config-file/sam-dev.properties
    
-- ::58.055  INFO  --- [nio--exec-] o.s.c.c.s.e.NativeEnvironmentRepository  : Adding property source: file:/C:/Users/sam/AppData/Local/Temp/config-repo-/spring-cloud-config-file/sam.properties
  4. Config Server创建Spring 的ApplicationContext实例，并从Git本地仓库中加载配置文件，最后将这些配置内容读取出来返回给客户端。
  5. 客户端在获取外部配置信息后加载到客户端的applicationContext实例。

相关文章