统一配置中心 Spring Cloud Config

本文涉及的产品
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 RDS PostgreSQL,集群系列 2核4GB
简介: 在我们了解spring cloud config之前,我可以想想一个配置中心提供的核心功能应该有什么提供服务端和客户端支持集中管理各环境的配置文件配置文件修改之后,可以快速的生效可以进行版本管理支持大的并发查询支持各种语言Spring Cloud Config可以完美的支持以上所有的需求。Spring Cloud Config项目是一个解决分布式系统的配置管理方案。它包含了Client和Server两个部分,server提供配置文件的存储、以接口的形式将配置文件的内容提供出去,client通过接口获取数据、并依据此数据初始化自己的应用。

首先在github上面创建了一个项目config-repo用来存放配置文件,为了模拟开发生产测试环境,我们创建以下四个配置文件:

// 开发环境
robot-dev.properties
// 测试环境
robot-test.properties
// 生产环境
robot-pro.properties
// 以上配置文件中共同内容
robot.properties
为了验证不同环境下,可以加载不同的配置值,每个环境中都添加server.port这个值来修改tomcat的启动端口。这样可以比较直观的看到程序读取了不同的配置。

server 端
1、 创建项目spring-cloud-config-server
2、添加依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>


3、配置文件
spring.application.name=spring-cloud-config-server
spring.cloud.config.server.git.uri=https://github.com/calcyu/config-repo
spring.cloud.config.server.git.username=calcyu
spring.cloud.config.server.git.password=密码

远程配置项目的本地缓存目录,注意不要指定为项目根目录,会把项目代码全部删除

spring.cloud.config.server.git.basedir=./config/basedir
eureka.client.service-url.defaultZone=http://localhost:8000/eureka/

4、启动类
启动类添加@EnableConfigServer,激活对配置中心的支持

@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {

public static void main(String[] args) {
    SpringApplication.run(ConfigServerApplication.class, args);
}

}
到此server端相关配置已经完成

5、测试
首先我们先要测试server端是否可以读取到github上面的配置信息,直接访问:http://localhost:8080/robot-dev.yml

返回信息如下:

eureka:
client:

service-url:
  defaultZone: http://localhost:8000/eureka/

mysql:
password: 321
username: root
password: 123
server:
port: 9090
spring:
application:

name: robot

rabbitmq:

host: 192.168.190.187
password: admin
port: 5672
username: admin

username: meimei
上述的返回的信息包含了配置文件的位置、版本、配置文件的名称以及配置文件中的具体内容,说明server端已经成功获取了git仓库的配置信息。

可以修改扩展名来返回不同格式的配置信息
例如:

http://localhost:8080/robot-dev.properties
http://localhost:8080/robot-dev.yml
http://localhost:8080/robot-dev.json
http://localhost:8080/robot-test.properties
http://localhost:8080/robot-test.yml
http://localhost:8080/robot-test.json
http://localhost:8080/robot-pro.properties
http://localhost:8080/robot-pro.yml
http://localhost:8080/robot-pro.json

本地管理配置文件
Spring Cloud Config也提供本地存储配置的方式。
把配置文件修改为

spring.application.name=spring-cloud-config-server

spring.cloud.config.server.git.uri=https://github.com/calcyu/config-repo

spring.cloud.config.server.git.username=calcyu

spring.cloud.config.server.git.password=密码

远程配置项目的本地缓存目录,注意不要指定为项目根目录,会把项目代码全部删除

spring.cloud.config.server.git.basedir=./config/basedir

eureka.client.service-url.defaultZone=http://localhost:8000/eureka/
spring.cloud.config.server.native.searchLocations=file:E:/calcyu/config

当客户端发送请求,配置中心会从E:/calcyu/config查找对应的配置文件。

虽然Spring Cloud Config提供了这样的功能,但是为了支持更好的管理内容和版本控制的功能,还是推荐使用git的方式。

client 端
主要展示如何在业务项目中去获取server端的配置信息

创建项目spring-cloud-robot

1、添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>


新版本eureka客户端需要引入spring-boot-starter-web包,eureka服务端不需要,自身包含web依赖

2、配置文件
把配置文件application.properties改名为bootstrap.properties

