中文参考网站: https://www.springcloud.cc/spring-cloud-config.html.
概述:
前提:分布式面临的问题:配置文件的大量重复和臃肿。
(1)Spring Cloud Config是什么:
Spring Cloud Config 为分布式系统中的外部化配置提供服务器端和客户端支持。使用 Config Server,您可以集中管理所有环境中应用程序的外部属性。客户机和服务器上的概念完全对应于Spring环境和PropertySource抽象,因此它们非常适合 Spring 应用程序,但可以用于以任何语言运行的任何应用程序。当应用程序通过部署管道从开发到测试再进入生产时,您可以管理这些环境之间的配置,并确保应用程序在迁移时拥有运行所需的一切。服务器存储后端的默认实现使用 git,因此它可以轻松支持标记版本的配置环境,并且可以访问用于管理内容的各种工具。添加替代实现并使用 Spring config将它们插入很容易。
官网地址:https://cloud.spring.io/spring-cloud-config/reference/html/
(2)怎么用:
(3)能干嘛:
Spring Cloud Config Server功能:
用于外部配置的HTTP,基于资源的API(名称 值对或等效的YAML内容)
加密和解密属性值(对称或非对称)
使用可轻松嵌入Spring Boot应用程序
可以轻松的结合Eureka实现高可用
可以轻松的结合Spring Cloud Bus实现自动化持续集成
Config Client功能(适用于Spring应用程序):
绑定到Config Server并Environment使用远程属性源初始化Spring
加密和解密属性值(对称或非对称)
结合Eureka实现服务发现
Config服务端配置与测试:
(1)在github上新建一个springcloud-config的新仓库
新建完仓库后,我们在github官网上有个 upload file传本地的三个yml文件。
其中文件内容如下;
config-prod.yml:
config:
info: master-prod,版本:1
config-dev.yml:
config:
info: master-dev,版本:1
config-test.yml:
config:
info: master-test,版本:1
将本地文件拖转进去即可:
(2)获取刚刚新建的git地址:如git@github.com:fandongdong666/springcloud-config.git
(3)本地硬盘上新建git仓库并clone ,为了在本地进行保存和修改方便。
如何从GitHub上clone仓库到本地:
首先我们可以自己创建一个本地的仓库,比如d://gitRepository/springcloud2020
克隆地址请按照如下方式找到:
然后我们的目标文件夹中就远程下载下来我们github上的文件:如文件:config-dev.yml
配置好git后,鼠标右键–>git bash here -->然后输入克隆命令:git clone 克隆地址
其他git命令;
(1)建模块:cloud-config-center-3344
(2)pom:
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
<!--eureka注册中心 客户端-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!--springboot-web 两个组件-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
<version>2.2.2.RELEASE</version>
</dependency>
<dependency><!--热部署-->
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
(3)yml: 这里强烈建议使用gitee,速度快,外网github太慢了.
server:
port: 3344 #消费端 ,建议一定有
spring:
application:
name: cloud-config-center #微服务名称,建议有
cloud:
config:
server:
git:
uri: https://gitee.com/fandongdong666/springcloud-config.git #github上git仓库克隆地址
username: fan666 # your ysername
password: **** #your password
search-paths: #github上的搜索路径,即仓库名
- springcloud-config
label: master #读取的分支
eureka: #注册中心
client:
register-with-eureka: true #true表示向注册中心注册自己。
fetch-registry: true #true要抓取/拉取注册信息。
service-url: # 将自己注册到 哪些默认注册中心 中去(localhost:7003)
defaultZone: http://eureka7003.com:7003/eureka
主启动类:com.fan.ConfigCenterMain3344
package com.fan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;
@SpringBootApplication
@EnableConfigServer
public class ConfigCenterMain3344 {
public static void main(String[] args) {
SpringApplication.run(ConfigCenterMain3344.class,args);
}
}
配置hosts文件映射: C:\WINDOWS\system32\drivers\etc
添加如下代码:
# config center
127.0.0.1 config-3344.com
启动注册中心的微服务,和配置中心的微服务。然后
测试:http://config-3344.com:3344/master/config-dev.yml
测试成功的结果:
配置读取规则:
第一种:
第二种:
第三种:
Config客户端配置与测试:
(1)新建模块:cloud-config-client-3355
(2)改pom:增加spring-cloud-stater-config依赖
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<!--eureka注册中心 client-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!--springboot-web 两个组件-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
<version>2.2.2.RELEASE</version>
</dependency>
<dependency><!--热部署-->
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
(3)yml: bootstrap.yml
小技巧:等spring的配置文件不出现小叶子时的解决方法之一:重新导入maven
bootstrap.yml :
server:
port: 3355
spring:
application:
name: config-client
cloud:
config: #config 客户端配置
label: master #分支名称
name: config #配置文件名称
profile: dev #读取后缀名称,也可以换成test文件
uri: http://localhost:3344 #配置中心地址
#eureka注册中心配置
eureka:
client:
service-url:
defaultZone: http://eureka7003.com:7003/eureka
#暴露监控端点
management:
endpoints:
web:
exposure:
include: "*"
配置文件说明:
(4)主启动类:com.fan.springcloud.ConfigClientMain3355
package com.fan.springcloud;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
@SpringBootApplication
@EnableEurekaClient
public class ConfigClientMain3355 {
public static void main(String[] args) {
SpringApplication.run(ConfigClientMain3355.class,args);
}
}
(5)业务类controller:controller.ConfigClientController ,和git上的配置文件中的格式搭配
package com.fan.springcloud.controller;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@Slf4j
@RefreshScope
public class ConfigClientController {
//测试能否读取配置文件中的内容
@Value("${config.info}")
private String configInfo;
@GetMapping(value = "/configInfo")
public String getConfigInfo(){
return configInfo;
}
}
测试:先启动注册中心,然后启动配置中心3344,然后启动微服务3355
3344配置中心自测:
config-3344.com:3344/master/config-dev.yml
config-3344.com:3344/master/config-test.yml
3355客户端访问测试:localhost:3355/configInfo
遇到的问题:
Config客户端之动态刷新:
手动刷新的实现步骤:
修改3355客户端的yml:
修改controller:
测试:http://localhost:3355/configInfo
发现没能及时改变:
运维要先修改运程仓库配置–>然后明确发送post通知配置已更换–>然后测试 http://localhost:3355/configInfo
curl -X POST “http://localhost:3355/actuator/refresh”