Nacos——配置管理

Waitfor_Me

已于 2025-01-03 09:36:32 修改

阅读量1.2k

点赞数 11

文章标签： java spring cloud

于 2025-01-03 09:36:20 首次发布

本文链接：https://blog.csdn.net/Waitfor_Me/article/details/144893599

版权

Nacos配置管理能为我们解决什么问题？

集中化配置管理
问题：在分布式架构下，众多微服务各自维护配置，修改配置时，运维人员需逐个服务排查、更新，效率低且易出错。
解决：Nacos 提供统一的配置管理平台，把各类配置，如数据库连接参数、限流阈值、日志级别等，集中存储。一次修改，所有关联服务能实时感知，无需逐个重启或重新部署服务。例如，电商系统里多个商品、订单微服务共享数据库配置，在 Nacos 修改数据库连接串后，各服务瞬间应用新配置。
配置动态更新
问题：传统静态配置文件更新后，服务需重启才能加载新配置，这会中断业务，在高可用要求场景下无法接受。
解决：Nacos 支持配置的动态推送，服务运行时能接收最新配置并生效。像营销推广活动期间，要临时调整某个服务的限流规则来应对突发流量，通过 Nacos 修改限流配置，相关服务立即响应，保障业务连贯性。
配置版本管理
问题：配置频繁变更，一旦出现问题，难以回滚到历史可用版本，排查配置变更引发的故障也缺少依据。
解决：Nacos 自带版本控制系统，记录每次配置的修改，清晰呈现修改时间、人员、变动内容。遇到因配置导致的故障，能快速回滚到旧版本，还能复盘配置演进轨迹辅助问题定位。
环境隔离
问题：开发、测试、生产等不同环境的配置差异大，分开管理成本高，还容易混乱。
解决：Nacos 可按不同环境创建独立的配置空间，例如为开发环境配置一套专属的服务端口、测试数据库连接等参数；测试、生产环境同理，各环境配置互不干扰，保障配置的安全性与独立性。
服务发现与配置协同
问题：微服务频繁扩缩容时，新实例如何快速获取正确配置是难题；服务调用关系复杂时，关联服务配置同步更新困难。
解决：结合 Nacos 的服务发现功能，新上线的服务实例能自动从 Nacos 拉取对应的配置，维持运行状态；并且当某个核心服务配置变动，依赖它的周边服务能连锁式同步更新配置，维持系统整体协同。

配置共享

分析：在我们的微服务项目中，不同的微服务模块都有自己的配置，其中就有很多重复的配置，如果出现了配置错误，我们去维护的时候，需要一个一个的检查修改，这样非常的麻烦，所以我们可以把这些重复的配置交给Nacos去管理，如：数据库配置、Mybatis配置、日志配置、knife4j配置等等；我们把这个重复的配置交给Nacos之后，在项目启动的时候我们直接从Nacos拉取对应的配置即可。

步骤：

1.添加共享配置

1.1.首先登录到我们的Nacos控制台：IP地址:8848，如果你的Nacos部署在你的本地的话就是localhost或者127.0.0.1，端口如果没有改变的话默认是8848

1.2.添加我们的共享配置

1.3.在弹出的表单中填写我们要共享的配置

配置内容解析：

${XX.XX.XX:默认值}：这个是一个占位符，我们可以在我们的本地根据需求配置，冒号后面表示的就是如果我们本地没有配置这个值的话，冒号后面的就是这个值的默认值。

注意：Data ID需要带上后缀，要不然获取不到配置

2.拉取共享配置

我们把Nacos上的共享配置拉取到我们的本地，与我们的微服务中的application.yaml合并，完成项目上下文的初始化。

注意：Nacos配置是SpringCloud上下文（ApplicationContext）初始化时处理的，发生在项目的引导阶段。然后才会初始化SpringBoot上下文，去读取application.yaml，所以这里我们要先在bootstrap.yaml或bootstrap.properties中配置Nacos地址完成上下文初始化之后再与application.yaml配置文件进行合并。

微服务整合Nacos配置管理

2.1.导入依赖

  <!--nacos配置管理-->
  <dependency>
      <groupId>com.alibaba.cloud</groupId>
      <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
  </dependency>
  <!--读取bootstrap文件-->
  <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-bootstrap</artifactId>
  </dependency>

2.2.新建bootstrap.yaml并编写内容

如：再一个购物车微服务中实现

spring:
  application:
    name: cart-service # 服务名称
  profiles:
    active: dev #如果配置文件有多环境的话，配置项目的环境，没有可不配
  cloud:
    nacos:
      server-addr: 192.168.181.32:8848 # nacos地址
      config:
        file-extension: yaml # 文件后缀名
        shared-configs: # 共享配置
          - dataId: shared-jdbc.yaml # 共享mybatis配置
          - dataId: shared-log.yaml # 共享日志配置
          - dataId: shared-swagger.yaml # 共享日志配置
          - dataId: shared-seata.yaml # 共享日志配置

2.3修改application.yaml文件

因为我们有些配置放在了bootstrap.yaml中去了

内容如下：

server:
  port: 8082 #微服务启动端口
mysql:
  db:
    database: cart #覆盖Nacos上面的${mysql.db.database}
# ...省略其他配置，根据自己的需求添加即可

根据上述配置完成之后，启动控制台会有这样的一段输出，表示再读取我们Nacos上面的共享配置了

配置热更新

