JavaEE：SpringCloud-使用Config统一管理每个微服务配置文件

無_爲

已于 2022-02-08 10:33:10 修改

阅读量1k

点赞数 1

分类专栏： JavaEE 文章标签： java-ee spring cloud 微服务

于 2020-06-24 08:58:39 首次发布

本文链接：https://blog.csdn.net/a526001650a/article/details/106859762

版权

JavaEE 专栏收录该内容

140 篇文章 5 订阅

订阅专栏

说明：

SpringCloud-Config分为服务端与客户端，Config服务端是一个微服务，供其他每个微服务调用，统一向git仓库获取配置文件。其他每个微服务配置Config客户端，向Config服务端获取配置文件。可以在线改配置，无需重新部署微服务。
SpringCloud-Bus监听配置文件，有改动时通知，实现不重启微服务，让配置生效。

一、导入SpringCloud与SpringBoot依赖包(必须版本对应，此处为2.2.x <-> Hoxton)：

见此文章第一章：JavaEE：SpringCloud-使用Eureka发布微服务_a526001650a的专栏-CSDN博客

二、创建Config服务端(也是个微服务)，从git仓库拉取配置文件：

1.导入Config服务端依赖包、Eureka的Client端依赖包，在工程/pom.xml中：

<dependencies>
    <!-- 导入Eureka的Client端依赖包 -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <!-- 导入Config服务端依赖包 -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-config-server</artifactId>
    </dependency>
</dependencies>

2.Config服务端application.yml中配置Config服务端信息：

server:
  prot: 8080  #配置此Config服务端端口

spring:
  application:
    name: mall-config   #配置此Config服务端服务名称
  cloud:
    config:
      server:
        #overrides:  #属性重载
          #key1: value1
        git:  #存放每个微服务配置文件的git仓库地址
          uri: https://gitee.com/wuwei_yyh/mall-config.git
          #username: yangyh   #git用户名
          #password: 12345678 #git密码
          #search-pats: '{application}'    #配置文件在 git根目录/微服务名目录 下(文件在git根目录时不用配置)，也可以：子目录1, 子目录2
          force-pull: true     #强制拉取配置文件

#需要导入Eureka Server信息，否则无法连接
eureka:
  client:
    service-url: #导入Eureka Server配置的地址
      defaultZone: http://127.0.0.1:10000/eureka/

3.在Application启动类上添加Config服务端注解：

@SpringBootApplication  //标识为启动类
@EnableConfigServer  //配置为Config服务端
@EnableDiscoveryClient  //注册到注册中心
public class ConfigServerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConfigServerApplication.class); //加载启动类
    }
}

三、每个微服务Module中配置Config客户端(用于访问上面的Config服务端拉取git仓库的配置文件)：

说明：此处微服务工程中为mall-usercenter，在git仓库的配置文件为usercenter-dev.yml

1.导入Config客户端依赖包，在工程/pom.xml中：

<dependencies>
    <!-- 导入Config客户端依赖包 -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-config</artifactId>
    </dependency>
</dependencies>

2.resources目录下添加bootstrap.yml(不要创建application.yml)：

spring:
  cloud:
    #stream:
    #  default-binder: rabbit    #同时添加rabbit和kafka依赖包时，必须指定binder默认项，此处指定了rabbit
    config:
      name: usercenter  #git仓库文件"usercenter-dev.yml"-前部分
      profile: dev      #git仓库文件"usercenter-dev.yml"-后部分
      label: master     #git仓库文件所在分支
      #uri: http://127.0.0.1:8080  #方式1：写死Config服务端地址与端口
      discovery:     #方式2：从注册中心动态获取Config服务端地址与端口
        enabled: true  #打开服务发现
        service-id: mall-config   #Config服务端服务名称

eureka:
  client:
    service-url: #导入Eureka Server配置的地址
      defaultZone: http://127.0.0.1:10000/eureka/

3.每个微服务一个配置文件，需要手动上传到git仓库，命名方式：name-dev，此处为usercenter-dev.yml，内容根据实际项目配置(此处随意配的)：

spring:
  application:
    name: mall-usercenter #配置当前微服务名称
  rabbitmq: #配置rabbitmq服务器的地址和端口，rabbitmq服务器需要另外安装
    host: 192.168.3.119
    port: 5672
    #username: yangyh  #登录用户名
    #password: 12345678  #登录密码

server: #配置端口号
  port: 10001

key1: value1 #自定义字段

ykey: ${jkey}    #jkey为java类中的变量名

4.mall-usercenter微服务运行后会将usercenter-dev.yml配置文件下载并应用，可以在浏览器输入地址测试，网页上显示配置文件的信息则表示成功了。

#在浏览器中访问Config服务端地址+mall-usercenter的配置文件名称
http://127.0.0.1:8080/usercenter-dev.yml

四、Bus消息总线监听，实现不重启微服务，让配置生效：

