ruoyi 微服务 namespace 动态配置微服务config

转载

mob64ca1414098d 2024-05-15 10:07:25

文章标签 spring cloud spring 客户端 git 文章分类 运维

（学习记录）

一、概述

1.来由

微服务意味着要将单体应用中的业务拆分成一个个子服务，每个服务的粒度相对较小，因此系统中会出现大量的服务。由于每个服务都需要必要的配置信息才能运行，所以一套集中式的、动态的配置管理设施是必不可少的。

在分布式的环境下，每个微服务都有对应的application.yml文件，一旦要修改可能要修改很多个，不好管理 config---能够帮助我们统一管理这些文件

官网：Spring Cloud Config

2.简介

SpringCloud Config为微服务架构中的微服务提供集中化的外部配置支持，配置服务器为各个不同微服务应用的所有环境提供了一个中心化的外部配置。

SpringCloud Config分为服务端和客户端两部分：

服务端：服务端也称为分布式配置中心，它是一个独立的微服务应用，用来连接配置服务器并为客户端提供获取配置信息，加密/解密信息等访问接口。

客户端：客户端则是通过指定的配置中心来管理应用资源，以及与业务相关的配置内容，并在启动的时候从配置中心获取和加载配置信息配置服务器默认采用git来存储配置信息，这样就有助于对环境配置进行版本管理，并且可以通过git客户端工具来方便的管理和访问配置内容。
结构图：
白话就是：configServer作为中转中心，我们将公共的配置相关信息放到git上面，客户端拥有自己特有的配置，先来服务端寻找，服务端又找git上面的，这样达到了一对多。git上修改，server端会有，然后每个客户端对应的都会被修改。客户端就不用每个地方的yml都去修改。

3.作用

1.集中管理配置文件
2.不同环境不同配置，动态化的配置更新，分环境部署比如dev/test/prod/beta/release
3.运行期间动态调整配置，不再需要在每个服务部署的机器上编写配置文件，服务会向配置中心统一拉取配置自己的信息
4.当配置发生变动时，服务不需要重启即可感知到配置的变化并应用新的配置
5.将配置信息以REST接口的形式暴露

二、Config服务端配置与测试

1.git上创建仓库模拟

使用GitHub或者码云都可，新建一个名为springcloud-config的新Repository
在仓库里面创建几个文件即可。

2.项目

新建Module模块cloud-config-center-3344，它即为Cloud的配置中心模块
cloudConfig Center

2.1 配置pom.xml

<dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

2.2配置yml

server:
  port: 3344

spring:
  application:
    name:  cloud-config-center #注册进Eureka服务器的微服务名
  cloud:
    config:
      server:
        git:
          uri: git@github.com:zzyybs/springcloud-config.git #GitHub上面的git仓库名字
        ####搜索目录
          search-paths:
            - springcloud-config
      ####读取分支
      label: master

#服务注册到eureka地址
eureka:
  client:
    service-url:
      defaultZone: http://localhost:7001/eureka

2.3主启动

@SpringBootApplication
@EnableConfigServer//开启config服务
public class ConfigCenterMain3344
{
    public static void main(String[] args) {
            SpringApplication.run(ConfigCenterMain3344.class, args);
    }
}

2.4测试

1.启动7001
2.启动微服务3344
3.访问：http://localhost:3344/master/config-dev.yml
结果：GitHub上面仓库里面的内容

2.5配置读取规则

label：分支(branch)
name ：服务名
profiles：环境(dev/test/prod)
/{label}/{application}-{profile}.yml：
http://config-3344.com:3344/master/config-dev.yml
/{application}-{profile}.yml：
http://config-3344.com:3344/config-dev.yml
/{application}/{profile}[/{label}]：
http://config-3344.com:3344/config/dev/master

三、Config客户端配置与测试

新建cloud-config-client-3355
说明：

config分为服务端和客户端这个3344就是服务端，这里对接GitHub，将公共的yml信息写到GitHub上面 client1 client2 client3 | | | | | | | | | configServer ----------------->GitHub 这里看出，客户端1、2、3需要的yml信息是直接找configServer的，然后configSever又通过GitHub获取。 所以客户端要bootstrap.yml---且优先级高于application.yml 要将Client模块下的application.yml文件改为bootstrap.yml,这是很关键的，因为bootstrap.yml是比application.yml先加载的。

bootstrap.yml：Spring Cloud会创建一个“Bootstrap Context”，作为Spring应用的`Application Context`的父上下文。初始化的时候，`Bootstrap Context`负责从外部源加载配置属性并解析配置。这两个上下文共享一个从外部获取的`Environment`。
`Bootstrap`属性有高优先级，默认情况下，它们不会被本地配置覆盖。 `Bootstrap context`和`Application Context`有着不同的约定，所以新增了一个`bootstrap.yml`文件，保证`Bootstrap Context`和`Application Context`配置的分离。

1.配置pom.xml文件

<dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

2.配置bootstrap.yml

server:
  port: 3355

spring:
  application:
    name: config-client
  cloud:
    #Config客户端配置
    config:
      label: master #分支名称
      name: config #配置文件名称
      profile: dev #读取后缀名称   上述3个综合：master分支上config-dev.yml的配置文件被读取http://config-3344.com:3344/master/config-dev.yml
      uri: http://localhost:3344 #配置中心地址k

#服务注册到eureka地址
eureka:
  client:
    service-url:
      defaultZone: http://localhost:7001/eureka

3.主启动

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

4.业务类

@RestController
public class ConfigClientController
{
    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/configInfo")
    public String getConfigInfo() 
    {
        return configInfo;
    }
}

5.测试

1.启动7001
2.启动3344
3.启动3355
访问：http://localhost:3355/configInfo
访问端口为3355的客户端，3355会根据配置文件yml寻找3344，3344又是Server中心，就去git上面寻找，并返回结果。
注意：通过3355寻找3344，会出现动态刷新的问题。
如果Git上面修改内容后，单独访问3344会获取到最新的，但是通过3355访问得不到最新内容。想要访问最新内容就必须重新启动3355服务，麻烦，在实际开发中不应该重新启动服务。所以要解决这个动态刷新问题。

四、Config客户端之动态刷新

避免每次更新配置都要重启客户端微服务3355

1.POM引入actuator监控

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

2.修改YML，暴露监控端口

# 暴露监控端点
management:
  endpoints:
    web:
      exposure:
        include: "*"

3.业务类修改 @RefreshScope注解

@RestController
@RefreshScope
public class ConfigClientController
{
    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/configInfo")
    public String getConfigInfo() {
        return configInfo;
    }
}

4.手动刷新

必须发送post请求：curl -X POST "http://localhost:3355/actuator/refresh"

总结：

解决动态刷新问题：
1.手动版解决：

a.POM引入actuator监控 b.修改YML，暴露监控端口 # 暴露监控端点 management: endpoints: web: exposure: include: "*" c.@RefreshScope业务类Controller修改 d.需要运维人员发送Post请求刷新3355 -----curl -X POST "http://localhost:3355/actuator/refresh"

2.自动版解决：

由于想要自动通知刷新，精确，人为干不了，所以引入了消息总线 Bus

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。