分析：使用配置热更新的原因是，在将来可能会根据实际情况临时调整配置文件内容，例如我们再做购物车的限制商品数量上限，默认是10个，这里就会有个问题，如果因为业务需求变更了，改这个值，我们就需要重新打包、重启服务才能生效，所以Nacos就帮我解决了这个问题。

步骤：

1.在Nacos中添加配置

我们将购物车的购买商品上限添加到配置文件中

注意：dataId的格式是：[服务名]-[profile].[后缀名]

其中的profile指的就是配置文件的环境，比如：dev、test、prod等，如果不加的话就是默认所有环境共享改配置。

2.配置热更新

在要读取步骤1的配置的微服务模块下创建一个属性读取类

3.修改之前配置的死值，为读取步骤2的属性读取类的属性

4. 启动服务，然后修改Nacos配置文件将maxItems的值改成1，并且不重启，尝试增加商品数量

5.把maxItems修改回去不重启测试，正确添加！

动态路由

看图：这是一个gatway网关微服务的application配置文件

分析：如果我们像上图一样这样的配置的话，每当我们的路由发生改变我们都需要重启服务，所以Nacos为我们提供了动态路由的这一个功能，能够实现，在路由发生变化的时候不需要重启服务，Nacos会监听变更并推送更新的路由表给各个服务。

实现

1.导入依赖

<!--统一配置管理-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
<!--加载bootstrap-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>

2.在resources下创建bootstrap.yaml文件，添加如下内容：

spring:
  application:
    name: gateway #微服务名称
  cloud:
    nacos:
      server-addr: 192.168.150.101 #Nacos服务地址
      config:
        file-extension: yaml #配置文件扩展名，当从Nacos获取配置的时候，会优先找.yaml后缀的配置文件
        shared-configs:
          - dataId: shared-log.yaml # 共享日志配置

config可以不配置，根据自己的需求来，我们只需要配置server-addr就行了。

3.修改applicaion.yaml配置文件，将我们之前写在本地的路由移除

4.在Nacos控制台添加路由配置

配置内容格式：

[
  {
  "id": "item", #路由的唯一标识符,用于区分不同的路由规则
  "predicates": [{
    "name": "Path", #表示该路由的匹配条件是基于请求的路径
    "args": {"_genkey_0":"/items/**", "_genkey_1":"/search/**"} #指定了匹配的路径模式，可以配 
  置多个路径，按照顺序用"_genkey_n"来表示，/**表示匹配该Path下的任意级路径
  }],
  "filters": [], # 过滤器
  "uri": "lb://item-service" #路由的目标地址。lb 表示使用负载均衡（Load Balancer）的方式，tem- 
  service 是服务的名称，前提是要该服务注册到了Nacos注册中心
  },
  {...}, #可以配置多个路由
  {...},
]

使用这个格式作为配置文件的原因是，我们更新路由表要需要用到RouteDefinitionWriter接口，所以我们更新的路由也就是RouteDefinition对象，还有就是JSON格式方便我们转换成RouteDefinition对象，有现成的工具类给我们使用，方便，常见的字段：

id：路由id
predicates：路由匹配规则
filters：路由过滤器
uri：路由目的地

5.定义配置监听器

在网关微服务下创建一个routers文件夹，在其下创建一个配置监听器类

内容如下：

package com.hmall.gateway.routers;

import cn.hutool.json.JSONUtil;
import com.alibaba.cloud.nacos.NacosConfigManager;
import com.alibaba.nacos.api.config.listener.Listener;
import com.alibaba.nacos.api.exception.NacosException;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.route.RouteDefinition;
import org.springframework.cloud.gateway.route.RouteDefinitionWriter;
import org.springframework.stereotype.Component;
import reactor.core.publisher.Mono;

import javax.annotation.PostConstruct;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.Executor;

@Slf4j
@Component
@RequiredArgsConstructor
public class DynamicRouteLoader {
    private final NacosConfigManager nacosConfigManager;
    private final RouteDefinitionWriter writer;
    //路由配置文件的Id和分组
    private final String dataId = "gateway-routes.json";
    private final String group = "DEFAULT_GROUP";
    //用于保存更新的路由表Id
    private final Set<String> routerIds = new HashSet<>();

    @PostConstruct//在bean初始化之后执行
    public void initRouteConfigListener() throws NacosException {
        //项目启动的时候，先拉取一次配置，并添加配置监听器
        String configInfo = nacosConfigManager.getConfigService().getConfigAndSignListener(dataId, group, 5000, new Listener() {
            @Override
            public Executor getExecutor() {
                return null;
            }

            @Override
            public void receiveConfigInfo(String configInfo) {
                //监听到路由变更，更新路由表
                updateConfigInfo(configInfo);
            }
        });
        //第一次读取的配置也需要更新到路由表
        updateConfigInfo(configInfo);
    }

    public void updateConfigInfo(String configInfo) {
        //记录路由信息日志
        log.debug("监听到路由信息：{}", configInfo);
        //解析配置信息，转成RouteDefinition
        List<RouteDefinition> definitions = JSONUtil.toList(configInfo, RouteDefinition.class);
        //删除旧的路由
        for (String routerId : routerIds) {
            writer.delete(Mono.just(routerId)).subscribe();
        }
        //删除后清空Set中记录的路由ID
        routerIds.clear();
        //更新路由表
        for (RouteDefinition definition : definitions) {
            writer.save(Mono.just(definition)).subscribe();
            //记录路由ID，便于下次更新路由时，做删除使用
            routerIds.add(definition.getId());
        }
    }
}

6.启动服务测试，在我们添加新的或者修改path路由路径，我们不需要重新启动服务，只需要等待一会在访问即可。