文档章节

Spring Cloud Config 使用总结

o
 osc_a22drz29
发布于 2019/03/28 14:46
字数 1775
阅读 11
收藏 0

「深度学习福利」大神带你进阶工程师,立即查看>>>

Spring Cloud Config 使用总结

源码 https://github.com/ChangMuChen/Spring-Boot/tree/master/studies/sourcecode/spring-cloud-config

一、介绍

Spring Cloud Config

Spring Cloud Config为分布式系统中的外部化配置提供服务器和客户端支持。使用Config Server,您可以在所有环境中管理应用程序的外部属性。客户端和服务器上的概念映射与Spring Environment和PropertySource抽象,因此它们非常适合Spring应用程序,但可以与任何语言运行的任何应用程序一起使用。当应用程序通过部署管道从开发到测试并进入生产时,您可以管理这些环境之间的配置,并确保应用程序具有迁移时需要运行的所有内容。服务器存储后端的默认实现使用git,因此它可以轻松支持配置环境的标签版本,以及可用于管理内容的各种工具。添加替代实现并使用Spring配置插入它们很容易。

Spring Cloud Config Server功能

  • 用于外部配置的HTTP,基于资源的API(名称 值对或等效的YAML内容)
  • 加密和解密属性值(对称或非对称)
  • 使用可轻松嵌入Spring Boot应用程序
  • 可以轻松的结合Eureka实现高可用
  • 可以轻松的结合Spring Cloud Bus实现自动化持续集成

Config Client功能(适用于Spring应用程序)

  • 绑定到Config Server并Environment使用远程属性源初始化Spring
  • 加密和解密属性值(对称或非对称)
  • 结合Eureka实现服务发现

二、基础使用

1. 搭建服务端

Step1. 新建Spring Boot项目 configserver

Step2. 引入主要依赖 spring-cloud-config-server

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
</dependency>

Step3. 引入 spring-boot-starter-web

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

Step4. 主程序添加注释 @EnableConfigServer

@SpringBootApplication
@EnableConfigServer
public class ConfigserverApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConfigserverApplication.class, args);
    }
}

Step5. 设置属性

这里使用 .properties 的方式进行配置。你可以自行更换为同等效果的 .yml 方式。配置信息需要放在 bootstrap.properties 中。

1)Git方式存储配置文件示例

