SpringCloud第六篇：分布式配置中心（Spring Cloud Config）（Finchley版本）

       在上一篇文章讲述zuul的时候，已经提到过，使用配置服务来保存各个服务的配置文件。它就是Spring Cloud Config。

一、简介

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

二、构建Config Server

1、首先创建一个父maven工程SpringCloud_Common_Config_Server，其他工程的pom依赖于此maven工程

       父maven工程结构如图所示：

       父pom.xml内容如图所示：

<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</groupId>
  <artifactId>SpringCloud_Common_Config_Server</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>pom</packaging>

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

  <name>SpringCloud_Config_Server</name>
  <url>http://maven.apache.org</url>

  <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>Finchley.RELEASE</spring-cloud.version>
  </properties>

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

 2、创建maven工程SpringCloud_Config_Server

       工程结构如图所示：

       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>

  <artifactId>SpringCloud_Config_Server</artifactId>
  <packaging>jar</packaging>

    <parent>
  		<groupId>com</groupId>
		<artifactId>SpringCloud_Common_Config_Server</artifactId>
  		<version>0.0.1-SNAPSHOT</version>
	</parent>


  <name>SpringCloud_Config_Server</name>
  <url>http://maven.apache.org</url>
	<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>
	</dependencies>
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>
</project>

3、在程序的入口Application类加上@EnableConfigServer注解开启配置服务器的功能，代码如下：

package com.SpringCloud_Config_Server;

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

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

4、需要在程序的配置文件application.properties文件配置以下：

spring.application.name=config-server
server.port=8888
spring.cloud.config.server.git.uri=https://github.com/BuGeiQianJiuZa/SpringCloudConfig/
#spring.cloud.config.server.git.searchPaths=respo
spring.cloud.config.label=master
spring.cloud.config.server.git.username=
spring.cloud.config.server.git.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/BuGeiQianJiuZa/SpringCloudConfig/ 中有个文件config-client-dev.properties文件，打开这个文件，里面有这样一个属性：

foo = foo version 3

5、依次启动SpringCloud_Config_Server、SpringCloud_Config_Client，然后访问http://localhost:8888/foo/dev，或者

http://localhost:8888/abcd/defg等任意字符，这里只是为了证明配置服务中心可以从远程程序获取配置信息，没有其他的作用

       http请求地址和资源文件映射如下，意思就是说知道了http请求的地址也就知道了资源文件的名称，反之，也可以知道http请求的地址。（不同类型的文件，访问的方式不同）

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

三、构建一个config client

1、创建maven工程SpringCloud_Config_Client

       工程结构如图所示：

       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>

  <artifactId>SpringCloud_Config_Client</artifactId>
  <packaging>jar</packaging>

   <parent>
  	<groupId>com</groupId>
	<artifactId>SpringCloud_Common_Config_Server</artifactId>
  	<version>0.0.1-SNAPSHOT</version>
    </parent>
	
  <name>SpringCloud_Config_Client</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </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>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>
</project>

       bootstrap.properties内容如图所示：

#这个“config-client”是和git服务器上面的文件名相应的，如果你的客户端是其他的名字就报错找不到参数
#因为现在的git服务器上有这个config-client-dev的配置文件，所以这里是config-client    
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

       注意点：客户端加载到的配置文件的配置项会覆盖本项目已有配置，比如客户端你自己配置的端口是8881，但是如果读取到config-clent-dev这个配置文件中也有配置端口为8882，那么此时客户端访问的地址应该是8882。

spring.cloud.config.label 指明远程仓库的分支

spring.cloud.config.profile

       dev：开发环境配置文件

       test：测试环境

       pro：正式环境

spring.cloud.config.uri= http://localhost:8888/ 指明配置服务中心的网址

2、编写程序的入口类，写一个API接口“/hi”，返回从配置中心读取的foo变量的值，代码如下：

package com.zit;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication	
@RestController
public class ConfigClientApplication {

	public static void main(String[] args) {
		SpringApplication.run(ConfigClientApplication.class,args);
	}
	
	@Value("${foo}")
	String foo;
	
	@RequestMapping(value="/hi")
	public String hi() {
		return foo;
	}
}

       打开网址访问：http://localhost:8881/hi，网页显示： 

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