SpringCloud 核心组件Nacos配置热更新&配置共享第5章

Posted 2023-03-31 爱吃豆的土豆

目录

1：配置热更新

1.1：方式一

1.2：方式二

2.配置共享

1）添加一个环境共享配置

2）在configservice中读取共享配置

3）运行两个ConfigApplication，使用不同的profile

4）配置共享的优先级

测试本地application.yml文件

测试：Nacos配置中心的configservice.yaml优先级

测试：Nacos配置中心的服务名-profile.yaml优先级

3：多服务共享配置

方式一：

方式二：

---

1：配置热更新

在SpringCloud 核心组件Nacos【配置管理&配置拉取】第4章

 中已经讲述了在nacos中构建配置文件，服务启动时拉取nacos中的配置，但我们的最终目的，是修改nacos中的配置，使服务不需要重启即可让配置生效，也就是配置的热更新！！！

要实现配置热更新，可以使用两种方式：  

1.1：方式一

在@Value注入的变量所在类上添加注解@RefreshScope

​​

@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController 
    @Value("$czxy.message")
    private String msg;
    
    /**
     * http://localhost:8072/config/get
     */
    @GetMapping("/get")
    public String get() 
        return msg;
    

进行测试：

第一步：看看nacos配置文件中的内容 （爱吃豆的土豆）

​​

 第二步：获取内容

​​

 第三步：修改nacos配置文件中的配置内容为：（Java让人心碎）

​​

 nacos修改文件进行发布：

​​

第四步：不重启服务直接进行请求，看是否得到新的配置内容（Java让人心碎） 

 ​​

1.2：方式二

使用@ConfigurationProperties注解代替@Value注解。

在config-service服务中，添加一个类，读取czxy.message属性：

​​

@Component
@Data
@ConfigurationProperties(prefix = "czxy")
public class PatternProperties 
    private String message;

 @ConfigurationProperties:该注解通过扫描配置配置文件中的配置前缀和属性名保持一致完成内容的注入，这里前缀是czxy，属性名是message，映射到nacos配置文件中的czxy.message

@Data:Lombok注解生成get,set方法

@Component:把这个类注册成spring的一个bean这样一来就可以任意使用这个类了

测试类的代码：

@RestController
@RequestMapping("/config")
//@RefreshScope
public class ConfigController 
    @Resource
    private PatternProperties patternProperties;
//    @Value("$czxy.message")
//    private String msg;

    /**
     * http://localhost:8072/config/get
     */
    @GetMapping("/get")
    public String get() 
        return patternProperties.getMessage();
    

进行测试：

第一步：看看nacos配置文件中的内容 （Java让人心碎）

​​

第二步：查看内容

​​

第三步：修改nacos配置文件中的配置内容为：（快让我涨点粉吧！）

​​

 ​​

第四步：不重启服务直接进行请求，看是否得到新的配置内容（快让我涨点粉吧！） 

​​

总结：两种方式实现配置的热更新，记得加入哪种方式时重启一下服务，使刚加入的热更新方式生效，两种方式：第二种更为广泛！！

2.配置共享

其实微服务启动时，会去nacos读取多个配置文件，例如：

• [spring.application.name]-[spring.profiles.active].yaml，例如：userservice-dev.yaml

• [spring.application.name].yaml，例如：userservice.yaml

而[spring.application.name].yaml不包含环境，因此可以被多个环境共享。

下面我们通过案例来测试配置共享

1）添加一个环境共享配置

我们在nacos中添加一个configservice.yaml文件：

2）在configservice中读取共享配置

在configservice服务中，修改PatternProperties类，读取新添加的属性

 在configservice服务中，修改ConfigController，添加一个方法：

   @GetMapping("/prop")
    public PatternProperties prop() 
        return patternProperties;
    

3）运行两个ConfigApplication，使用不同的profile

修改ConfigApplication2这个启动项，改变其profile值：

这样，ConfigService(8071)使用的profile是test，ConfigService2(8082)使用的profile是dev。

启动ConfigService和ConfigService2

访问http://localhost:8071/config/prop，结果：

访问http://localhost:8072/config/prop，结果： 

可以看出来，不管是dev，还是test环境，都读取到了envSharedValue这个属性的值。  

4）配置共享的优先级

当nacos、服务本地同时出现相同属性时，优先级有高低之分：

测试文件优先级

测试本地application.yml文件

在本地application.yml文件中添加一个变量参数进行测试

server:
  port: 8071
czxy:
   name: 本地环境local

注入配置：

 测试：访问

测试：Nacos配置中心的configservice.yaml优先级

和本地application.yml文件的优先级

 进行重新测试访问：

结果：共享文件将本地的application.yml文件中相同的数据进行覆盖掉了，由此可得出nacos中的共享文件优先级大于本地优先级

测试：Nacos配置中心的服务名-profile.yaml优先级

修改nacos中的环境文件

因为配置了热更新，可直接进行访问

 可以看出nacos中的（服务名-profile.yaml）文件将以上两种文件相同属性内容进行了覆盖！

优先级：

① [ 服务名 ]-[ 环境 ]. yaml >[ 服务名 ]. yaml > 本地配置

 

3：多服务共享配置

不同微服务之间可以共享配置文件，通过下面的两种方式来指定：

方式一：

  server:
    port: 8071
  spring:
    application:
      name: configservice #服务名称
    profiles:
      active: dev #环境
    cloud:
      nacos:
        config:
          server-addr: localhost:8848 #Nacos地址
          file-extension: yaml #文件后缀名
          shared-configs: #多微服务间共享的配置文件
            - data-id: common.yaml  #要共享的配置文件id

方式二：

  server:
    port: 8071
  spring:
    application:
      name: configservice #服务名称
    profiles:
      active: dev #环境
    cloud:
      nacos:
        config:
          server-addr: localhost:8848 #Nacos地址
          file-extension: yaml #文件后缀名
          extension-configs: # 多微服务间共享的配置列表
            - dataId: extend.yaml # 要共享的配置文件id

多种配置的优先级：

 

优先级：

① 环境配置 > 服务名 . yaml > extension-config > extension-configs > shared-configs > 本地配置

SpringCloud 核心组件Nacos配置管理&配置拉取第4章

目录

1，Nacos配置管理

1.1：统一配置管理

1.1.1：为什么需要nacos配置中心 

1.1.2：实现nacos配置中的概念

1.1.3：在nacos中添加配置文件

1.1.4.从微服务拉取配置

1.4.5 nacos 配置文件加载顺序

---

1，Nacos配置管理

Nacos除了可以做注册中心，同样也可以做配置管理来使用

1.1：统一配置管理

1.1.1：为什么需要nacos配置中心 

一，关联服务配置修改麻烦：随着我们的微服务越来越多，我们在生产环境中可能会有数十，上百，上千的服务  ，我现在的一个配置文件需要修改，而这个配置文件可能和数十个服务都有关系这个时候我要这个一个配置文件，就要把有关联的数十个服务的配置都要进行修改

二， 关联服务重启生效麻烦：我修改完配置之后，这些修改的过的服务是不是都应该进行重启，那么在生产环境中重启这么多服务影响还是挺大的，

我们的需求是什么，我们希望这些配置文件能够实现一个统一的管理，比如我现在有十几个服务的配置文件需要修改，我不想每个都去修改去修改，而是在一个地方完成改动，并且我希望修改过的服务不需要重启，修改之后立即生效，实现服务的热更新

1.1.2：实现nacos配置中的概念

处理流程：根据在第二点引出的在一个地方进行统一修改，而要实现它怎么做到呢！我们需要实现一个配置管理服务，这个服务的作用是什么呢？这个服务会记录一些服务的核心配置放置上去，我们的微服务启动的时候，就可以去读取配置管理服务配置，再加上本地服务配置，组成完整配置去使用，将来核心配置如果要发生修改，我们不需要每个服务去修改，而是找到配置管理的服务，这个服务上进行改动，这个配置管理服务非常的智能  ，它发现改动之后它会立即通知微服务，这个时候微服务一看配置改变了，新的配置来了，微服务就赶紧完成读取新的配置，并且后续完成配置的热更新，不需要重启，这一来我们的需求就达到了！

这个配置管理服务我们将用Nacos配置管理来实现，当然我们都知道Nacos是注册中心，这个配置管理就是Nacos的第二大特点，注册找Nacos，配置管理也找Nacos

1.1.3：在nacos中添加配置文件

然后在弹出的表单中，填写配置信息：

注意：项目的核心配置，需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。  

DataID：配置文件的名称，但是这个名称不能像服务中都起application.yml文件名称，为什么呢！将来的所有的微服务都来找Nacos管理，大家都叫这个名字不就冲突了，所以

DataID：必须是唯一，DataID的命名方式一般是这样的，服务名称-环境.后缀名

环境：开发环境dev，测试test，均可，后缀名一般都是YAML

描述：介绍你这个配置管理是干什么的

配置内容：怎么填这个内容呢是不是说把application.yml中的所有配置复制进来就行了

不是这样的，Nacos配置管理将来这些配置是来做热更新的配置，是不是所有的配置都有热更新的配置，那肯定不是像数据库的地址，还有很多配置都不需要变，需要变得都是一些开关类型的配置：比如说我给true按照A方案执行，给false按照B方案执行，比如说服务中的一些活动的开启，我给true就开启给false就不开启了，并不是所有的配置都要进行热更新，要按照需求需要有热更新的配置我们在进行配置Nacos热更新配置

1.1.4.从微服务拉取配置

现在已经把服务的部分配置放置在Nacos配置中心做统一管理，我们的微服务就要想办法把Nacos中的配置得到，该怎么得到呢？

我们先看一下，当我们没有nacos的时候，微服务怎么执行配置文件的，首先项目启动，读取本地的application.yml文件，然后创建spring容器，把各种各样的bean放入，当然后面的步骤还有很多

我们主要关注读取本地配置文件

微服务要拉取nacos中管理的配置，并且与本地的application.yml配置合并，才能完成项目启动。

但如果尚未读取application.yml，又如何得知nacos地址呢？

因此spring引入了一种新的配置文件：bootstrap.yaml文件，会在application.yml之前被读取，流程如下：

bootstrap.yaml文件比application.yml文件优先级高，在项目启动时加载bootstrap文件，获取文件中的nacos中的地址，第二步读取nacos注册中心的配置，第三步读取本地配置文件application.yml，将读取到的配置和nacos配置合并

实际操作：

第一步：1.引入Nacos的配置管理客户端依赖：

<!--nacos配置管理依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>

第二步：2，在configservice中的resource目录添加一个bootstrap.yml文件，这个文件是引导文件，优先级高于application.yml： 

server:
  port: 8072
spring:
  application:
    name: configservice # 服务名称
  profiles:
    active: test #开发环境，这里是test
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地
      config:
        file-extension: yaml # 文件后缀名

这里会根据spring.cloud.nacos.server-addr获取nacos地址，再根据

$spring.application.name-$spring.profiles.active.$spring.cloud.nacos.config.file-extension作为文件id，来读取配置。

本例中，就是去读取userservice-dev.yaml：

 

 第三步，读取nacos配置 ，我们在configservice中将czxy.message这个属性注入到ConfigController中做测试：

结果显示：正常获取到nacos配置中心的内容

将配置交给Nacos管理的步骤

① 在 Nacos 中添加配置文件 ② 在微服务中引入 nacos 的 config 依赖 ③ 在微服务中添加 bootstrap.yml ，配置 nacos 地址、当前环境、服务名称、文件后缀名。这些决定了程序启动时去 nacos 读取哪个文件

1.4.5 nacos 配置文件加载顺序

• spring boot、nacos各种配置文件的加载顺序

  1.bootstrap.yml #引导文件，由spring cloud提供

  2.application.yml #应用程序文件，有spring boot提供

  3.application-[profile].yml #应用程序profile文件，有spring boot提供

  4.[serviceName].yml #nacos配置

  5.[serviceName]-[profile].yml #nacos配置

  • 后面加载的文件，将覆盖前面文件的配置内容