Spring-cloud 入坑系列之 cloud-config

本贴最后更新于 1897 天前,其中的信息可能已经天翻地覆

入门介绍:
作为 Spring-cloud 全家桶下的配置中心,cloud-config 的出现实现了配置文件与项目的解耦;也可以避免环境配置的泄露,一定程度上减轻了运维工作人员的工作量。说到配置中心,最近公司在使用携程开源的 apollo 分布式配置中心,提供了各版本环境配置的可视化管理工具。相信这种独立的配置管理会是以后 Web 开发中的一大趋势。下面介绍一下 Spring-cloud 中的 Spring-cloud-config 组件:
首先来个入门案例,创建一个基本的 Spring-boot 项目,并引入 Spring-cloud-config 依赖:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Greenwich.SR1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

第二步则是在启动类上添加配置注解 @EnableConfigServer,接下来就是配置中心的相关配置;在 application.YAM 的配置如下:

Spring:
	application:
		name: config-server
	cloud:
		config:
			server:
				Git:
					uri: Git@github.com:xxxx/Spring-cloud-config-demo.Git
					# ignore-local-SSH-settings: true
					# private-key: |
					# -----BEGIN RSA PRIVATE KEY-----
					# -----END RSA PRIVATE KEY-----
					# hostKeyAlgorithm: SSH-rsa
					# host-key:
					# strict-host-key-checking: false
					# force-pull: true
					# search-paths: config-test
					# username:
					# password:
server:
	port: 7001

上面标红的配置使用的是 SSH 协议的仓库地址,当然你也可以使用 http 协议地址;使用 http 协议的话可以配置 username 和 password 进行认证;而 SSH 地址则需要配置公钥认证,上图配置中,我只配置了一个 Git 仓库地址,并没有配置公钥,是因为程序会默认使用当前系统用户下的.SSH/的配置,这也为你省去了配置的烦恼。当然你可以改变相应的配置来配合你自身的 Git 仓库。比如我的配置:

Host &quot;xx.xx.xx.xx&quot;
Port 3001
User &quot;Git&quot;
identityfile C:\Users\Win10.SSH\id_rsa
因为我的 Git 仓库是搭建在自己云服务器上的 Git 服务端,而 SSH 端口默认是 22,这会导致一定的网络攻击,所以我把服务器的 SSH 协议的端口改了,因此你本机的配置也需要相应的改变,不然是无法进行 SSH 通信的。
现在说一说如果不使用本机默认的配置,该怎么配置。首先第一步需要把 ignore-local-SSH-settings: true 放开,该配置的启用忽略了本机默认的配置;同时还必须要配置 private-key,不然系统无法认证;private-key 也就是你本机的秘钥,这里需要注意的是 private-key 必须要安照指定的格式,即:| privatekey,前面的“|”不能忽略,private-key 全部拷过来就行。还有一个配置选项是 strict-host-key-checking,该配置是用来检测你本机.SSH/known_hosts 中是否有该仓库主机的记录;如果你没有连接过,请设置为 false。说一下我遇到的问题吧,因为我的 Git 服务是安装在阿里云服务器上;有几次被别人攻击了添加了对外攻击脚本,因此将 SSH 端口修改了其他端口。那么 Git 客户端也需要修改连接的端口,Spring-cloud-config 中的 Git 配置是无法指定端口的;因此只能在 Git 配置 config 文件中指定端口,如上图的 Port:3001。不使用本地配置是无法修改端口的,所以只能使用本地配置。还有一点,阿里云服务器的 SSH 的公钥配置和 Git 服务器的公钥配置不一定是同一个;因此你需要连接 Git 的话你只需要添加公钥到 Git 安装路径下的配置文件即可。以上就是搭建的过程,另外最好禁止 Git 用户使用客户端登录服务器,具体的做法是:
vim /etc/passwd
#git:x:1000:1000::/home/git:/bin/bash    //原来配置
git:x:1000:1000::/home/git:/usr/local/git/bin/git-shell  //后面的路径为git的git-shell路径

