Spring Cloud(六)《基于github webhook动态刷新服务配置》

简介: 在实际开发中经常会有一个叫做配置中心的服务,这个服务经过变更参数来动态刷新线上业务数据行为配置。比如;行为开关、活动数据、黑白名单、本地/预发/线上环境切换等等,这些配置信息往往需要在我们不重启系统的时候就可以被更新执行。那么我们一般会使用具备此类属性在分布式系统中适合的组件进行开发配置中心,像是zookeeper、redis发布订阅、或者http定时轮许拉取,他们都可以做成统一配置中心服务。而在Spring Cloud Config 中,默认采用 Git 来存储配置信息,所以使用 Spring Cloud Config 构建的配置服务器,天然就支持对微服务应用配置信息的版本管理,在加上Git

前言介绍

在实际开发中经常会有一个叫做配置中心的服务,这个服务经过变更参数来动态刷新线上业务数据行为配置。比如;行为开关、活动数据、黑白名单、本地/预发/线上环境切换等等,这些配置信息往往需要在我们不重启系统的时候就可以被更新执行。那么我们一般会使用具备此类属性在分布式系统中适合的组件进行开发配置中心,像是zookeeper、redis发布订阅、或者http定时轮许拉取,他们都可以做成统一配置中心服务。而在Spring Cloud Config 中,默认采用 Git 来存储配置信息,所以使用 Spring Cloud Config 构建的配置服务器,天然就支持对微服务应用配置信息的版本管理,在加上Github的Webhook钩子服务,可以在我们push等行为操作的时候,自动执行我们的http行为,以达到自动刷新配置服务。

环境准备

  1. jdk 1.8、idea2018、Maven3
  2. Spring Boot 2.0.6.RELEASE
  3. Spring Cloud Finchley.SR2
  4. 需要有一个Git帐号,用来创建配置中心以及开启Webhooks服务,添加回调

案例说明

通过在个人Git创建配置服务工程,开启Webhooks服务添加回调钩子http://xxx:port/actuator/refresh在更新配置后自动刷新服务配置内容,如图;

24.jpg

代码示例

1itstack-demo-springcloud-06
 2├── itstack-demo-springcloud-config-client
 3│   └── src
 4│       └── main
 5│           ├── java
 6│           │   └── org.itstack.demo
 7│           │        ├── web
 8│           │        │   └── ConfigClientController.java      
 9│           │        └── ConfigClientApplication.java
10│           └── resources   
11│               ├── application.yml
12│               └── bootstrap.yml
13└── itstack-demo-springcloud-config-server
14    └── src
15        └── main
16            ├── java
17            │   └── org.itstack.demo   
18            │        └── ConfigServerApplication.java
19            └── resources   
20                └── application.yml

完整代码欢迎关注公众号:bugstack虫洞栈 回复“SpringCloud专题”进行下载

itstack-demo-springcloud-config-client | 配置获取客户端方,提供自动刷新Http

web/ConfigClientController.java & 添加注解@RefreshScope自动刷新配置

