为了避免每次对配置文件的更改需要重新打包部署,SpringCloud提供了一种方式,可以通过config来进行远程管理。
每次只要在git上修改配置文件信息,无需服务的重启即可做到更新。
本文主要是创建一个config server微服务,并且注册到eureka服务管理中心上。
eureka项目的搭建:https://blog.csdn.net/Yu_uuuuu/article/details/82223790
第一步:创建存放配置文件的项目
首先在GIt上创建一个用于存放配置文件的项目。
配置文件的命名规则为,你需要获取的客户端的 项目名(Application name)- 环境名称( profile)
例如我的项目叫做spring-cloud-client ,三个环境分别为dev\test\pro
在这里我分别创建了三个环境的配置文件,用来对应不同环境需求。
还有一个叫做application.yml的配置文件,用作存放公共的配置信息。
然后在每个配置文件中定义一个自定义属性用作测试观察:
第二步:创建一个config配置文件中心
接下来我们创建一个config服务中心。
通过IDEA创建一个SpringCloud-config-server的工程,工程名为springcloud-config-server
GIT地址:https://github.com/yukaiji/springcloud-config-server
工程目录结构如下:
其中POM文件的内容如下(使用IDEA快速生成的话不用变):
<?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.0http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.kaijiyu</groupId>
<artifactId>config-server</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>config-server</name>
<description>Spring Cloud Config Server</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.4.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>Finchley.SR1</spring-cloud.version>
</properties>
<dependencies>
<!-- config核心配置文件 -->
<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>
项目创建完之后,我们只需要通过简单的配置即可完成。
对配置文件,application.properties进行配置,这里我用的是yml格式文件。
# 应用名
spring. application.name: config-server
# 存储配置文件的git地址
spring.cloud.config.server.git.uri: https://github.com/yukaiji/springcloud-app-config
# git用户名
spring.cloud.config.server.git.username: root
# git密码
spring.cloud.config.server.git.password: 123456
# 启动端口号
server.port: 9001
对启动类ConfigServerApplication添加一个config服务注解@EnableConfigServer。
只要对完成上述几个简单的配置即可启动项目。
启动完成之后我们可以通过浏览器进行观察一下。
访问localhost:9001/spring-cloud-client/test 就能看到我们需要的配置文件信息
可以看到成功的访问到了我们配置的两个配置文件,并且显示了我们自定义的属性。
其中访问的格式非常重要:
application:项目名称
profile:环境名称
label:git配置文件的分支
• /{application}/{profile} [/{label}]
• /{application}-{profile}.yml
• /{label}/{application}-{profile}.yml
• /{application}-{profile}.properties
• /{label}/{application}-{profile}.properties
接下来我们将conifg服务注册到eureka上去,后续可以通过服务来访问ConfigServer
eureka项目Demo GIT地址:https://github.com/yukaiji/springcloud-eureka-server
第一步:在configServer的POM文件添加eureka依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
第二步:在配置文件中添加eureka注册中心地址(如果是eureka集群,用逗号分隔)
eureka.client.serviceUrl.defaultZone: http://eurekaserver1:1111/eureka/
第三步:首先启动Eureka服务,然后再启动configServer服务
然后我们通过访问Eureka页面可以看到:
到此为止,我们已经搭建了一个基于GIT远程管理配置文件的springCloud-config服务。
并且将服务注册到了Eureka上。
下面我们来实现一下,创建一个服务端,来注册到eureka服务中心,并且采用config远程配置的方式来提供一个服务接口。