nacos配置管理

  1. 微服务共享的配置可以统一交给Nacos保存和管理，在Nacos控制台修改配置后，Nacos会将配置变更推送给相关的微服务，并且无需重启即可生效，实现配置热更新。在nacos配置列表中添加共享配置：可抽取的共享式配置,jdbc,mybatis-plus,日志配置,swagger和feign的配置，在nacos控制台分别添加这些配置。

    • jdbc相关配置，命名为shared-jdbc.yaml
    spring:
  datasource:
    url: jdbc:mysql://${hm.db.host:192.168.150.101}:${hm.db.port:3306}/${hm.db.database}?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: ${hm.db.un:root}
    password: ${hm.db.pw:123}
mybatis-plus:
  configuration:
    default-enum-type-handler: com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler
  global-config:
    db-config:
      update-strategy: not_null
      id-type: auto
    • 统一的日志配置，命名为shared-log.yaml
    logging:
  level:
    com.hmall: debug
  pattern:
    dateformat: HH:mm:ss:SSS
  file:
    path: "logs/${spring.application.name}"
    • 统一的swagger配置，命名为shared-swagger.yaml
    knife4j:
  enable: true
  openapi:
    title: ${hm.swagger.title:黑马商城接口文档}
    description: ${hm.swagger.description:黑马商城接口文档}
    email: ${hm.swagger.email:zhanghuyi@itcast.cn}
    concat: ${hm.swagger.concat:虎哥}
    url: https://www.itcast.cn
    version: v1.0.0
    group:
      default:
        group-name: default
        api-rule: package
        api-rule-resources:
          - ${hm.swagger.package}

  2. 要在微服务拉取共享配置。将拉取到的共享配置与本地的application.yaml配置合并，完成项目上下文的初始化。有一个问题就是读取Nacos配置是SpringCloud上下文（ApplicationContext）初始化时处理的，发生在项目的引导阶段。然后才会初始化SpringBoot上下文，去读取application.yaml，也就是说引导阶段，application.yaml文件尚未读取，根本不知道nacos 地址，也就无法加载nacos的配置文件。但是，SpringCloud在初始化上下文的时候会先读取一个名bootstrap.yaml(或者bootstrap.properties)的文件，如果我们将nacos地址配置到bootstrap.yaml中，那么在项目引导阶段就可以读取nacos中的配置了。

  3. 微服务整合Nacos配置管理

    • 引入依赖
      <!--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>
    • 在service中新建一个bootstrap.yaml文件
    spring:
  application:
    name: cart-service # 服务名称
  profiles:
    active: dev
  cloud:
    nacos:
      server-addr: 192.168.150.101 # nacos地址
      config:
        file-extension: yaml # 文件后缀名
        shared-configs: # 共享配置
          - dataId: shared-jdbc.yaml # 共享mybatis配置
          - dataId: shared-log.yaml # 共享日志配置
          - dataId: shared-swagger.yaml # 共享日志配置
    • 将某一些配置挪到了bootstrap.yaml，因此application.yaml需要修改
    server:
  port: 8082
feign:
  okhttp:
    enabled: true # 开启OKHttp连接池支持
hm:
  swagger:
    title: 购物车服务接口文档
    package: com.hmall.cart.controller
  db:
    database: hm-cart

  4. 配置热更新

    • 比如说在业务代码中有在运行期间需要根据需要进行变化的值，诶嘛就可以将其配置在配置文件中，方便后期的修改；但修改配置的话，就需要重新打包，重启服务才能生效，所以就要用到nacos的配置热更新能力了。

    • 添加配置到nacos，在nacos中添加一个配置文件，将要配置的值配置到文件中，但是要注意文件的dataId格式：[服务名]-[spring.active.profile].[后缀名]，举例：使用cart-service.yaml这个名称，则不管是dev还是local环境都可以共享该配置。

    hm:
  cart:
    maxAmount: 1 # 购物车商品数量上限
    • 在微服务中读取配置，实现配置热更新。在cart-service中新建一个属性读取类,在业务中需要这个值的地方直接调用加载就行了。
    @Data
@Component
@ConfigurationProperties(prefix = "hm.cart")
public class CartProperties {
    private Integer maxAmount;
}

  5. 动态路由：网关的路由配置全部是在项目启动时由org.springframework.cloud.gateway.route.CompositeRouteDefinitionLocator在项目启动的时候加载，并且一经加载就会缓存到内存中的路由表内（一个Map），不会改变。也不会监听路由变更，所以，我们无法利用上节课学习的配置热更新来实现路由更新。

    • nacos官网中给出了手动监听Nacos配置变更的SDK，在这里如果希望Nacos 推送配置变更，可以使用 Nacos 动态监听配置接口来实现：public void addListener(String dataId, String group, Listener listener)，根据上面的配置，我们需要做的就是- 创建ConfigService，目的是连接到Nacos，之后添加配置监听器，编写配置变更的通知处理逻辑。

    • 由于采用了spring-cloud-starter-alibaba-nacos-config自动装配，因此ConfigService已经在com.alibaba.cloud.nacos.NacosConfigAutoConfiguration中自动创建好了，NacosConfigManager中是负责管理Nacos的ConfigService的，只要我们拿到NacosConfigManager就等于拿到了ConfigService。

    • 编写监听器，虽然官方提供的SDK是ConfigService中的addListener，不过项目第一次启动时不仅仅需要添加监听器，也需要读取配置，因此建议使用的API是这个。

    String getConfigAndSignListener(
    String dataId, // 配置文件id
    String group, // 配置组，走默认
    long timeoutMs, // 读取配置的超时时间
    Listener listener // 监听器
) throws NacosException;

    既可以配置监听器，并且会根据dataId和group读取配置并返回，就可以在项目启动时先更新一次路由，后续随着配置变更通知到监听器，完成路由更新。

    • 更新路由

    更新路由要用到org.springframework.cloud.gateway.route.RouteDefinitionWriter这个接口

    package org.springframework.cloud.gateway.route;

