查看: 1674|回复: 0

[Java代码] Spring Cloud Config实现分布式配置中心

发表于 2018-5-4 08:00:02

在分布式系统中,配置文件散落在每个项目中,难于集中管理,抑或修改了配置需要重启才能生效。下面我们使用 Spring Cloud Config 来解决这个痛点。

Config Server

我们把 config-server 作为 Config Server,只需要加入依赖:

  1. <dependency>
  2. <groupId>org.springframework.cloud</groupId>
  3. <artifactId>spring-cloud-config-server</artifactId>
  4. </dependency>
复制代码

在 application.yml 中,进行配置:

  1. spring:
  2. application:
  3. name: config-server # 名称
  4. cloud:
  5. config:
  6. server:
  7. git:
  8. uri: file://Users/yangdd/Documents/code/GitHub/config-repo # 使用本地仓库(用于测试),格式为:file://${user.home}/config-repo 如果是 Windows 则是 file:///${user.home}/config-repo
  9. #uri: https://github.com/yangdd1205/spring-cloud-master/
  10. #username: 用户名
  11. #password: 密码
  12. #default-label: config # 可以是 commit id,branch name, tag name,默认值为 master
  13. #search-paths: # 表示除了在根目录搜索配置文件,还可以在以下目录搜索
  14. #- user
  15. server:
  16. port: 4001 # 端口
复制代码

Spring 的项目,一般有个“约定大于配置”的原则。所以我们 Git 中的配置文件,一般以 {application}-{profile}.yml 或者 {application}-{profile}.properties 命名。

  1. {appliction} 映射到客户端 spring.application.name 属性值
  2. {profile} 映射到客户端 spring.profiles.active 属性值

我们在 config-repo 的 master 分支中,有两个文件 client-dev.yml :

  1. info: master-dev
复制代码

client-prod.yml :

  1. info: master-prod
复制代码

在 config 分支中,有两个文文件 client-dev.yml :

  1. info: config-dev
复制代码

client-prod.yml :

  1. info: config-prod
复制代码

启动 config-server 我们可以通过下面的映射关系来访问 Git 中的配置文件:

  1. /{application}/{profile}[/{label}]
  2. /{application}-{profile}.yml
  3. /{label}/{application}-{profile}.yml
  4. /{application}-{profile}.properties
  5. /{label}/{application}-{profile}.properties
复制代码

http://localhost:4001/client-dev.yml

Config Client

我们把 config-client 作为 Config Client,加入依赖:

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-web</artifactId>
  4. <dependency>
  5. <groupId>org.springframework.cloud</groupId>
  6. <artifactId>spring-cloud-starter-config</artifactId>
  7. </dependency>
复制代码

在 bootstrap.yml 中配置( bootstrap.yml 会先于 application.yml 加载):

  1. spring:
  2. application:
  3. name: client
  4. cloud:
  5. config:
  6. uri: http://localhost:4001/ ##表示配置中心的地址
  7. profile: dev # 等同于 spring.profiles.active 属性,但是优先级高于 spring.profiles.active
  8. #label: config # 如果不指定使用 server 中的 label,如果指定了则以 client 的为准
  9. server:
  10. port: 4002 # 端口
复制代码

在 config-client 创建 TestController :

  1. @RestController
  2. public class TestController {
  3. @Value("${info}")
  4. private String info;
  5. @RequestMapping(value = "/getInfo")
  6. public String getInfo() {
  7. return this.info;
  8. }
  9. }
复制代码

访问 http://localhost:4002/getInfo

修改 config-client 配置文件的中 profile 为 prod 再访问,查看结果。

现在我们已经实现了,配置文件统一管理,但是修改配置文件后,如何不重启生效呢?

我们在 config-client 中引入依赖:

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-actuator</artifactId>
  4. </dependency>
复制代码

在需要动态刷新的类上加上注解 @RefreshScope ,这里我们在 TestController 加上。并在配置文件中把 actuator 的权限认证禁用:

  1. management:
  2. security:
  3. enabled: false
复制代码

重启项目, http://localhost:4002/getInfo 结果为: config-dev ,现在修改 config-dev.yml 文件:

  1. info: config-dev-1.0
复制代码

调用 actuator 的方法,手动刷新, http://localhost:4002/refresh 注意:必须是 POST 方式。 可以看到发生改变了的值有哪些:

  1. [
  2. "info"
  3. ]
复制代码

再访问 http://localhost:4002/getInfo 结果为: config-dev-1.0 。

我们发现现在虽然可以动态刷新配置了,但是每次都要手动调用刷新方法,假如我有 1000 个服务,那就要调用 1000 次,有没有更好的办法呢?那就是结合 Spring Cloud Bus 使用。

高可用

现在我们的 Config Server 是一个单点的服务,一旦挂掉后面的 Config Client 将无法使用。所以在生成中,Config Server 必须是高可用的,那怎么做呢?很简单,跟我们前面讲的 Eureka 的高可用一样,只需要将同一个 Config Server 多部署几个即可。

我们将项目 eureka 作为注册中心,端口为:7001。

复制 config-server 改为 config-server-1 ,端口为:4003,将两个 Config Server 都注册到注册中心。

将 config-client 也注册到注册中心,并指定从 Eureka 中获取 Config Server:

  1. spring:
  2. cloud:
  3. config:
  4. #uri: http://localhost:4001/ ##表示配置中心的地址,直接指定 Config Server 地址
  5. profile: dev
  6. #label: config
  7. discovery:
  8. enabled: true # 启用从服务中获取 Config Server
  9. service-id: config-server # Config Server 的服务名
复制代码

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持程序员之家。



回复

使用道具 举报