配置bootstrap.properties如下:

spring.application.name=robot
eureka.client.service-url.defaultZone=http://localhost:8000/eureka/

从注册中心获取配置中心服务id

spring.cloud.config.discovery.service-id=spring-cloud-config-server
spring.cloud.config.discovery.enabled=true
spring.profiles.active=dev

默认分支为master

spring.cloud.config.label=master
以上配置:客户端会请求http://localhost:8080/robot-dev.yml获取配置信息。

spring.application.name:对应{application}部分
spring.profiles.active:对应{profile}部分
spring.cloud.config.label:对应git的分支。如果配置中心使用的是本地存储,则该参数无用
spring.cloud.config.uri:配置中心的具体地址
spring.cloud.config.discovery.service-id:指定配置中心的service-id,便于扩展为高可用配置集群。
特别注意:上面这些与spring-cloud相关的属性必须配置在bootstrap.properties中,config部分内容才能被正确加载。因为config的相关配置会先于application.properties,而bootstrap.properties的加载也是先于application.properties。

3、启动类
启动类添加@EnableConfigServer,激活对配置中心的支持

@SpringBootApplication
public class ConfigClientApplication {

public static void main(String[] args) {
    SpringApplication.run(ConfigClientApplication.class, args);
}

}
启动类只需要@SpringBootApplication注解就可以

4、web测试
创建两个类MysqlConfig.java和GetConfigController.java

使用@ConfigurationProperties("mysql")定义参数前缀,通过成员变量username和password来获取参数的值

MysqlConfig.java

@Component
@ConfigurationProperties("mysql")
public class MysqlConfig {

private String username;
private String password;

public String getUsername() {
    return username;
}

public void setUsername(String username) {
    this.username = username;
}

public String getPassword() {
    return password;
}

public void setPassword(String password) {
    this.password = password;
}

}
上面类可以获取以下配置项的值

mysql:

username: admin
password: 123

使用@Value注解来获取配置中username和password参数的值

GetConfigController.java

@RestController
public class GetConfigController {

@Value("${username}")
private String userName;

@Value("${password}")
private String password;

@GetMapping("userinfo")
public String getUserInfo() {
    return String.format("用户名:%s,密码:%s", userName, password);
}

@Autowired
private MysqlConfig mysqlConfig;

@GetMapping("mysql")
public String getMysql() {
    return String.format("用户名:%s,密码:%s", mysqlConfig.getUsername(), mysqlConfig.getPassword());
}

}

启动项目后依次访问:

http://desktop-deqbgel:9090/userinfo
http://desktop-deqbgel:9090/mysql
如果显示对应的值说明已经正确的从server端获取到了参数,
到此一个完整的服务端提供配置服务,客户端获取配置参数的例子就完成了。

