Nacos Java SDK 配置参数

1. Java SDK 读取参数配置

1.1. 介绍

Nacos Java SDK 通过 NacosClientProperties, 一个类似于 Spring Environment用来统一管理客户端的各种配置项。

1.2. 特点

• 统一管理 Properties、命令行参数、环境变量和默认值
• 提供优先级搜索功能, 默认搜索顺序 properties -> 命令行参数 -> 环境参数 -> 默认值, 可通过调整优先级来调整搜索顺序, 默认是 properties 优先
• 配置隔离, 每个 NacosClientProperties 对象,除去全局性的配置互不影响.

1.3. 如何使用

1.3.1. 优先级

默认优先级是 properties, 可通过以下2种方式来调整:

- (命令行参数)-Dnacos.env.first=PROPERTIES|JVM|ENV
- (环境变量)NACOS_ENV_FIRST=PROPERTIES|JVM|ENV

默认情况相当于-Dnacos.env.first=PROPERTIES.

以上2种方式都指定的情况下,客户端优先使用命令行参数的方式获取优先级参数,若是通过命令行参数的方式没有获取到优先级参数则使用环境变量的方式获取优先级参数.如果以上2种方式都未指定优先级参数默认优先级为properties

默认优先级:

优先级: PROPERTIES

优先级: JVM

优先级: ENV

1.3.2. 搜索

NacosClientProperties 会按照指定优先级进行搜索配置, 以默认优先级(PROPERTIES)为例, 如果要获取一个 key 为 key1的值, 查找顺序如下:

NacosClientProperties 会按照上图顺序搜索,直到查询到为止.

1.3.3. 配置隔离

为了应对多注册中心,多配置中心的场景, NacosClientProperties 引入配置隔离的概念. 在 NacosClientProperties 中总共有4个取值源, 分别是: 用户自定义的properties、命令行参数、 环境变量和默认值, 其中 命令行参数、 环境变量和默认值 这3个是全局共享的无法做到隔离, 那么只剩下用户自定义的properties对象是可以进行隔离的, 每个 NacosClientProperties 对象中包含不同的 Properties 对象, 通过这种方法做到配置互不影响.

注意: 全局共享的配置: 命令行参数、 环境参数和默认值 一旦初始化完毕,后续使用无法更改,使用 setProperty 方法,也无法修改. setProperty 只能修改NacosClientProperties 对象中包含的 Properties 对象中的值

1.3.4. 配置派生

在配置隔离的概念之上又引入了配置派生的概念, 其目的是让配置能够继承.所有 NacosClientProperties 对象都是由 NacosClientProperties.PROTOTYPE 对象派生而来. 无法通过其他方式创建 NacosClientProperties 对象

// global properties
NacosClientProperties.PROTOTYPE.setProperty("global-key1","global-value1");

// properties1
NacosClientProperties properties1 = NacosClientProperties.PROTOTYPE.derive();
properties1.

setProperty("properties1-key1","properties1-value1");

// properties2
NacosClientProperties properties2 = properties1.derive();
properties2.

setProperty("properties2-key1","properties2-value1");

以上代码如下图所示:

那么搜索会怎么搜索呢? 以默认优先级(PROPERTIES)为例:

// value == global-value1
String value = properties2.getProperty("global-key1");

1.3.5. API

2. Java SDK 配置参数列表

2.1. 通用参数

通用参数为初始化注册中心NamingService和配置中心ConfigServie时均生效的参数：

2.2. 配置中心相关参数

仅在初始化配置中心ConfigServie时生效：

2.3. 注册中心相关参数

仅在初始化注册中心NamingServie时生效：

2.4. 连接相关

Nacos Java SDK 连接Nacos Server时，可以设置一系列的参数，来提升针对网络抖动时的容错能力，这部分配置暂时**只能通过JVM参数( -D)**进行设置，社区正在进行改造，支持其能够通过NacosClientProperties（即初始化Java SDK时传入的Properties）进行配置，尽请期待。

2.5. 其他参数

Nacos Java SDK 中有部分参数对运行时期的影响较小，且需要全局一致，因此此类参数目前需要通过JVM参数（-D）或环境变量进行设置，一般使用时使用默认值即可，仅在遇到一些特殊场景时才需要设置。