统一配置中心 Spring Cloud Config

本文涉及的产品
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 RDS PostgreSQL,高可用系列 2核4GB
RDS MySQL Serverless 高可用系列,价值2615元额度,1个月
简介: 在我们了解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端获取到了参数,
到此一个完整的服务端提供配置服务,客户端获取配置参数的例子就完成了。

相关实践学习
每个IT人都想学的“Web应用上云经典架构”实战
本实验从Web应用上云这个最基本的、最普遍的需求出发,帮助IT从业者们通过“阿里云Web应用上云解决方案”,了解一个企业级Web应用上云的常见架构,了解如何构建一个高可用、可扩展的企业级应用架构。
MySQL数据库入门学习
本课程通过最流行的开源数据库MySQL带你了解数据库的世界。 &nbsp; 相关的阿里云产品:云数据库RDS MySQL 版 阿里云关系型数据库RDS(Relational Database Service)是一种稳定可靠、可弹性伸缩的在线数据库服务,提供容灾、备份、恢复、迁移等方面的全套解决方案,彻底解决数据库运维的烦恼。 了解产品详情:&nbsp;https://www.aliyun.com/product/rds/mysql&nbsp;
相关文章
|
2月前
|
负载均衡 监控 Java
Spring Cloud Gateway 全解析:路由配置、断言规则与过滤器实战指南
本文详细介绍了 Spring Cloud Gateway 的核心功能与实践配置。首先讲解了网关模块的创建流程,包括依赖引入(gateway、nacos 服务发现、负载均衡)、端口与服务发现配置,以及路由规则的设置(需注意路径前缀重复与优先级 order)。接着深入解析路由断言,涵盖 After、Before、Path 等 12 种内置断言的参数、作用及配置示例,并说明了自定义断言的实现方法。随后重点阐述过滤器机制,区分路由过滤器(如 AddRequestHeader、RewritePath、RequestRateLimiter 等)与全局过滤器的作用范围与配置方式,提
Spring Cloud Gateway 全解析:路由配置、断言规则与过滤器实战指南
|
2月前
|
Java 关系型数据库 MySQL
Spring Boot自动配置:魔法背后的秘密
Spring Boot 自动配置揭秘:只需简单配置即可启动项目,背后依赖“约定大于配置”与条件化装配。核心在于 `@EnableAutoConfiguration` 注解与 `@Conditional` 系列条件判断,通过 `spring.factories` 或 `AutoConfiguration.imports` 加载配置类,实现按需自动装配 Bean。
|
2月前
|
人工智能 Java 开发者
【Spring】原理解析:Spring Boot 自动配置
Spring Boot通过“约定优于配置”的设计理念,自动检测项目依赖并根据这些依赖自动装配相应的Bean,从而解放开发者从繁琐的配置工作中解脱出来,专注于业务逻辑实现。
|
4月前
|
Java Spring
Spring Boot配置的优先级?
在Spring Boot项目中,配置可通过配置文件和外部配置实现。支持的配置文件包括application.properties、application.yml和application.yaml,优先级依次降低。外部配置常用方式有Java系统属性(如-Dserver.port=9001)和命令行参数(如--server.port=10010),其中命令行参数优先级高于系统属性。整体优先级顺序为:命令行参数 &gt; Java系统属性 &gt; application.properties &gt; application.yml &gt; application.yaml。
942 0
|
1月前
|
前端开发 Java 应用服务中间件
《深入理解Spring》 Spring Boot——约定优于配置的革命者
Spring Boot基于“约定优于配置”理念,通过自动配置、起步依赖、嵌入式容器和Actuator四大特性,简化Spring应用的开发与部署,提升效率,降低门槛,成为现代Java开发的事实标准。
|
2月前
|
缓存 Java 应用服务中间件
Spring Boot配置优化:Tomcat+数据库+缓存+日志,全场景教程
本文详解Spring Boot十大核心配置优化技巧,涵盖Tomcat连接池、数据库连接池、Jackson时区、日志管理、缓存策略、异步线程池等关键配置,结合代码示例与通俗解释,助你轻松掌握高并发场景下的性能调优方法,适用于实际项目落地。
528 5
|
2月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
178 0
探索Spring Boot的@Conditional注解的上下文配置
|
7月前
|
安全 Java API
深入解析 Spring Security 配置中的 CSRF 启用与 requestMatchers 报错问题
本文深入解析了Spring Security配置中CSRF启用与`requestMatchers`报错的常见问题。针对CSRF,指出默认已启用,无需调用`enable()`,只需移除`disable()`即可恢复。对于`requestMatchers`多路径匹配报错,分析了Spring Security 6.x中方法签名的变化,并提供了三种解决方案:分次调用、自定义匹配器及降级使用`antMatchers()`。最后提醒开发者关注版本兼容性,确保升级平稳过渡。
892 2
|
8月前
|
缓存 Java API
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的配置
本文介绍了在Spring Boot中配置Swagger2的方法。通过创建一个配置类,添加`@Configuration`和`@EnableSwagger2`注解,使用Docket对象定义API文档的详细信息,包括标题、描述、版本和包路径等。配置完成后,访问`localhost:8080/swagger-ui.html`即可查看接口文档。文中还提示了可能因浏览器缓存导致的问题及解决方法。
1002 0
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的配置
|
9月前
|
XML Java 测试技术
Spring IOC—基于注解配置和管理Bean 万字详解(通俗易懂)
Spring 第三节 IOC——基于注解配置和管理Bean 万字详解!
640 26

热门文章

最新文章

下一篇
oss云网关配置