10. Spring Cloud Config 分布式配置
Dalston.RELEASE
Spring Cloud Config为分布式系统中的外部配置提供服务器和客户端支持。使用Config Server,您可以在所有环境中管理应用程序的外部属性。客户端和服务器上的概念映射与Spring Environment
和PropertySource
抽象相同,因此它们与Spring应用程序非常契合,但可以与任何以任何语言运行的应用程序一起使用。随着应用程序通过从开发人员到测试和生产的部署流程,您可以管理这些环境之间的配置,并确定应用程序具有迁移时需要运行的一切。服务器存储后端的默认实现使用git,因此它轻松支持标签版本的配置环境,以及可以访问用于管理内容的各种工具。很容易添加替代实现,并使用Spring配置将其插入。
概述
分布式系统面临的–配置文件问题
微服务意味着要将单体应用中的业务拆分成一个个子服务,每个服务的粒度相对较小,因此系统中会出现大量的服务,由于每个服务都需要必要的配置信息才能运行,所以一套集中式的,动态的配置管理设施是必不可少的。spring cloud提供了configServer来解决这个问题,我们每一个微服务自己带着一个application.yml,那上百个的配置文件修改起来,令人头疼!
什么是SpringCloud config分布式配置中心?
spring cloud config 为微服务架构中的微服务提供集中化的外部支持,配置服务器为各个不同微服务应用的所有环节提供了一个中心化的外部配置。
spring cloud config 分为服务端和客户端两部分。
服务端也称为 分布式配置中心,它是一个独立的微服务应用,用来连接配置服务器并为客户端提供获取配置信息,加密,解密信息等访问接口。
客户端则是通过指定的配置中心来管理应用资源,以及与业务相关的配置内容,并在启动的时候从配置中心获取和加载配置信息。配置服务器默认采用git来存储配置信息,这样就有助于对环境配置进行版本管理。并且可用通过git客户端工具来方便的管理和访问配置内容。
spring cloud config 分布式配置中心能干嘛?
- 集中式管理配置文件
- 不同环境,不同配置,动态化的配置更新,分环境部署,比如 /dev /test /prod /beta /release
- 运行期间动态调整配置,不再需要在每个服务部署的机器上编写配置文件,服务会向配置中心统一拉取配置自己的信息
- 当配置发生变动时,服务不需要重启,即可感知到配置的变化,并应用新的配置
- 将配置信息以REST接口的形式暴露
spring cloud config 分布式配置中心与GitHub整合
由于spring cloud config 默认使用git来存储配置文件 (也有其他方式,比如自持SVN 和本地文件),但是最推荐的还是git ,而且使用的是 http / https 访问的形式。
spring cloud config有疑问看SpringCloud的Dalston版本的官方文档:Spring Cloud Dalston 中文文档 参考手册 中文版
入门案例
服务端
新建springcloud-config-server-3344模块导入pom.xml依赖
<dependencies>
<!--web-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--config-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
<version>2.1.1.RELEASE</version>
</dependency>
<!--eureka-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
<version>1.4.6.RELEASE</version>
</dependency>
</dependencies>
resource下创建application.yml配置文件,Spring Cloud Config服务器从git存储库(必须提供)为远程客户端提供配置:
server:
port: 3344
spring:
application:
name: springcloud-config-server
# 连接码云远程仓库
cloud:
config:
server:
git:
# 注意是https的而不是ssh
uri: https://gitee.com/cao_shi_peng/springcloud-config.git
# 通过 config-server可以连接到git,访问其中的资源以及配置~
# 不加这个配置会报Cannot execute request on any known server 这个错:连接Eureka服务端地址不对
# 或者直接注释掉eureka依赖 这里暂时用不到eureka
eureka:
client:
register-with-eureka: false
fetch-registry: false
主启动类:@EnableConfigServer // 开启spring cloud config server服务
@EnableConfigServer // 开启spring cloud config server服务
@SpringBootApplication
public class Config_server_3344 {
public static void main(String[] args) {
SpringApplication.run(Config_server_3344.class,args);
}
}
将本地git仓库springcloud-config文件夹下新建的application.yml提交到码云仓库:
application.yml文件内容:
spring:
profile:
active: dev
---
spring:
profile: dev
application:
name: springcloud-config-dev
---
spring:
profile: test
application:
name: springcloud-config-test
定位资源的默认策略是克隆一个git仓库(在spring.cloud.config.server.git.uri
),并使用它来初始化一个迷你SpringApplication
。小应用程序的Environment
用于枚举属性源并通过JSON端点发布。
HTTP服务具有以下格式的资源:即我们可以通过这个去访问到我们想要的git上的远程配置文件application.yml。
/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
其中“application”作为SpringApplication
中的spring.config.name
注入(客户端配置)(即常规的Spring Boot应用程序中通常是“application”,“git上的配置文件名无后缀”);
“profile”是活动配置文件(或逗号分隔列表的属性);
“label”是可选的git标签(默认为“master”)。
测试访问http://localhost:3344/application-dev.yml
测试访问 http://localhost:3344/application/test/master
测试访问 http://localhost:3344/master/application-dev.yml
如果测试访问不存在的配置则不显示 如:http://localhost:3344/master/application-aaa.yml
客户端
将本地git仓库springcloud-config文件夹下新建的config-client.yml提交到码云仓库:
config-client.yml文件:
#spring配置文件
spring:
profiles:
active: dev
---
server:
port: 8201
spring:
profiles: dev
application:
name: springcloud-provider-dept
eureka:
client:
service-url:
defaultZone: http://localhost:7001/eureka/
---
server:
port: 8202
spring:
profiles: test
application:
name: springcloud-provider-dept
eureka:
client:
service-url:
defaultZone: http://localhost:7001/eureka/
新建一个springcloud-config-client-3355模块,并导入依赖
<!--config-->
<!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-start -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
<version>2.1.1.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
resources下创建application.yml和bootstrap.yml配置文件
bootstrap.yml 是系统级别的配置
# 系统级别的配置
spring:
cloud:
config:
name: config-client #需要从git上读取的资源名称,不要后缀
profile: dev
label: master
uri: http://localhost:3344
#系统级别配置就像之前的server里面的文件路径一样,只是拆分开了,代码会从这里拿到并拼接,
例如:/{application}/{profile}[/{label}] 对应的 http://localhost:3344/application/test/master
application.yml 是用户级别的配置
# 用户级别的配置
spring:
application:
name: springcloud-config-client-3355 //告诉用户名称
创建controller包下的ConfigClientController.java 用于测试
@RestController
public class ConfigClientController {
#这里的@value是spring中通过属性注入,详见spring5博客,
#${}是读取配置文件的值,原理见我的博客:@Value 注解的使用及@Value(${})和 @Value(#{})的区别
https://blog.csdn.net/weixin_45433031/article/details/120375429
@Value("${spring.application.name}")
private String applicationName; //获取微服务名称
@Value("${eureka.client.service-url.defaultZone}")
private String eurekaServer; //获取Eureka服务
@Value("${server.port}")
private String port; //获取服务端的端口号
@RequestMapping("/config")
public String getConfig(){
return "applicationName:"+applicationName +
"eurekaServer:"+eurekaServer +
"port:"+port;
}
}
主启动类
@SpringBootApplication
public class ConfigClient {
public static void main(String[] args) {
SpringApplication.run(ConfigClient.class,args);
}
}
测试:
启动服务端Config_server_3344 再启动客户端ConfigClient
我们通过服务端先访问一下,结果ok。
然后通过客户端访问:http://localhost:8201/config/,当启动主启动类的时候,我们就已经从配置中心(server)中拿到了远程的客户端spring配置,写ConfigClientController类的目的是为了让我们看一下拿到的数据。(比如这里的端口号8201,我们在本地是没有配置的,这是从远端配置文件拿的)
小案例:
本地新建config-dept.yml和config-eureka.yml并提交到码云仓库
config-dept.yml文件:
spring:
profiles:
active: dev
---
server:
port: 8001
#mybatis配置文件
mybatis:
mapper-locations: classpath:mybatis/mapper/*Mapper.xml
type-aliases-package: com.kuang.springcloud.pojo
config-location: classpath:mybatis/mapper/mybatis_config.xml
#spring配置文件
spring:
profiles: dev
application:
name: springcloud-provider-dept
datasource:
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: org.gjt.mm.mysql.Driver
url: jdbc:mysql://localhost:3306/DB02?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
username: root
password: 123
eureka:
client:
service-url:
defaultZone: http://localhost:7001/eureka/
instance:
instance-id: springcloud-provider-dept-8001
info:
app.name: kuangshen
company.name: 陕西理工
---
server:
port: 8001
#mybatis配置文件
mybatis:
mapper-locations: classpath:mybatis/mapper/*Mapper.xml
type-aliases-package: com.kuang.springcloud.pojo
config-location: classpath:mybatis/mapper/mybatis_config.xml
#spring配置文件
spring:
profiles: test
application:
name: springcloud-provider-dept
datasource:
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: org.gjt.mm.mysql.Driver
url: jdbc:mysql://localhost:3306/DB01?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
username: root
password: 123
eureka:
client:
service-url:
defaultZone: http://localhost:7001/eureka/
instance:
instance-id: springcloud-provider-dept-8001
info:
app.name: kuangshen
company.name: 陕西理工
config-eureka.yml文件:
spring:
profiles:
active: dev
---
spring:
profiles: dev
applicartion:
name:springcloud-config-eureka-dev
server:
port: 7001
#eureka配置
eureka:
instance:
hostname: localhost #eureka服务端的名称
client:
register-with-eureka: false #表示是否想注册中心注册自己,我们是服务器端,肯定不注册
fetch-registry: true #表示自己是否是注册中心
service-url:
defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/
---
spring:
profiles: test
applicartion:
name:springcloud-config-eureka-test
server:
port: 7001
#eureka配置
eureka:
instance:
hostname: localhost #eureka服务端的名称
client:
register-with-eureka: false #表示是否想注册中心注册自己,我们是服务器端,肯定不注册
fetch-registry: true #表示自己是否是注册中心
service-url:
defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/
这里配置文件内容不再列举直接到代码中看把。
新建springcloud-config-eureka-7001模块,并将原来的springcloud-eureka-7001模块下的内容拷贝的该模块。
1.清空该模块的application.yml配置,并新建bootstrap.yml连接远程配置
spring:
cloud:
config:
name: config-eureka # 仓库中的配置文件名称
label: master
profile: dev
uri: http://localhost:3344
2.在pom.xml中添加spring cloud config依赖
<!--config-->
<!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-config -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
<version>2.1.1.RELEASE</version>
</dependency>
3.主启动类
@SpringBootApplication
@EnableEurekaServer //EnableEurekaServer 服务端的启动类,可以接受别人注册进来~
public class ConfigEurekaServer_7001 {
public static void main(String[] args) {
SpringApplication.run(ConfigEurekaServer_7001.class,args);
}
}
4.测试
第一步:启动 Config_Server_3344,并访问 http://localhost:3344/master/config-eureka-dev.yml 测试
第二部:启动ConfigEurekaServer_7001,访问 http://localhost:7001/ 测试
显示上图则成功
------------------------------------------------------------------------------------------------------------------------
新建springcloud-config-dept-8001模块并拷贝springcloud-provider-dept-8001的内容
同理导入spring cloud config依赖、清空application.yml 、新建bootstrap.yml配置文件并配置
spring:
cloud:
config:
name: config-dept
label: master
profile: dev
uri: http://localhost:3344
主启动类
@SpringBootApplication
@EnableEurekaClient //在服务启动后自动注册到Eureka中!
@EnableDiscoveryClient //服务发现~
@EnableCircuitBreaker //
public class ConfigDeptProvider_8001 {
public static void main(String[] args) {
SpringApplication.run(ConfigDeptProvider_8001.class,args);
}
//增加一个 Servlet
@Bean
public ServletRegistrationBean hystrixMetricsStreamServlet(){
ServletRegistrationBean registrationBean = new ServletRegistrationBean(new HystrixMetricsStreamServlet());
registrationBean.addUrlMappings("/actuator/hystrix.stream");
return registrationBean;
}
}
启动测试:
打开eureka,发现已经注册进来了
我们可以通过controller访问到我们想要的数据(8001端口,eureka配置等都是从远程配置的)
总结:
使用springcloud-config我们就把配置和代码实现解耦,运维就可以在远程实现配置,我们本地的代码不需要改变。
未来学习:算法等