1/**
 2 * 微信公众号:bugstack虫洞栈 | 沉淀、分享、成长,专注于原创专题案例
 3 * 论坛:http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@RestController
 7@RefreshScope
 8public class ConfigClientController {
 9
10    @Value("${info.profile:error}")
11    private String profile;
12
13    @GetMapping("/config")
14    public Mono<String> config() {
15        return Mono.justOrEmpty(profile);
16    }
17
18}
1

ConfigClientApplication.java & 普通配置即可

1/**
 2 * 微信公众号:bugstack虫洞栈 | 沉淀、分享、成长,专注于原创专题案例
 3 * 论坛:http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@SpringBootApplication
 7public class ConfigClientApplication {
 8
 9    public static void main(String[] args) {
10        SpringApplication.run(ConfigClientApplication.class, args);
11    }
12
13}

application.yml & 需要配置endpoints,这样才可以暴漏刷新服务

1spring:
 2  application:
 3    name: itstack-demo-springcloud-config-client
 4server:
 5  port: 9001
 6
 7# /actuator/refresh 这个 Endpoint 暴露出来
 8management:
 9  endpoints:
10    web:
11      exposure:
12        include: refresh

bootstrap.yml & 配置中心服务配置,http://localhost:7397

1spring:
 2  cloud:
 3    config:
 4      uri: http://localhost:7397  # 配置中心的具体地址;itstack-demo-springcloud-config-server
 5      name: config-client         # 对应 {application} 部分,例如;config-client-dev = 只取最后一个符号'-'之前的
 6      profile: dev                # 对应 {profile} 部分
 7      label: master               # 对应 {label} 部分,即 Git 的分支。如果配置中心使用的是本地存储,则该参数无用
 8
 9#配置文件会被转换成 Web,访问规则如下;
10#/{application}/{profile}[/{label}]
11#/{application}-{profile}.yml
12#/{label}/{application}-{profile}.yml
13#/{application}-{profile}.properties
14#/{label}/{application}-{profile}.properties

itstack-demo-springcloud-config-server | 配置提供服务端方,链接Git配置工程地址

ConfigServerApplication.java & 添加注解@EnableConfigServer设置成配置服务中心

1/**
 2 * 微信公众号:bugstack虫洞栈 | 沉淀、分享、成长,专注于原创专题案例
 3 * 论坛:http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@SpringBootApplication
 7@EnableConfigServer
 8public class ConfigServerApplication {
 9
10    public static void main(String[] args) {
11        SpringApplication.run(ConfigServerApplication.class, args);
12    }
13
14}

application.yml &

1server:
 2  port: 7397
 3
 4spring:
 5  application:
 6    name: itstack-demo-springcloud-config
 7  cloud:
 8    config:
 9      server:
10        git:
11          uri: https://github.com/fuzhengwei/itstack-demo-config  # 换成自己的配置Git仓库的地址,如果没有可以新建工程地址,也可以克隆我的
12          search-paths: config-repo                               # Git仓库地址下的底层配置文件名称,如果配置多个用逗号','分割。
13
14# 如果配置中心需要访问权限,则开启配置
15# spring.cloud.config.server.git.username:Github账户
16# spring.cloud.config.server.git.password:Github密码

测试验证

  1. 准备好自己Github的配置仓库,也可以克隆我的Git;https://github.com/fuzhengwei/itstack-demo-config {有一组配置配置文件}
  2. 配置Webhooks,在https://github.com/换你自己的fuzhengwei/换你自己的itstack-demo-netty/settings/hooks/new
  3. 分别启动服务
  1. itstack-demo-springcloud-config-server 配置Server
  2. itstack-demo-springcloud-config-client 配置Client
  1. 访问配置服务,端口7397;http://localhost:7397/config-client/dev
1{
 2    "name": "config-client",
 3    "profiles": [
 4        "dev"
 5    ],
 6    "label": null,
 7    "version": "ea0b1a1017595d542aa01b8b2bda68f9620dd81a",
 8    "state": null,
 9    "propertySources": [
10        {
11            "name": "https://github.com/fuzhengwei/spring-cloud-study/config-repo/config-client-dev.yml",
12            "source": {
13                "info.profile": "dev bus"
14            }
15        }
16    ]
17}
1info:
2    profile: dev bus
  • /{application}/{profile}[/{label}]
  • /{application}-{profile}.yml
  • /{label}/{application}-{profile}.yml
  • /{application}-{profile}.properties
  • /{label}/{application}-{profile}.properties
  1. 访问配置文件;http://localhost:8080/config-client-dev.yml {可以直接访问查看配置信息}
  2. 访问规则{配置文件会被转换成 Web 接口,规则如下}
  3. 访问结果
  1. 访问使用配置的客户端,端口9001;http://localhost:9001/config {可以提交配置代码反复刷新测试}
1dev bus

综上总结

  1. Spring Cloud Config 可以很方便的依赖于Github提供的回调钩子进行更新配置,同时也支持本地配置
  2. Webhooks 不止可以用于变更配置,还可以用于一起启动触发工程打包部署发布的行为
  3. 不要局限于知识点,往往每一个新知识所带来的架构设计更值得学习,这些都可以灵活的用于项目系统中


目录
相关文章
|
4天前
|
Java 开发者 微服务
手写模拟Spring Boot自动配置功能
【11月更文挑战第19天】随着微服务架构的兴起,Spring Boot作为一种快速开发框架,因其简化了Spring应用的初始搭建和开发过程,受到了广大开发者的青睐。自动配置作为Spring Boot的核心特性之一,大大减少了手动配置的工作量,提高了开发效率。
20 0
|
1月前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
42 4
|
29天前
|
Java API 数据库
Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐
本文通过在线图书管理系统案例,详细介绍如何使用Spring Boot构建RESTful API。从项目基础环境搭建、实体类与数据访问层定义,到业务逻辑实现和控制器编写,逐步展示了Spring Boot的简洁配置和强大功能。最后,通过Postman测试API,并介绍了如何添加安全性和异常处理,确保API的稳定性和安全性。
35 0
|
22天前
|
Java API Spring
在 Spring 配置文件中配置 Filter 的步骤
【10月更文挑战第21天】在 Spring 配置文件中配置 Filter 是实现请求过滤的重要手段。通过合理的配置,可以灵活地对请求进行处理,满足各种应用需求。还可以根据具体的项目要求和实际情况,进一步深入研究和优化 Filter 的配置,以提高应用的性能和安全性。
|
14天前
|
Java Spring
[Spring]aop的配置与使用
本文介绍了AOP(面向切面编程)的基本概念和核心思想。AOP是Spring框架的核心功能之一,通过动态代理在不修改原代码的情况下注入新功能。文章详细解释了连接点、切入点、通知、切面等关键概念,并列举了前置通知、后置通知、最终通知、异常通知和环绕通知五种通知类型。
27 1
|
30天前
|
Java BI 调度
Java Spring的定时任务的配置和使用
遵循上述步骤,你就可以在Spring应用中轻松地配置和使用定时任务,满足各种定时处理需求。
123 1
|
1月前
|
JavaScript Linux Windows
Typora图床配置(用自带的 PicGo-Core(command line) 插件GitHub
Typora图床配置(用自带的 PicGo-Core(command line) 插件GitHub
|
2月前
|
前端开发 Java Spring
关于spring mvc 的 addPathPatterns 拦截配置常见问题
关于spring mvc 的 addPathPatterns 拦截配置常见问题
213 1
|
1月前
|
XML Java 数据格式
手动开发-简单的Spring基于注解配置的程序--源码解析
手动开发-简单的Spring基于注解配置的程序--源码解析
46 0
|
1月前
|
XML Java 数据格式
手动开发-简单的Spring基于XML配置的程序--源码解析
手动开发-简单的Spring基于XML配置的程序--源码解析
79 0