用户使用文档

Nacos Config Spring Boot

概述

Nacos Config Spring Boot 是基于 Nacos Spring 开发的模块，提供了多种配置格式的支持，包括 properties、yaml、json 和 xml。

功能特点

• 支持多种配置格式（properties、yaml、json、xml）
• 支持@ConditionalOnProperty的spring条件注解功能
• 支持配置data-ids的设置方式
• 支持设置远程加载优先级

使用方法

多配置文件支持

如果想要使用spring-boot的条件注解@ConditionXXX功能、@Value注解以及将dubbo的配置放到nacos上等功能，需要使用 nacos-spring-boot-project 的 0.2.2 或 0.1.2 版本。具体使用方法请参考Nacos Spring 多配置文件支持。

配置参数设置

在 application.properties 中设置以下参数：

# 开启配置预加载功能
nacos.config.bootstrap.enable=true
# 主配置服务器地址
nacos.config.server-addr=192.168.16.104:8848
# 主配置 data-id
nacos.config.data-id=people
# 主配置 group-id
nacos.config.group=DEFAULT_GROUP
# 主配置 配置文件类型
nacos.config.type=properties
# 主配置 最大重试次数
nacos.config.max-retry=10
# 主配置 开启自动刷新
nacos.config.auto-refresh=true
# 主配置 重试时间
nacos.config.config-retry-time=2333
# 主配置 配置监听长轮询超时时间
nacos.config.config-long-poll-timeout=46000
# 主配置 开启注册监听器预加载配置服务（除非特殊业务需求，否则不推荐打开该参数）
nacos.config.enable-remote-sync-config=true
# 主配置 remote-first 设置
nacos.config.remote-first=true
# 支持日志级别的加载时机
nacos.config.bootstrap.log.enable=true
# nacos 用户名密码
nacos.config.username=nacos
nacos.config.password=nacos
# 配置文件扩展 index越小，优先级越高，从0开始
nacos.config.ext-config[0].data-id=test
nacos.config.ext-config[0].group=DEFAULT_GROUP
nacos.config.ext-config[0].max-retry=10
nacos.config.ext-config[0].type=yaml
nacos.config.ext-config[0].auto-refresh=true
nacos.config.ext-config[0].config-retry-time=2333
nacos.config.ext-config[0].config-long-poll-timeout=46000
nacos.config.ext-config[0].enable-remote-sync-config=true

示例代码

nacos-config-example

参考配置

• 配置一

  • data-id=people
  • group-id=DEFAULT_GROUP
  • context(properties):

  people.enable=true

• 配置二

  • data-id=apple
  • group-id=DEFAULT_GROUP
  • context(yaml):

  list:
      - 1
      - 2
      - 3
      - 4
  listMap:
      key-1:
          - 1
          - 2
          - 3
          - 4
      key-2:
          - aa
          - dd
          - ee
          - rr

Nacos Discovery Spring Boot

概述

Nacos Discovery Spring Boot 是基于 Nacos 开发的模块，提供了服务自动注册的功能。

功能特点

支持服务自动注册 使用方法 配置参数设置 在 application.properties 中设置以下参数：

nacos.discovery.server-addr=127.0.0.1:8848
nacos.discovery.username=nacos
nacos.discovery.password=nacos
# 是否允许服务自动注册（默认为关闭自动注册）
nacos.discovery.auto-register=true
# 服务对外暴露 ip
nacos.discovery.register.ip=1.1.1.1
# 服务对外暴露 port
nacos.discovery.register.port=1
# 服务权重
nacos.discovery.register.weight=0.6D
# 服务健康信息
nacos.discovery.register.healthy=false
# 服务是否可用
nacos.discovery.register.enabled=true
# 是否为临时实例
nacos.discovery.register.ephemeral=true
# 服务集群名称
nacos.discovery.register.clusterName=SPRINGBOOT
# 服务所属分组
nacos.discovery.register.groupName=BOOT
# 服务名称
nacos.discovery.register.serviceName=SPRING_BOOT_SERVICE

示例代码

nacos-discovery-example