Spring Cloud Alibaba全家桶——微服务组件Nacos配置中心

Posted 2023-03-10 小新要变强

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Spring Cloud Alibaba全家桶——微服务组件Nacos配置中心相关的知识，希望对你有一定的参考价值。

前言

本文小新为大家带来 微服务组件Nacos配置中心 相关知识，具体内容包括Nacos Config快速开始指引，搭建nacos-config服务，Config相关配置，配置的优先级，@RefreshScope注解等进行详尽介绍~

不积跬步，无以至千里；不积小流，无以成江海。每天进步一点点，在成为强者的路上，小新与大家共同成长！

📌博主主页：小新要变强的主页
👉Java全栈学习路线可参考：【Java全栈学习路线】最全的Java学习路线及知识清单，Java自学方向指引，内含最全Java全栈学习技术清单~
👉算法刷题路线可参考：算法刷题路线总结与相关资料分享，内含最详尽的算法刷题路线指南及相关资料分享~
👉Java微服务开源项目可参考：企业级Java微服务开源项目（开源框架，用于学习、毕设、公司项目、私活等，减少开发工作，让您只关注业务！）

↩️本文上接：Spring Cloud Alibaba全家桶（四）——微服务调用组件Feign

springcloud config大部分场景结合git 使用, 动态变更还需要依赖Spring Cloud Bus消息总线来通过所有的客户端变化；
springcloud config不提供可视化界面；
nacos config使用长轮询更新配置, 一旦配置有变动后，通知Provider的过程非常的迅速, 从速度上秒杀springcloud原来的config几条街。

一、Nacos Config快速开始

🍀（1）准备配置，nacos server中新建nacosconfig.properties

最佳实践：

Namespace：代表不同环境，如开发、测试、生产环境。
Group：代表某项目，如XX医疗项目、XX电商项目
DataId：每个项目下往往有若干个工程（微服务），每个配置集(DataId)是一个工程（微服务）的主配置文件

🍀（2）启动权限：修改application.properties

二、搭建nacos-config服务

通过 Nacos Server 和 spring-cloud-starter-alibaba-nacos-config 实现配置的动态变更。

🍀（1）引入依赖

1	<dependency>
2	<groupId>com.alibaba.cloud</groupId>
3	<artifactId>spring‐cloud‐starter‐alibaba‐nacos‐config</artifactId>
4	</dependency>

🍀（2）添加bootstrap.properties

1	spring.application.name=nacos‐config
2	# 配置中心地址
3	spring.cloud.nacos.config.server‐addr=127.0.0.1:8848
4
5	# dataid 为 yaml 的文件扩展名配置方式
6	# `$spring.application.name.$file‐extension:properties`
7   spring.cloud.nacos.config.file‐extension=yaml
8   #profile粒度的配置 `$spring.application.name‐$profile.$file‐extension:properties` 9 spring.profiles.active=prod

🍀（3）启动服务，测试微服务是否使用配置中心的配置

@SpringBootApplication
public class NacosConfigApplication 

  public static void main(String[] args) 
    ConfigurableApplicationContext applicationContext = SpringApplication.run(NacosConfigApplication.class, args); 
    String userName = applicationContext.getEnvironment().getProperty("common.name");
    String userAge = applicationContext.getEnvironment().getProperty("common.age"); 
    System.out.println("common name :"+userName+"; age: "+userAge);

三、Config相关配置

Nacos 数据模型 Key 由三元组唯一确定, Namespace默认是空串，公共命名空间（public），分组默认是 DEFAULT_GROUP

🍀（1）支持配置的动态更新

@SpringBootApplication
public class NacosConfigApplication 

  public static void main(String[] args) throws InterruptedException 
    ConfigurableApplicationContext applicationContext = SpringApplication.run(NacosConfigApplication.class, args);

    while(true) 
      //当动态配置刷新时，会更新到 Enviroment中，因此这里每隔一秒中从Enviroment中获取配置
      String userName = applicationContext.getEnvironment().getProperty("common.name");
      String userAge = applicationContext.getEnvironment().getProperty("common.age");
      System.err.println("common name :" + userName + "; age: " + userAge); 
      TimeUnit.SECONDS.sleep(1);

ps：除了默认的配置文件，其他dataId都要加上后缀

🍀（2）支持profile粒度的配置