这样就可以禁止 Git 用户使用 SSH 登录服务器,当然你还可以结合其他 Git 权限管理的其他工具管理相应的权限。

2.动态刷新:可以将新的配置动态加载到内存中,省去了重启应用的时间
具体实现,首先引入依赖:

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

actuator 模块提供了项目状态监测的功能,其次需要暴露动态更新的接口,在配置中

management.endpoints.web.exposure.include=*      //全部开放
management.endpoints.web.exposure.include=refresh,env    //开放部分接口

现在发送一个 POST 请求/refresh 至配置客户端便可更新配置
3.通过消息总线 +Rabbitmq 提供配置动态更新
加入依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</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-bus-amqp</artifactId>
</dependency>

Rabbitmq 配置:
spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=guest
spring.rabbitmq.password=guest
management.endpoints.web.exposure.include=* //全部开放
management.endpoints.web.exposure.include=refresh,env //开放部分接口

其思想就是利用 Git 的 hook 钩子功能,在 Git 有提交的修改后会触发项目提供的 refresh 接口,rabbitmq 便会收到发送更新配置的通知到其他的配置客户端,便可同步动态更新配置,下面需要配置一下 GitHub 的 webhook 回调接口
![Image.png](https://b3logfile.com/file/2019/09/Image-795c6299.png)
需要注意的是,GitHub 默认会在请求中加上相关提交的载荷:
![Image1.png](https://b3logfile.com/file/2019/09/Image1-d37520a4.png)
如果你没有配置消息转化器去处理,便会如下的错:

{"timestamp":"2019-07-17T03:22:36.859+0000","status":400,"error":"Bad Request","message":"JSON parse error: Cannot deserialize instance of java.lang.String out of START_ARRAY token; nested exception is com.fasterxml.jackson.databind.exc.MismatchedInputException: Cannot deserialize instance of java.lang.String out of START_ARRAY token\n at [Source: (PushbackInputStream); line: 1, column: 304] (through reference chain: java.util.LinkedHashMap["commits"])","path":"/actuator/bus-refresh"}

因此需要处理相应的头部,代码如下:

@WebFilter(filterName = "bodyFilter", urlPatterns = "/*")
@Order(1)
public class RequestFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse response, FilterChain chain) throws IOException, ServletException {
HttpServletRequest httpServletRequest = (HttpServletRequest)servletRequest;
String url = new String(httpServletRequest.getRequestURI());
//只过滤/actuator/bus-refresh 请求
if (!url.endsWith("/bus-refresh")) {
chain.doFilter(servletRequest, response);
return;
}

		//使用HttpServletRequest包装原始请求达到修改post请求中body内容的目的
		CustometRequestWrapper requestWrapper = new CustometRequestWrapper(httpServletRequest);
		chain.doFilter(requestWrapper, response);
	}
	@Override
	public void destroy() {
	}
}
上面是一个过滤器

public class CustometRequestWrapper extends HttpServletRequestWrapper {
public CustometRequestWrapper(HttpServletRequest request) {
super(request);
}
@Override
public ServletInputStream getInputStream() throws IOException {
byte[] bytes = new byte[0];
ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(bytes);
return new ServletInputStream() {
@Override
public boolean isFinished() {
return byteArrayInputStream.read() == -1 ? true:false;
}
@Override
public boolean isReady() {
return false;
}
@Override
public void setReadListener(ReadListener readListener) {}

		@Override
		public int read() throws IOException {
			return byteArrayInputStream.read();
		}
	};
}

}

上面是一个消息处理器
另外需要在启动类加上@ServletComponentScan 注解就行

  • Spring

    Spring 是一个开源框架,是于 2003 年兴起的一个轻量级的 Java 开发框架,由 Rod Johnson 在其著作《Expert One-On-One J2EE Development and Design》中阐述的部分理念和原型衍生而来。它是为了解决企业应用开发的复杂性而创建的。框架的主要优势之一就是其分层架构,分层架构允许使用者选择使用哪一个组件,同时为 JavaEE 应用程序开发提供集成的框架。

    944 引用 • 1459 回帖 • 17 关注
  • Git

    Git 是 Linux Torvalds 为了帮助管理 Linux 内核开发而开发的一个开放源码的版本控制软件。

    209 引用 • 358 回帖
  • Java

    Java 是一种可以撰写跨平台应用软件的面向对象的程序设计语言,是由 Sun Microsystems 公司于 1995 年 5 月推出的。Java 技术具有卓越的通用性、高效性、平台移植性和安全性。

    3187 引用 • 8213 回帖

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...