import reactor.core.publisher.Mono;

/**
 * @author Spencer Gibb
 */
public interface RouteDefinitionWriter {
        /**
     * 更新路由到路由表，如果路由id重复，则会覆盖旧的路由
     */
        Mono<Void> save(Mono<RouteDefinition> route);
        /**
     * 根据路由id删除某个路由
     */
        Mono<Void> delete(Mono<String> routeId);

}
    • 保存到Nacos的配置也要符合这个对象结构，将来我们以JSON来保存，格式如下：
    {
 "id": "item",
 "predicates": [{
   "name": "Path",
   "args": {"_genkey_0":"/items/**", "_genkey_1":"/search/**"}
 }],
 "filters": [],
 "uri": "lb://item-service"
}
    • 实现动态路由,网关gateway引入依赖：
    <!--统一配置管理-->
<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>
    • 在网关gateway的resources目录创建bootstrap.yaml文件
    spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: 192.168.150.101
      config:
        file-extension: yaml
        shared-configs:
          - dataId: shared-log.yaml # 共享日志配置
    • 修改gateway的resources目录下的application.yml，把之前的路由移除
    server:
  port: 8080 # 端口
hm:
  jwt:
    location: classpath:hmall.jks # 秘钥地址
    alias: hmall # 秘钥别名
    password: hmall123 # 秘钥文件密码
    tokenTTL: 30m # 登录有效期
  auth:
    excludePaths: # 无需登录校验的路径
      - /search/**
      - /users/login
      - /items/**
    • 在gateway中定义配置监听器
    @Slf4j
@Component
@RequiredArgsConstructor
public class DynamicRouteLoader {

    private final RouteDefinitionWriter writer;
    private final NacosConfigManager nacosConfigManager;

    // 路由配置文件的id和分组
    private final String dataId = "gateway-routes.json";
    private final String group = "DEFAULT_GROUP";
    // 保存更新过的路由id
    private final Set<String> routeIds = new HashSet<>();

    @PostConstruct//它的初始化方法会在spring容器启动时自动执行
    public void initRouteConfigListener() throws NacosException {
        // 1.注册监听器并首次拉取配置
        String configInfo = nacosConfigManager.getConfigService()
                .getConfigAndSignListener(dataId, group, 5000, new Listener() {
                    @Override
                    public Executor getExecutor() {
                        return null;
                    }

                    @Override
                    public void receiveConfigInfo(String configInfo) {
                        updateConfigInfo(configInfo);
                    }
                });
        // 2.首次启动时，更新一次配置
        updateConfigInfo(configInfo);
    }

    private void updateConfigInfo(String configInfo) {
        log.debug("监听到路由配置变更，{}", configInfo);
        // 1.反序列化
        List<RouteDefinition> routeDefinitions = JSONUtil.toList(configInfo, RouteDefinition.class);
        // 2.更新前先清空旧路由
        // 2.1.清除旧路由
        for (String routeId : routeIds) {
            writer.delete(Mono.just(routeId)).subscribe();
        }
        routeIds.clear();
        // 2.2.判断是否有新的路由要更新
        if (CollUtils.isEmpty(routeDefinitions)) {
            // 无新路由配置，直接结束
            return;
        }
        // 3.更新路由
        routeDefinitions.forEach(routeDefinition -> {
            // 3.1.更新路由
            writer.save(Mono.just(routeDefinition)).subscribe();
            // 3.2.记录路由id，方便将来删除
            routeIds.add(routeDefinition.getId());
        });
    }
}
    • 在Nacos控制台添加路由，路由文件名为gateway-routes.json，类型为json
    [
    {
        "id": "item",
        "predicates": [{
            "name": "Path",
            "args": {"_genkey_0":"/items/**", "_genkey_1":"/search/**"}
        }],
        "filters": [],
        "uri": "lb://item-service"
    },...
posted @   Hanyta  阅读(62)  评论(0)  编辑  收藏  举报
相关博文：
· Nacos的配置管理
· Nacos注册中心
· springcloud微服务02-heima2023
· Nacos配置 注册中心和配置中心
· Nacos笔记
阅读排行：
· 分享4款.NET开源、免费、实用的商城系统
· 全程不用写代码，我用AI程序员写了一个飞机大战
· MongoDB 8.0这个新功能碉堡了，比商业数据库还牛
· 白话解读 Dapr 1.15：你的「微服务管家」又秀新绝活了
· 上周热点回顾（2.24-3.2）
点击右上角即可分享
微信分享提示