需要进行以下几个步骤:
一、创建一个基础的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> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.6.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.example</groupId> <artifactId>config-server</artifactId> <version>0.0.1-SNAPSHOT</version> <name>config-server</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> <spring-cloud.version>Greenwich.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> </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>
三、在应用程序的主类上添加@EnableConfigServer注解,开启Spring Cloud Config的服务端功能。
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
四、在application.properties配置文件中添加配置服务的基本信息以及Git仓库的相关信息,内容如下:
spring.application.name=config-server server.port=7001 #Git仓库的位置 spring.cloud.config.server.git.uri=https://github.com/hedanning/SpringCloudConfigLearn #仓库路径下的相对搜索位置 spring.cloud.config.server.git.search-paths=spring_cloud_in_action/config-repo #访问Git仓库的用户名 spring.cloud.config.server.git.username=username #访问Git仓库的密码 spring.cloud.config.server.git.password=passward
到此,使用一个通过Spring Cloud Config实现并使用Git管理配置内容的分布式配置中心就完成了。
---------------------------------------配置规则详解----------------------------------------
为了验证上面完成的分布式配置中心config-server,根据Git配置信息中指定的仓库位置,在https://github.com/hedanning/SpringCloudConfigLearn 下创建一个spring_cloud_in_action/config-repo目录作为配置仓库,并根据不同环境新建下面4个配置文件:
- hdnspace.properties
- hdnspace-dev.properties
- hdnspace-test.properties
- hdnspace-prod.properties
在这4个文件中均设置一个from属性,并为每个配置文件中分别设置不同的值:
- from=git-default-1.0
- from=git-dev-1.0
- from=git-test-1.0
- from=git-prod-1.0
以上的配置文件默认咋master分支中。再创建一个config-label-test分支,并将配置文件中的值用2.0作为后缀。
完成以上的步骤之后,我们就可以通过浏览器、PSTMAN或CURL等工具直接来访问我们的配置内容了,访问配置信息的URL与配置文件的映射关系如下:
- / { 应用名 } / { 环境名 } [ / { 分支名 } ]
- / { 应用名 } - { 环境名 }.yml
- / { 应用名 } - { 环境名 }.properties
- / { 分支名 } / { 应用名 } - { 环境名 }.yml
- / { 分支名 } / { 应用名 } - { 环境名 }.properties
比如,我们来访问:http://localhost:7001/hdnspace/prod/config-label-test,得到如下内容:
同时我们可以看到config-server的控制台上输出的内容,config-server会通过git clone命令将配置文件内容复制一份在本地存储,然后读取这些内容并返回给为服务应用进行加载:
config-server通过git在本地仓库暂存,防止当Git仓库出现故障而引起无法加载配置信息的情况。这时,当无法从远程仓库获取内容的时候就可以从本地仓库中去读取之前暂存的内容。我们断开网络再次访问之前的请求: