Spring-cloud 入坑系列之 cloud-config

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

入门介绍:
作为 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 应用程序开发提供集成的框架。

    938 引用 • 1456 回帖 • 163 关注
  • Git

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

    204 引用 • 357 回帖 • 1 关注
  • Java

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

    3165 引用 • 8206 回帖 • 1 关注

相关帖子

欢迎来到这里!

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

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

推荐标签 标签

  • Redis

    Redis 是一个开源的使用 ANSI C 语言编写、支持网络、可基于内存亦可持久化的日志型、Key-Value 数据库,并提供多种语言的 API。从 2010 年 3 月 15 日起,Redis 的开发工作由 VMware 主持。从 2013 年 5 月开始,Redis 的开发由 Pivotal 赞助。

    284 引用 • 247 回帖 • 212 关注
  • Sublime

    Sublime Text 是一款可以用来写代码、写文章的文本编辑器。支持代码高亮、自动完成,还支持通过插件进行扩展。

    10 引用 • 5 回帖 • 2 关注
  • 大数据

    大数据(big data)是指无法在一定时间范围内用常规软件工具进行捕捉、管理和处理的数据集合,是需要新处理模式才能具有更强的决策力、洞察发现力和流程优化能力的海量、高增长率和多样化的信息资产。

    89 引用 • 113 回帖
  • 深度学习

    深度学习(Deep Learning)是机器学习的分支,是一种试图使用包含复杂结构或由多重非线性变换构成的多个处理层对数据进行高层抽象的算法。

    40 引用 • 40 回帖
  • 生活

    生活是指人类生存过程中的各项活动的总和,范畴较广,一般指为幸福的意义而存在。生活实际上是对人生的一种诠释。生活包括人类在社会中与自己息息相关的日常活动和心理影射。

    228 引用 • 1450 回帖
  • flomo

    flomo 是新一代 「卡片笔记」 ,专注在碎片化时代,促进你的记录,帮你积累更多知识资产。

    3 引用 • 74 回帖 • 2 关注
  • 架构

    我们平时所说的“架构”主要是指软件架构,这是有关软件整体结构与组件的抽象描述,用于指导软件系统各个方面的设计。另外还有“业务架构”、“网络架构”、“硬件架构”等细分领域。

    139 引用 • 441 回帖
  • 资讯

    资讯是用户因为及时地获得它并利用它而能够在相对短的时间内给自己带来价值的信息,资讯有时效性和地域性。

    53 引用 • 85 回帖 • 3 关注
  • GitHub

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

    207 引用 • 2031 回帖
  • gRpc
    10 引用 • 8 回帖 • 48 关注
  • 一些有用的避坑指南。

    69 引用 • 93 回帖
  • sts
    2 引用 • 2 回帖 • 142 关注
  • 音乐

    你听到信仰的声音了么?

    58 引用 • 507 回帖 • 1 关注
  • 友情链接

    确认过眼神后的灵魂连接,站在链在!

    24 引用 • 373 回帖 • 7 关注
  • Hprose

    Hprose 是一款先进的轻量级、跨语言、跨平台、无侵入式、高性能动态远程对象调用引擎库。它不仅简单易用,而且功能强大。你无需专门学习,只需看上几眼,就能用它轻松构建分布式应用系统。

    9 引用 • 17 回帖 • 591 关注
  • 安装

    你若安好,便是晴天。

    128 引用 • 1183 回帖
  • Hibernate

    Hibernate 是一个开放源代码的对象关系映射框架,它对 JDBC 进行了非常轻量级的对象封装,使得 Java 程序员可以随心所欲的使用对象编程思维来操纵数据库。

    39 引用 • 103 回帖 • 676 关注
  • Mac

    Mac 是苹果公司自 1984 年起以“Macintosh”开始开发的个人消费型计算机,如:iMac、Mac mini、Macbook Air、Macbook Pro、Macbook、Mac Pro 等计算机。

    164 引用 • 594 回帖 • 1 关注
  • H2

    H2 是一个开源的嵌入式数据库引擎,采用 Java 语言编写,不受平台的限制,同时 H2 提供了一个十分方便的 web 控制台用于操作和管理数据库内容。H2 还提供兼容模式,可以兼容一些主流的数据库,因此采用 H2 作为开发期的数据库非常方便。

    11 引用 • 54 回帖 • 637 关注
  • Docker

    Docker 是一个开源的应用容器引擎,让开发者可以打包他们的应用以及依赖包到一个可移植的容器中,然后发布到任何流行的操作系统上。容器完全使用沙箱机制,几乎没有性能开销,可以很容易地在机器和数据中心中运行。

    475 引用 • 899 回帖 • 1 关注
  • VirtualBox

    VirtualBox 是一款开源虚拟机软件,最早由德国 Innotek 公司开发,由 Sun Microsystems 公司出品的软件,使用 Qt 编写,在 Sun 被 Oracle 收购后正式更名成 Oracle VM VirtualBox。

    10 引用 • 2 回帖 • 1 关注
  • HBase

    HBase 是一个分布式的、面向列的开源数据库,该技术来源于 Fay Chang 所撰写的 Google 论文 “Bigtable:一个结构化数据的分布式存储系统”。就像 Bigtable 利用了 Google 文件系统所提供的分布式数据存储一样,HBase 在 Hadoop 之上提供了类似于 Bigtable 的能力。

    17 引用 • 6 回帖 • 33 关注
  • SendCloud

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

    2 引用 • 8 回帖 • 429 关注
  • Node.js

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

    138 引用 • 268 回帖 • 219 关注
  • Thymeleaf

    Thymeleaf 是一款用于渲染 XML/XHTML/HTML5 内容的模板引擎。类似 Velocity、 FreeMarker 等,它也可以轻易的与 Spring 等 Web 框架进行集成作为 Web 应用的模板引擎。与其它模板引擎相比,Thymeleaf 最大的特点是能够直接在浏览器中打开并正确显示模板页面,而不需要启动整个 Web 应用。

    11 引用 • 19 回帖 • 316 关注
  • 新人

    让我们欢迎这对新人。哦,不好意思说错了,让我们欢迎这位新人!
    新手上路,请谨慎驾驶!

    50 引用 • 225 回帖
  • Spring

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

    938 引用 • 1456 回帖 • 163 关注