1.Config服务端配置暴露触发消息总线的地址：

(1)导入Bus和Rabbit依赖包：

<dependencies>
     <!-- ...其他Config服务端依赖包见上面章 -->
     <!-- 导入Bus依赖包+Rabbit依赖包 -->
     <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-bus-amqp</artifactId>
     </dependency>
     <!-- 使用kafka时，导入kafka依赖包 -->
     <!--<dependency> -->
     <!--   <groupId>org.springframework.cloud</groupId> -->
     <!--   <artifactId>spring-cloud-starter-bus-kafka</artifactId> -->
     <!--</dependency> -->
    <!-- 导入Actuator监听依赖包，实现了监听消息 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
</dependencies>

(2)Config服务端application.yml中配置rabbitmq服务器和Bus信息：

...
spring:
  ... #其他Config服务端配置见上面章
  rabbitmq: #配置rabbitmq服务器的地址和端口，rabbitmq服务器需要另外安装
    host: 192.168.3.119
    port: 5672
    #username: yangyh  #登录用户名
    #password: 12345678  #登录密码
management: #对客户端暴露发送消息的地址：http://ip:port/actuator/bus-refresh
  security:
    enabled: false  #关闭security
  endpoints:
    web:
      exposure:
        include: bus-refresh  #此值对应上面的发送消息的URL后缀bus-refresh，或使用"*"
  endpoint:
    health:
      show-details: alwas

2.Config客户端(其他每个微服务)配置监听消息：

(1)导入Bus和Rabbit和Actuator监听依赖包：

<dependencies>
    <!-- ...其他Config客户端依赖包见上面章 -->
    <!-- 导入Bus依赖包+Rabbit依赖包 -->
    <dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-starter-bus-amqp</artifactId>
    </dependency>
    <!-- 使用kafka时，导入kafka依赖包 -->
    <!--<dependency> -->
    <!--   <groupId>org.springframework.cloud</groupId> -->
    <!--   <artifactId>spring-cloud-starter-bus-kafka</artifactId> -->
    <!--</dependency> -->
    <!-- 导入Actuator监听依赖包，实现了监听消息 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
</dependencies>

(2)在git仓库的usercenter-dev.yml中配置rabbitmq地址：

spring:
  #...其他Config客户端配置见上面章
  rabbitmq: #配置rabbitmq服务器的地址和端口，rabbitmq服务器需要另外安装
    host: 192.168.3.119
    port: 5672
    #username: yangyh  #登录用户名
    #password: 12345678  #登录密码

(4)默认情况下，只有系统键值对被修改时才能实时生效，想让自定义的键值对修改时也能不重启服务，需要给类加上@RefreshScope注解：

@RefreshScope //此注解能让自定义的键值对修改时也能不重启服务生效
public class UserController {
    @Value("${key1}") //在git仓库-usercenter-dev.yml中自定义的键值对
    private String key1;

    @Value("${ykey}")   //ykey为usercenter-dev.yml文件的key名
    private String jkey;
    ...
}

3.使用Postman请求Config服务端，发送更新通知，mall-usercenter微服务(Config客户端)会自动更新有修改的配置文件：

URL：http://127.0.0.1:8080/actuator/bus-refresh
#可以指定更新节点的URL: http://127.0.0.1:8080/actuator/bus-refresh/{destination}
请求方式：POST

五、给配置文件的值手动加密/自动解密：

1.配置加密/解密key，在Config服务端工程resources目录下创建bootstrap.yml，内容如下：

encrypt:
   key: xxxxxx   #对称加密key

测试效果-获取Config服务端是否配置成功的状态(GET方式)：

http://127.0.0.1:8080/encrypt/status

2.手动加密，使用Postman请求Config服务端加密某个字符串(POST方式)：

URL：http://127.0.0.1:8080/encrypt
数据类型：raw
数据格式：Text
Body内容：未加密的值

可以使用Postman请求Config服务端解密(POST方式)：

URL：http://127.0.0.1:8080/decrypt
数据类型：raw
数据格式：Text
Body内容：已加密的值

3.自动解密，在git仓库修改usercenter-dev.yml，给待解密的值加上{cipher}前缀：

key1: '{cipher}已加密的值'     #Config服务端会对有{cipher}前缀的值进行自动解密

無_爲

关注

1
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
JavaEE：SpringCloud-使用Config统一管理每个微服务配置文件

说明：SpringCloud-Config分为服务端与客户端，Config服务端是一个微服务，供其他每个微服务调用，统一向git仓库获取配置文件。其他每个微服务配置Config客户端，向Config服务端获取配置文件。可以在线改配置，无需重新部署微服务。SpringCloud-Bus监听配置文件，有改动时通知，实现不重启微服务，让配置生效。一、导入SpringCloud与SpringBoot依赖包(必须版本对应，此处为2.2.x <-> Hoxton)：见此文章第一章：二、创建
复制链接

扫一扫