推荐标签 标签

  • Hadoop

    Hadoop 是由 Apache 基金会所开发的一个分布式系统基础架构。用户可以在不了解分布式底层细节的情况下,开发分布式程序。充分利用集群的威力进行高速运算和存储。

    86 引用 • 122 回帖 • 625 关注
  • Postman

    Postman 是一款简单好用的 HTTP API 调试工具。

    4 引用 • 3 回帖 • 3 关注
  • abitmean

    有点意思就行了

    29 关注
  • Mobi.css

    Mobi.css is a lightweight, flexible CSS framework that focus on mobile.

    1 引用 • 6 回帖 • 733 关注
  • 京东

    京东是中国最大的自营式电商企业,2015 年第一季度在中国自营式 B2C 电商市场的占有率为 56.3%。2014 年 5 月,京东在美国纳斯达克证券交易所正式挂牌上市(股票代码:JD),是中国第一个成功赴美上市的大型综合型电商平台,与腾讯、百度等中国互联网巨头共同跻身全球前十大互联网公司排行榜。

    14 引用 • 102 回帖 • 376 关注
  • GitHub

    GitHub 于 2008 年上线,目前,除了 Git 代码仓库托管及基本的 Web 管理界面以外,还提供了订阅、讨论组、文本渲染、在线文件编辑器、协作图谱(报表)、代码片段分享(Gist)等功能。正因为这些功能所提供的便利,又经过长期的积累,GitHub 的用户活跃度很高,在开源世界里享有深远的声望,并形成了社交化编程文化(Social Coding)。

    209 引用 • 2031 回帖
  • 以太坊

    以太坊(Ethereum)并不是一个机构,而是一款能够在区块链上实现智能合约、开源的底层系统。以太坊是一个平台和一种编程语言 Solidity,使开发人员能够建立和发布下一代去中心化应用。 以太坊可以用来编程、分散、担保和交易任何事物:投票、域名、金融交易所、众筹、公司管理、合同和知识产权等等。

    34 引用 • 367 回帖
  • Markdown

    Markdown 是一种轻量级标记语言,用户可使用纯文本编辑器来排版文档,最终通过 Markdown 引擎将文档转换为所需格式(比如 HTML、PDF 等)。

    167 引用 • 1513 回帖
  • webpack

    webpack 是一个用于前端开发的模块加载器和打包工具,它能把各种资源,例如 JS、CSS(less/sass)、图片等都作为模块来使用和处理。

    41 引用 • 130 回帖 • 261 关注
  • 开源

    Open Source, Open Mind, Open Sight, Open Future!

    408 引用 • 3574 回帖
  • OpenShift

    红帽提供的 PaaS 云,支持多种编程语言,为开发人员提供了更为灵活的框架、存储选择。

    14 引用 • 20 回帖 • 633 关注
  • 百度

    百度(Nasdaq:BIDU)是全球最大的中文搜索引擎、最大的中文网站。2000 年 1 月由李彦宏创立于北京中关村,致力于向人们提供“简单,可依赖”的信息获取方式。“百度”二字源于中国宋朝词人辛弃疾的《青玉案·元夕》词句“众里寻他千百度”,象征着百度对中文信息检索技术的执著追求。

    63 引用 • 785 回帖 • 175 关注
  • Ubuntu

    Ubuntu(友帮拓、优般图、乌班图)是一个以桌面应用为主的 Linux 操作系统,其名称来自非洲南部祖鲁语或豪萨语的“ubuntu”一词,意思是“人性”、“我的存在是因为大家的存在”,是非洲传统的一种价值观,类似华人社会的“仁爱”思想。Ubuntu 的目标在于为一般用户提供一个最新的、同时又相当稳定的主要由自由软件构建而成的操作系统。

    125 引用 • 169 回帖 • 1 关注
  • Vditor

    Vditor 是一款浏览器端的 Markdown 编辑器,支持所见即所得、即时渲染(类似 Typora)和分屏预览模式。它使用 TypeScript 实现,支持原生 JavaScript、Vue、React 和 Angular。

    351 引用 • 1814 回帖
  • Node.js

    Node.js 是一个基于 Chrome JavaScript 运行时建立的平台, 用于方便地搭建响应速度快、易于扩展的网络应用。Node.js 使用事件驱动, 非阻塞 I/O 模型而得以轻量和高效。

    139 引用 • 269 回帖 • 43 关注
  • SendCloud

    SendCloud 由搜狐武汉研发中心孵化的项目,是致力于为开发者提供高质量的触发邮件服务的云端邮件发送平台,为开发者提供便利的 API 接口来调用服务,让邮件准确迅速到达用户收件箱并获得强大的追踪数据。

    2 引用 • 8 回帖 • 483 关注
  • Maven

    Maven 是基于项目对象模型(POM)、通过一小段描述信息来管理项目的构建、报告和文档的软件项目管理工具。

    186 引用 • 318 回帖 • 302 关注
  • CSS

    CSS(Cascading Style Sheet)“层叠样式表”是用于控制网页样式并允许将样式信息与网页内容分离的一种标记性语言。

    198 引用 • 550 回帖
  • NGINX

    NGINX 是一个高性能的 HTTP 和反向代理服务器,也是一个 IMAP/POP3/SMTP 代理服务器。 NGINX 是由 Igor Sysoev 为俄罗斯访问量第二的 Rambler.ru 站点开发的,第一个公开版本 0.1.0 发布于 2004 年 10 月 4 日。

    311 引用 • 546 回帖
  • Solidity

    Solidity 是一种智能合约高级语言,运行在 [以太坊] 虚拟机(EVM)之上。它的语法接近于 JavaScript,是一种面向对象的语言。

    3 引用 • 18 回帖 • 399 关注
  • CodeMirror
    1 引用 • 2 回帖 • 129 关注
  • BND

    BND(Baidu Netdisk Downloader)是一款图形界面的百度网盘不限速下载器,支持 Windows、Linux 和 Mac,详细介绍请看这里

    107 引用 • 1281 回帖 • 27 关注
  • GraphQL

    GraphQL 是一个用于 API 的查询语言,是一个使用基于类型系统来执行查询的服务端运行时(类型系统由你的数据定义)。GraphQL 并没有和任何特定数据库或者存储引擎绑定,而是依靠你现有的代码和数据支撑。

    4 引用 • 3 回帖 • 9 关注
  • 设计模式

    设计模式(Design pattern)代表了最佳的实践,通常被有经验的面向对象的软件开发人员所采用。设计模式是软件开发人员在软件开发过程中面临的一般问题的解决方案。这些解决方案是众多软件开发人员经过相当长的一段时间的试验和错误总结出来的。

    200 引用 • 120 回帖
  • Love2D

    Love2D 是一个开源的, 跨平台的 2D 游戏引擎。使用纯 Lua 脚本来进行游戏开发。目前支持的平台有 Windows, Mac OS X, Linux, Android 和 iOS。

    14 引用 • 53 回帖 • 531 关注
  • CloudFoundry

    Cloud Foundry 是 VMware 推出的业界第一个开源 PaaS 云平台,它支持多种框架、语言、运行时环境、云平台及应用服务,使开发人员能够在几秒钟内进行应用程序的部署和扩展,无需担心任何基础架构的问题。

    5 引用 • 18 回帖 • 167 关注
  • ZeroNet

    ZeroNet 是一个基于比特币加密技术和 BT 网络技术的去中心化的、开放开源的网络和交流系统。

    1 引用 • 21 回帖 • 638 关注