springcloudstarteralibabanacosconfig 在加载配置的时候，不仅仅加载了以 dataid 为
$spring.application.name.$file-extension:properties 为前缀的基础配置，还加载了dataid为
$spring.application.name-$profile.$file-extension:properties 的基础配置。在日常开发中如果遇到多套环境下的不同配置，可以通过Spring 提供的 $spring.profiles.active 这个配置项来配置。

spring.profiles.active=dev

profile 的配置文件大于默认配置的文件，并且形成互补。

ps：只有默认的配置文件，才会应用profile。

🍀（3）支持自定义 namespace 的配置

用于进行租户粒度的配置隔离。不同的命名空间下，可以存在相同的 Group 或 Data ID 的配置。Namespace 的常用场景之一是不同环境的配置的区分隔离，例如开发测试环境和生产环境的资源（如配置、服务）隔离等。

在没有明确指定 $spring.cloud.nacos.config.namespace 配置的情况下，默认使用的是 Nacos 上 Public 这个 namespace。如果需要使用自定义的命名空间，可以通过以下配置来实现：

spring.cloud.nacos.config.namespace=71bb9785‐231f‐4eca‐b4dc‐6be446e12ff8

🍀（4）支持自定义 Group 的配置

Group是组织配置的维度之一。通过一个有意义的字符串（如 Buy 或 Trade ）对配置集进行分组，从而区分 Data ID 相同的配置集。当您在 Nacos 上创建一个配置时，如果未填写配置分组的名称，则配置分组的名称默认采用 DEFAULT_GROUP 。配置分组的常见场景：不同的应用或组件使用了相同的配置类型，如 database_url 配置和 MQ_topic 配置。在没有明确指定 $spring.cloud.nacos.config.group 配置的情况下，默认是DEFAULT_GROUP 。如果需要自定义自己的 Group，可以通过以下配置来实现：

spring.cloud.nacos.config.group=DEVELOP_GROUP

🍀（5）支持自定义扩展的 Data Id 配置

Data ID 是组织划分配置的维度之一。Data ID 通常用于组织划分系统的配置集。一个系统或者应用可以包含多个配置集，每个配置集都可以被一个有意义的名称标识。Data ID 通常采用类 Java 包（如 com.taobao.tc.refund.log.level）的命名规则保证全局唯一性。此命名规则非强制。通过自定义扩展的 Data Id 配置，既可以解决多个应用间配置共享的问题，又可以支持一个应用有多个配置文件。

# 自定义 Data Id 的配置
# 不同工程的通用配置 支持共享的 DataId
spring.cloud.nacos.config.sharedConfigs[0].data‐id= common.yaml  
spring.cloud.nacos.config.sharedConfigs[0].group=REFRESH_GROUP  
spring.cloud.nacos.config.sharedConfigs[0].refresh=true

# config external configuration
# 支持一个应用多个 DataId 的配置 一定要加扩展名
spring.cloud.nacos.config.extensionConfigs[0].data‐id=ext‐config‐common01.properties 
spring.cloud.nacos.config.extensionConfigs[0].group=REFRESH_GROUP 
spring.cloud.nacos.config.extensionConfigs[0].refresh=true

spring.cloud.nacos.config.extensionConfigs[1].data‐id=ext‐config‐common02.properties 
spring.cloud.nacos.config.extensionConfigs[1].group=REFRESH_GROUP 
spring.cloud.nacos.config.extensionConfigs[1].refresh=true

四、配置的优先级

Spring Cloud Alibaba Nacos Config 目前提供了三种配置能力从 Nacos 拉取相关的配置：

A: 通过 spring.cloud.nacos.config.shared-configs 支持多个共享 Data Id 的配置
B: 通过 spring.cloud.nacos.config.ext-config[n].data-id 的方式支持多个扩展 Data Id 的配置
C: 通过内部相关规则(应用名、应用名+ Profile )自动生成相关的 Data Id 配置当三种方式共同使用时，他们的一个优先级关系是:A < B < C 优先级从高到低：
- 1. nacosconfigproduct.yaml 精准配置
- 1. nacosconfig.yaml 同工程不同环境的通用配置
- 1. extconfig: 不同工程扩展配置
- 1. shareddataids 不同工程通用配置

五、@RefreshScope

@Value注解可以获取到配置中心的值，但是无法动态感知修改后的值，需要利用@RefreshScope注解。

@RestController
@RefreshScope
public class TestController
  @Value("$common.age")
  private String age;
  @GetMapping("/common")
  public String hello() 
    return age;