相关实践学习
如何在云端创建MySQL数据库
开始实验后,系统会自动创建一台自建MySQL的 源数据库 ECS 实例和一台 目标数据库 RDS。
全面了解阿里云能为你做什么
阿里云在全球各地部署高效节能的绿色数据中心,利用清洁计算为万物互联的新世界提供源源不断的能源动力,目前开服的区域包括中国(华北、华东、华南、香港)、新加坡、美国(美东、美西)、欧洲、中东、澳大利亚、日本。目前阿里云的产品涵盖弹性计算、数据库、存储与CDN、分析与搜索、云通信、网络、管理与监控、应用服务、互联网中间件、移动服务、视频服务等。通过本课程,来了解阿里云能够为你的业务带来哪些帮助 &nbsp; &nbsp; 相关的阿里云产品:云服务器ECS 云服务器 ECS(Elastic Compute Service)是一种弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。产品详情: https://www.aliyun.com/product/ecs
相关文章
|
13天前
|
XML Java 数据格式
Spring IOC—基于XML配置Bean的更多内容和细节(通俗易懂)
Spring 第二节内容补充 关于Bean配置的更多内容和细节 万字详解!
88 18
Spring IOC—基于XML配置Bean的更多内容和细节(通俗易懂)
|
1天前
|
前端开发 Java Spring
关于spring mvc 的 addPathPatterns 拦截配置常见问题
关于spring mvc 的 addPathPatterns 拦截配置常见问题
|
1月前
|
Cloud Native Java Nacos
Spring Cloud Config、Apollo、Nacos和Archaius对比
这篇文章对比了Spring Cloud Config、Apollo、Nacos和Archaius这四种配置中心的适应场景、优缺点。文中讨论了它们的功能特点,例如Spring Cloud Config的集中化配置管理和动态刷新能力,Apollo的实时配置推送和权限治理,Nacos的服务发现和管理功能,以及Archaius的动态配置更新能力。文章指出选择配置中心应根据项目需求和架构来决定,并提供了一个对比图来帮助读者更直观地理解这些工具的差异。
36 1
Spring Cloud Config、Apollo、Nacos和Archaius对比
|
14天前
|
Java 数据库连接 Maven
Spring基础1——Spring(配置开发版),IOC和DI
spring介绍、入门案例、控制反转IOC、IOC容器、Bean、依赖注入DI
Spring基础1——Spring(配置开发版),IOC和DI
|
26天前
|
IDE Java 开发工具
还在为繁琐的配置头疼吗?一文教你如何用 Spring Boot 快速启动,让开发效率飙升,从此告别加班——打造你的首个轻量级应用!
【9月更文挑战第2天】Spring Boot 是一款基于 Spring 框架的简化开发工具包,采用“约定优于配置”的原则,帮助开发者快速创建独立的生产级应用程序。本文将指导您完成首个 Spring Boot 项目的搭建过程,包括环境配置、项目初始化、添加依赖、编写控制器及运行应用。首先需确保 JDK 版本不低于 8,并安装支持 Spring Boot 的现代 IDE,如 IntelliJ IDEA 或 Eclipse。
80 5
|
30天前
|
Java 微服务 Spring
Spring Cloud全解析:配置中心之解决configserver单点问题
但是如果该configserver挂掉了,那就无法获取最新的配置了,微服务就出现了configserver的单点问题,那么如何避免configserver单点呢?
|
27天前
|
Java Spring 开发者
解锁 Spring Boot 自动化配置的黑科技:带你走进一键配置的高效开发新时代,再也不怕繁琐设置!
【8月更文挑战第31天】Spring Boot 的自动化配置机制极大简化了开发流程,使开发者能专注业务逻辑。通过 `@SpringBootApplication` 注解组合,特别是 `@EnableAutoConfiguration`,Spring Boot 可自动激活所需配置。例如,添加 JPA 依赖后,只需在 `application.properties` 配置数据库信息,即可自动完成 JPA 和数据源设置。这一机制基于多种条件注解(如 `@ConditionalOnClass`)实现智能配置。深入理解该机制有助于提升开发效率并更好地解决问题。
45 0
|
27天前
|
Java Spring 开发者
Spring 框架配置属性绑定大比拼:@Value 与 @ConfigurationProperties,谁才是真正的王者?
【8月更文挑战第31天】Spring 框架提供 `@Value` 和 `@ConfigurationProperties` 两种配置属性绑定方式。`@Value` 简单直接,适用于简单场景,但处理复杂配置时略显不足。`@ConfigurationProperties` 则以类级别绑定配置,简化代码并更好组织配置信息。本文通过示例对比两者特点,帮助开发者根据具体需求选择合适的绑定方式,实现高效且易维护的配置管理。
34 0
|
30天前
|
缓存 Java 数据库连接
Spring Boot 资源文件属性配置,紧跟技术热点,为你的应用注入灵动活力!
【8月更文挑战第29天】在Spring Boot开发中,资源文件属性配置至关重要,它让开发者能灵活定制应用行为而不改动代码,极大提升了可维护性和扩展性。Spring Boot支持多种配置文件类型,如`application.properties`和`application.yml`,分别位于项目的resources目录下。`.properties`文件采用键值对形式,而`yml`文件则具有更清晰的层次结构,适合复杂配置。此外,Spring Boot还支持占位符引用和其他外部来源的属性值,便于不同环境下覆盖默认配置。通过合理配置,应用能快速适应各种环境与需求变化。
33 0
|
3天前
|
算法 安全 Java
微服务(四)-config配置中心的配置加解密
微服务(四)-config配置中心的配置加解密