统一配置中心 Spring Cloud Config

本文涉及的产品
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
云数据库 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端获取到了参数,
到此一个完整的服务端提供配置服务,客户端获取配置参数的例子就完成了。

相关实践学习
如何快速连接云数据库RDS MySQL
本场景介绍如何通过阿里云数据管理服务DMS快速连接云数据库RDS MySQL,然后进行数据表的CRUD操作。
全面了解阿里云能为你做什么
阿里云在全球各地部署高效节能的绿色数据中心,利用清洁计算为万物互联的新世界提供源源不断的能源动力,目前开服的区域包括中国(华北、华东、华南、香港)、新加坡、美国(美东、美西)、欧洲、中东、澳大利亚、日本。目前阿里云的产品涵盖弹性计算、数据库、存储与CDN、分析与搜索、云通信、网络、管理与监控、应用服务、互联网中间件、移动服务、视频服务等。通过本课程,来了解阿里云能够为你的业务带来哪些帮助 &nbsp; &nbsp; 相关的阿里云产品:云服务器ECS 云服务器 ECS(Elastic Compute Service)是一种弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。产品详情: https://www.aliyun.com/product/ecs
相关文章
|
6天前
|
XML Java 测试技术
Spring IOC—基于注解配置和管理Bean 万字详解(通俗易懂)
Spring 第三节 IOC——基于注解配置和管理Bean 万字详解!
68 26
|
2月前
|
Java Spring
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
178 73
|
3月前
|
Java 开发者 微服务
手写模拟Spring Boot自动配置功能
【11月更文挑战第19天】随着微服务架构的兴起,Spring Boot作为一种快速开发框架,因其简化了Spring应用的初始搭建和开发过程,受到了广大开发者的青睐。自动配置作为Spring Boot的核心特性之一,大大减少了手动配置的工作量,提高了开发效率。
77 0
|
19天前
|
监控 Java 数据库连接
Spring c3p0配置详解
在Spring项目中配置C3P0数据源,可以显著提高数据库连接的效率和应用程序的性能。通过合理的配置和优化,可以充分发挥C3P0的优势,满足不同应用场景的需求。希望本文的详解和示例代码能为开发者提供清晰的指导,帮助实现高效的数据库连接管理。
32 10
|
2月前
|
Java Spring
【Spring配置相关】启动类为Current File,如何更改
问题场景:当我们切换类的界面的时候,重新启动的按钮是灰色的,不能使用,并且只有一个Current File 项目,下面介绍两种方法来解决这个问题。
|
2月前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
2月前
|
Java Spring
【Spring配置】创建yml文件和properties或yml文件没有绿叶
本文主要针对,一个项目中怎么创建yml和properties两种不同文件,进行配置,和启动类没有绿叶标识进行解决。
|
2月前
|
NoSQL Java Redis
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
123 14
|
2月前
|
XML Java 数据格式
Spring容器Bean之XML配置方式
通过对以上内容的掌握,开发人员可以灵活地使用Spring的XML配置方式来管理应用程序的Bean,提高代码的模块化和可维护性。
71 6
|
2月前
|
XML Java 数据格式
🌱 深入Spring的心脏:Bean配置的艺术与实践 🌟
本文深入探讨了Spring框架中Bean配置的奥秘,从基本概念到XML配置文件的使用,再到静态工厂方式实例化Bean的详细步骤,通过实际代码示例帮助读者更好地理解和应用Spring的Bean配置。希望对你的Spring开发之旅有所助益。
137 3