SpringCloud学习笔记（七）Config——分布式配置中心

SpringCloud Config 为服务端和客户端提供了分布式系统的外部化配置支持。配置服务器为各应用的所有环境提供了一个中心化的外部配置。它实现了对服务端和客户端对Spring Environment 和PropertySource抽象的映射，所以它除了适用于Spring构建的应用程序，也可以在任何其他语言运行的应用程序中使用。作为一个应用可以通过部署管道来进行测试或者投入生产，我们可以分别为这些环境创建配置，并且在需要迁移环境的时候获取对应环境的配置来运行。

配置服务器默认采用git来存储配置信息，这样就有助于对环境进行版本管理，并且可以通过git客户端工具老方便的管理和访问配置内容。当然它也提供本地化文件系统的存储方式，下面从这两方面记录如何使用分布式配置来存储为服务应用多环境的配置内容。

入正题，配置中心肯定是分客户端和服务端的，我们先说服务端

创建一个新的SpringBoot 工程config_server 需要两个依赖

web

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.chunying</groupId>
   <artifactId>serv</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>

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

   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>1.4.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>Camden.SR6</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>

首先要表明这是一个config server

主类加注解@EnableConfigServer

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;

@SpringBootApplication
@EnableConfigServer
public class ServApplication {

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

application.properties

server.port=8767
spring.application.name=config_server

#git 管理配置
spring.cloud.config.server.git.uri=http://[email protected]/bitbucket/scm/~chunying.wang/cloudconfig.git
spring.cloud.config.server.git.search-paths=
spring.cloud.config.server.git.username=your username
spring.cloud.config.server.git.password=your password
spring.cloud.config.label=master

端口8767，服务名称config_server

重点来了有关git仓库的配置我用的git仓库是个人的bitbucket，这里的git 路径什么的根据不同的git可能有区别具体情况具体对待，意思都是一样的

spring.cloud.config.server.git.uri=git仓库的位置

spring.cloud.config.server.git.search-paths=配置仓库路径下的相对搜索位置，可以配置多个。这里我没有配置

spring.cloud.config.server.git.username=访问git用户名

spring.cloud.config.server.git.password=访问git密码

spring.cloud.config.lable=访问的分支

到这里，通过git 使用SpringCloud Config就实现了配置中心的管理

（ps：这里补充一下本地存储配置的方式，我们只需要设置属性spring.profiles.active=native , Config server 会默认从应用的src/main/resource 目录下检索配置文件，也可以通过spring.cloud.config.server.native.searchLocation=file:F:/prc属性来制定配置文件的位置。但是我还是推荐使用git 仓库的方式，所以这种我并没有测试）

为了验证上面的配置，我们需要在仓库加一个配置文件进行测试

配置文件名称demo-dev.properties (ps:不要在意这么烂的名字，乱起的)

设置属性test = test version 1 ，提交到git仓库

这里说一下properties文件的命名规则。

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

这是url与配置文件的映射关系。

我们上面的配置文件会映射

{application}-{profile}.properties

启动项目当然这里可能遇到各种错误什么仓库找不到什么的云云自己多试一下吧我就是。肯定会试出正确的

访问 http://localhost:8767/demo-dev/test

返回结果

其实好像应该返回的是json 我也不清楚为什么返回的是xml，还在研究。。但是结果是对的有之前设置的值

服务端就这样成功了下面说微服务端如何获取获取配置

新建一个SpringBoot 工程 config_client 需要两个依赖

web

config client

创建bootstrap.proprties 这里要注意必须是bootstrap.properties，config 部分的内容才能呗正确加载。因为config的相关配置会先于application.properties,而bootstrap.properties的加载也是先于application.properties的

spring.application.name=demo
spring.cloud.config.profile=dev
spring.cloud.config.label=master
spring.cloud.config.uri=http://localhost:8767/

server.port=8768

端口8768

spring.application.name= 服务名字，这里要注意这个名字，要和我们配置中心的properties文件的{application}名字一致，否则就找不到了

spring.cloud.config.profile=这里提到过根据上面的映射关系找到这个值

spring.cloud.config.lable=访问分支

spring.cloud.config.uri= 配置中心的地址

我们写一个测试类测试我们读取到的内容

package com.chunying.configclient.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author chunying
 */
@RestController
public class DemoController {

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

    @RequestMapping(value = "/test")
    public String getHehe() {
        return this.test;
    }


}

启动工程当然这里也会出现很多未知名的错误多试试就好了

访问 http://localhost:8768/test

返回 test version 1

说明取到了我们配置文件中的配置

SpringCloud学习笔记（七）Config——分布式配置中心

猜你喜欢