SpringCloud教程 | 九.分布式配置中心(Spring Cloud Config)

冷不防 2021-09-26 11:48 335阅读 0赞

在分布式环境中，为了方便配置文件的管理，引入了spring cloud config组件,在该组件中，分为两个角色，一个是server，一个是client，它支持配置服务放在配置服务的内存中（即本地），也支持放在远程Git仓库中。

**实战**

一.config server

1.创建一个configserver项目，pom如下：

<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>1.5.9.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>
    		<spring-cloud.version>Edgware.SR1</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>
    		
    		
    		<dependency>
    		    <groupId>org.eclipse.jgit</groupId>
    		    <artifactId>org.eclipse.jgit</artifactId>
    		    <version>4.8.0.201706111038-r</version>
    		</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>

2.在运行类上加入@EnableConfigServer注解开启配置服务器的功能

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.config.server.EnableConfigServer;
    
    @SpringBootApplication
    @EnableConfigServer
    public class SpringCloudEurekaConfigServerApplication {
    	public static void main(String[] args) {
    		SpringApplication.run(SpringCloudEurekaConfigServerApplication.class, args);
    	}
    }

3.application.properties文件配置以下：

spring.application.name=config-server
    server.port=8888
    spring.cloud.config.server.git.uri=https://github.com/1154978352/config.git
    spring.cloud.config.server.git.searchPaths=/
    spring.cloud.config.server.git.username=username
    spring.cloud.config.server.git.password=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仓库为公开仓库，可以不填写用户名和密码，如果是私有仓库需要填写，本例子是公开仓库，放心使用。

Spring Cloud Config也提供本地存储配置的方式。我们只需要设置属性**spring.profiles.active=native**，Config Server会默认从应用的**src/main/resource**目录下检索配置文件。也可以通过**spring.cloud.config.server.native.searchLocations=file:F:/properties/**属性来指定配置文件的位置。虽然Spring Cloud Config提供了这样的功能，但是为了支持更好的管理内容和版本控制的功能，还是推荐使用git的方式。

![20180130143350467][]

如上图所示，在远程仓库中有git-dev.properties文件，该文件内的内容为from=git-dev，如下图所示

![SouthEast][]

我们在地址栏上输入http://localhost:8888/from/dev,得到如下结果则证明连接仓库成功

{"name":"from","profiles":["dev"],"label":null,"version":"04272bd9598899ac1174c07deb467e78ed157630","state":null,"propertySources":[]}

URL与配置文件的映射关系如下：  
  
/\{application\}/\{profile\}\[/\{label\}\]  
/\{application\}-\{profile\}.yml  
/\{label\}/\{application\}-\{profile\}.yml  
/\{application\}-\{profile\}.properties

/\{label\}/\{application\}-\{profile\}.properties

二.构建一个config client

1.项目名称为spring-cloud-eureka-configClient，pom.xml如下

<name>spring-cloud-eureka-configClient</name>
    	<description>Demo project for Spring Boot</description>
    
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>1.5.9.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>
    		<spring-cloud.version>Edgware.SR1</spring-cloud.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-tomcat</artifactId>
    			<scope>provided</scope>
    		</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>

2.bootstarp.properties

【注意】：这边的spring.application.name以及spring.cloud.config.profile要与对应的配置文件名称一致

即spring.application.name：对应前配置文件中的\{application\}部分，spring.cloud.config.profile：对应前配置文件中的\{profile\}部分。

这里需要格外注意：下面这些属性必须配置在bootstrap.properties中，config部分内容才能被正确加载。因为config的相关配置会先于application.properties，而bootstrap.properties的加载也是先于application.properties。

server.port=8001
    spring.application.name=gwd
    spring.cloud.config.profile=dev
    spring.cloud.config.label=master
    spring.cloud.config.uri= http://localhost:8888/

spring.cloud.config.label  指明远程仓库的分支  
spring.cloud.config.uri= http://localhost:8888/ 指明配置服务中心的地址

![SouthEast 1][]  
  
3.controller

import org.springframework.beans.factory.annotation.Value;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    /** 
    * @FileName ConfigClientController.java
    * @Description:TODO
    * @author JackHisen(gu.weidong)
    * @version V1.0
    * @createtime 2018年1月29日 下午3:46:54 
    * 修改历史：
    * 时间           作者          版本        描述
    *====================================================
    */
    @RestController
    public class ConfigClientController {
    	@Value("${from}")
    	String from;
    	@RequestMapping("/hi")
    	public String testMsg() {
    		return from;
    	}
    }

4.输入网址http://localhost:8001/hi，显示git-dev，则表示成功

[20180130143350467]: /images/20210923/d6c6d9b1894b49849390194f3d729e9e.png
[SouthEast]: /images/20210923/2101429b6c654b6a833b57e4b6146441.png
[SouthEast 1]: /images/20210923/5f6e63f180d0446b974d6e2a489277ba.png