#配置文件存放在Git的情况
spring.cloud.config.server.git.uri=http://172.16.50.98:9999/changdaohang/demo_configs.git
spring.cloud.config.label=master
spring.cloud.config.server.git.search-paths=/**
spring.cloud.config.server.git.username=username
spring.cloud.config.server.git.password=password

2)本地存储配置文件

#配置文件存放在本地的情况
#注意:文件夹要有访问权限
spring.profiles.active=native
spring.cloud.config.server.native.search-locations=C:/IdeaProjets/demo_configs/

Step6. 启动

备注

我们可以直接通过restful api 的方式进行访问配置。路由如下:

#映射说明如下
#/{application}/{profile}[/{label}]
#/{application}-{profile}.yml
#/{label}/{application}-{profile}.yml
#/{application}-{profile}.properties
#/{label}/{application}-{profile}.properties

例如:http://localhost:8080/testapp/devhttp://localhost:8080/testapp-dev.properties 对应的配置为 /testapp-dev.properties 当你启动服务端,你可以在Mappings中看到接口开放情况,部分如下:

接口开放情况

2. 业务服务配置

Step1. 新建Spring Boot项目 servera

Step2. 引入主要依赖 spring-cloud-starter-config

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>

Step3. 引入 spring-boot-starter-web

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

Step4. 主程序添加注释 @EnableDiscoveryClient

@SpringBootApplication
@EnableDiscoveryClient
public class ServeraApplication {

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

}

Step5. 创建配置文件

以Git为例: 在git项目中创建servera-dev.properties文件,写入以下示例内容:

name=David

Step6. 配置参数

这里使用 .properties 的方式进行配置。你可以自行更换为同等效果的 .yml 方式。配置信息需要放在 bootstrap.properties 中。

spring.application.name=servera
spring.cloud.config.label=master
spring.cloud.config.profile=dev
spring.cloud.config.uri=http://localhost:8071/

注意:配置中 servera值与 dev 结合对应到 servera-dev.properties文件,并且使用 master 对应到Git中的 master 分支。http://localhost:8080/ 为 配置中心服务地址。

Step7. 新建测试api

新建 TestController 控制器,代码如下:

@RestController
@RequestMapping("api")
@RefreshScope
public class TestController {
   
    @Value("${name}")
    private String confignameValue;

    @GetMapping("/confignamevalue")
    @ResponseBody
    public String returnConfignameValue(){
        return confignameValue;
    }
}

说明:其中 @RefreshScope 注解是以后为了自动更新配置用的。这里可以不加。 通过 @Value("${name}") 注解,可以对应到 servera-dev.properties 中的 name=David 键值对,并将值 David 赋给 confignameValue

Step8. 启动程序

访问 http://localhost:8081/api/confignamevalue 显示结果为:David

到这里最基本的使用就完成了

三、自动更新

这里介绍使用 Monitor + Actuator + Bus + RabbitMQ + GitLab Webhooks 来实现当提交配置后,通知服务更新配置。

请自行搭建 RabbitMQ 服务环境。

1. 配置中心服务端

Step1. 在pom.xml中添加依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-monitor</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>

其中 spring-boot-starter-actuator 整合了一些 /bus-fresh 的接口,可以用于自主触发刷新服务配置。 spring-cloud-config-monitor 用于对接 gitlab 的webhooks,用于触发刷新服务配置。 spring-cloud-starter-bus-amqp用于对接rabbitMQ来广播服务更新事件,通知相关的服务进行配置更新。

Step2.配置参数

bootstrap.properties 中加入以下配置:

#配置消息中心-rabbitmq

spring.rabbitmq.host=192.168.1.119
spring.rabbitmq.port=5672
spring.rabbitmq.username=username
spring.rabbitmq.password=password

#开放actuator下的所有功能api(你也可以选择性开放)
management.endpoints.web.exposure.include=*

2. 配置客户端

Step1. 在pom.xml中添加依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>

其中 spring-boot-starter-actuator 配合服务端,处理服务端关播发来的配置更新事件。也可以用于自主触发刷新服务配置。 spring-cloud-starter-bus-amqp用于接收rabbitMQ消息,通知相关的服务进行配置更新。

Step2.配置参数

bootstrap.properties 中加入以下配置:

#配置消息中心-rabbitmq

spring.rabbitmq.host=192.168.1.119
spring.rabbitmq.port=5672
spring.rabbitmq.username=username
spring.rabbitmq.password=password
#修复BUG-github webhook 只能刷新config server 无法刷新config client的问题
spring.cloud.bus.id=${vcap.application.name:${spring.application.name:application}}:${vcap.application.instance_index:${spring.cloud.config.profile:${local.server.port:${server.port:0}}}}:${vcap.application.instance_id:${random.value}}


#开放actuator下的所有功能api(你也可以选择性开放)
management.endpoints.web.exposure.include=*

Step3. 在控制器中添加 @RefreshScope 注解,用于实时刷新

@RestController
@RequestMapping("api")
@RefreshScope
public class TestController {
	...
}

3. GitLab Webhooks配置

Step1. 打开GitLab项目主页,依次进入【设置】-【集成】

Step2. 添加WebHook.设置调用时机和回调地址:http://192.168.1.28:8080/monitor?path=*

Step3. 保存

path用于定位哪些服务应该更新配置。这里使用 * 来通知所有服务。

4. 测试

Step1. 依次启动 configserverservera

Step2. 访问 http://localhost:8081/api/confignamevalue 显示结果为:David

Step3. 修改gitlab 中的 servera-dev.propertiesname=David Mu 并Commit

Step4. 访问 http://localhost:8081/api/confignamevalue 显示结果为:David Mu

这种方式服务有可能不会立马刷新配置,属于正常情况。

四、高可用

这里介绍使用 Config + Eureka 来实现高可用。

请自行搭建 Eureka 服务环境。

1. 服务端配置

Step1. 引入 spring-cloud-starter-netflix-eureka-client

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

Step2. 配置Eureka相关参数

#设置程序基础配置
server.port=8080
spring.application.name=configserver

#eureka 配置
eureka.instance.hostname=127.0.0.1
eureka.instance.prefer-ip-address=true
eureka.instance.instance-id=${eureka.instance.hostname}:${server.port}
eureka.client.service-url.defaultZone=http://127.0.0.1:8061/eureka/,http://127.0.0.1:8062/eureka/,http://127.0.0.1:8063/eureka/

Step3. 添加注解 @EnableEurekaClient

@SpringBootApplication
@EnableConfigServer
@EnableEurekaClient
public class ConfigserverApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConfigserverApplication.class, args);
    }
}

启动程序,在eureka注册中就可以看到服务已注册。

2. 客户端配置

Step1. 引入 spring-cloud-starter-netflix-eureka-client

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

Step2. 配置Eureka相关参数

#设置程序基础配置
server.port=8080
spring.application.name=configserver

#eureka 配置
eureka.instance.hostname=127.0.0.1
eureka.instance.prefer-ip-address=true
eureka.instance.instance-id=${eureka.instance.hostname}:${server.port}
eureka.client.service-url.defaultZone=http://127.0.0.1:8061/eureka/,http://127.0.0.1:8062/eureka/,http://127.0.0.1:8063/eureka/

Step3. 修改原来的参数,如下:

spring.cloud.config.label=master
spring.cloud.config.profile=dev
#启用服务发现
spring.cloud.config.discovery.enabled=true
#指定配置服务id
spring.cloud.config.discovery.service-id=CONFIGSERVER
#撤销原来的指向方式
#spring.cloud.config.uri=http://localhost:8071/
o
粉丝 0
博文 500
码字总数 0
作品 0
私信 提问
加载中
请先登录后再评论。
CDH5: 使用parcels配置lzo

一、Parcel 部署步骤 1 下载: 首先需要下载 Parcel。下载完成后,Parcel 将驻留在 Cloudera Manager 主机的本地目录中。 2 分配: Parcel 下载后,将分配到群集中的所有主机上并解压缩。 3 激...

cloud-coder
2014/07/01
6.8K
1
数据库代码辅助工具--MaoCaiJun.Database

MaoCaiJun.DataBase 是一个用于 Microsoft Visual Studio 的数据库代码生成组件。它是基于 xml 文件的代码创建工具,支持sql2000,sql2005,sql2008,access, SQLite MaoCaiJun.Database 数据库...

mccj
2013/02/06
2.4K
1
高效 Java Web 开发框架--JessMA

JessMA 是功能完备的高性能 Full-Stack Web 应用开发框架,内置可扩展的 MVC Web 基础架构和 DAO 数据库访问组件(内部已提供了 Hibernate、MyBatis 与 JDBC DAO 组件),集成了 Action 拦截...

伤神小怪兽
2012/11/13
9.2K
3
SAE/CloudFoundry 个人独立博客--Blog4j

Blog4j是一个用Java实现的, 简洁的, 高效的个人独立博客. 没有使用臃肿的SSH流, 但自己构建了一个简洁高效的替代者--Run框架, 使博客运行达到最高性能, 最低耗能! 特点: 文章分类基于标签形式...

xwz
2012/12/14
9.6K
5
创新团队的效率工具--TeamToy

TeamToy是什么? TeamToy是专为创新团队设计的效率工具,它以【事】为核心,带动整个团队进行有价值的交流。在设计上,TeamToy以简捷为目标,更适合于移动设备和触屏。 TeamToy和TODO工具有什...

Easychen
2013/01/05
1.4W
0

没有更多内容

加载失败,请刷新页面

加载更多

jQuery Ajax调用后如何管理重定向请求 - How to manage a redirect request after a jQuery Ajax call

问题: I'm using $.post() to call a servlet using Ajax and then using the resulting HTML fragment to replace a div element in the user's current page. 我使用$.post()使用Ajax调用......

javail
今天
15
0
没有指定分支的“git push”的默认行为 - Default behavior of “git push” without a branch specified

问题: I use the following command to push to my remote branch: 我使用以下命令推送到我的远程分支: git push origin sandbox If I say 如果我说 git push origin does that push ch......

技术盛宴
今天
21
0
为什么在允许某些Unicode字符的注释中执行Java代码?

问题: The following code produces the output "Hello World!" 以下代码生成输出“Hello World!” (no really, try it). (不,真的,试试吧)。 public static void main(String... args......

富含淀粉
今天
18
0
什么是按位移位(位移)运算符以及它们如何工作? - What are bitwise shift (bit-shift) operators and how do they work?

问题: I've been attempting to learn C in my spare time, and other languages (C#, Java, etc.) have the same concept (and often the same operators) ... 我一直在尝试在业余时间学习......

法国红酒甜
今天
32
0
OSChina 周二乱弹 —— 卧槽 李荣浩的契约兽啊

Osc乱弹歌单(2020)请戳(这里) 【今日歌曲】 @薛定谔的兄弟 :分享洛神有语创建的歌单「我喜欢的音乐」: 《红色的回忆》- 痛仰乐队 手机党少年们想听歌,请使劲儿戳(这里) 动弹, 又好多...

小小编辑
今天
92
1

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部