文 | 得少
随着使用 Nacos 的企业用户越来越多,遇到最频繁的两个问题是: 如何在生产环境正确的使用 N amespace 和 Endpoint。 本文将 分享这两个参数配置的最佳实践。
我们从设计背景和最佳实践,来讲讲 Namespace。
Namespace 的设计背景
Namespace 可实现 Nacos 在多环境和多租户下,数据 (配置和服务) 的隔离。即:
从一个租户(用户)的角度来看,如果有多套不同的环境,那么这个时候,可以根据指定的环境来创建不同的 N amespce,以此来实现多环境的隔离。例如,你可能有日常,预发和生产三个不同的环境,那么使用一套 N acos 集群可以分别设置以下三个不同的 N amespace。如下图所示:
从多个租户(用户)的角度来看,每个租户(用户)可能会有自己的 N amespace,每个租户(用户)的配置数据以及注册的服务数据都会归属到自己的 N amespace 下,以此来实现多租户间的数据隔离。例如超级管理员分配了三个租户,分别为张三、李四和王五。分配好了之后,各租户用自己的账户名和密码登录后,创建自己的命名空间。如下图所示。
注意: 该功能还在规划中
关于 N amespace 的最佳实践 ,这部分主要包含有两个 action:
如何来获取 N amespace 的值
N amespace 参数初始化方式
无论是基于 Spring Cloud 还是 Dubbo 来使用 N acos,都会涉及到 N amespace 的参数输入,那么这个时候 N amespace 的值从哪里可以获取呢?
1. 如果在使用过程中没有感知到这个参数的输入,那么 N acos 统一会使用一个默认的 N amespace 作为输入, N acos naming 会使用 public 作为默认的参数来初始化, N acos config 会使用一个 空字符串 作为默认的参数来初始化。
2. 如果需要自定义自己的 N amespace,那么这个值该怎么来产生?
可以在 N acos 的控制台左边功能侧看到有一个命名空间的功能,点击就可以看到新建命名空间的按钮,那么这个时候就可以创建自己的命名空间了。创建成功之后,会生成一个命名空间ID,主要是用来避免命名空间名称有可能会出现重名的情况。因此当您在应用中需要配置指定的 N amespace 时,填入的是命名空间 ID。重要的事情说三遍,
a. 当您在应用中需要配置指定的 N amespace 时, 填入的是命名空间 ID
b. 当您在应用中需要配置指定的 N amespace 时, 填入的是命名空间 ID
c. 当您在应用中需要配置指定的 N amespace 时, 填入的是命名空间 ID
说明: Namesace 为 public 是 Nacos 的一个保留控件,如果您需要创建自己的 Namespace,最好不要和 public 重名,以一个实际业务场景有具体语义的名字来命名,以免带来字面上不容易区分自己是哪一个 Namespace。
N acos client 对 N amespace 的初始化流程如下图所示:
N acos client 对 N amespace 的初始化,主要包含两部分:
用户态通过 N acos client 构造实例时通过 properties 参数传入的 N amespace
在云环境下 (阿里云下的 EDAS) 的 N amespace 参数解析。
可通过 -Duse.cloud.namespace.parsing=true/false 来控制是否需要在云环境自动解析 namespace 参数,默认为 true ,是会自动解析,其目的就是方便用户上云时可以以零成本的方式平滑上云。如果用户在云上需要用自建的 N acos 下的 N amespace,那这个时候只需将 -Duse.cloud.namespace.parsing=false 即可。
关于 Endpoint ,也从其设计背景和参数初始化两个方面来讨论。
Nacos Client 提供一种可以对传入的 E ndpoint 参数规则解析的能力。即当通过构造函数的 properties 来初始化 E ndpoint 时,指定的 E ndpoint 值可以是一个具体的值,也可以是一个占位符的形式,如下所示:
${endpoint.options:defaultValue}。
说明:
endpoint.options 是一个具体的变量。支持从系统属性,系统环境变量中读取。
defaultValue 则是给出的一个默认值。当从具体的变量中没有被正确初始化时,会使用给出的默认值来初始化。
整个 E ndpoint 的解析规则比较复杂,解析流程图如下所示:
注意:
蓝色特别区分的是支持云环境下(阿里云上的 EDAS)自动从系统环境变量中来读取 endpoint 值,以此来达到用户本地开发或者将应用往云上迁移的时候以零成本的改造方式实现平滑上云。
1.1. 如果在初始化 Nacos Client 的时候,没有通过 properties 来指定 endpoint,这个时候会从系统环境变量中变量名为 ALIBABA_ALIWARE_ENDPOINT_URL 指定的值来初始化,如果系统环境变量也没有设置,那么这个时候将会返回一个空字符串。
1.2. 如果设置了 endpoint,
1.2.1. 设置的 endpoint 是一个指定具体的值。
这时会先从系统环境变量中变量名为 ALIBABA_ALIWARE_ENDPOINT_URL 指定的值来 初始化,如果系统环境变量没有设置,那么这个时候用用户态传入的具体值来初始化 endpoint。
1.2.2. 以占位符的形式输入。
这时会解析出具体占位符的值,然后:
依次从系统属性和环境变量中来取值。
例如,您输入的是 ${nacos.endpoint:defaultValue},那么解析出来占位符是
nacos.endpoint。解析出来后,会先读取系统属性中(即
System.getProperty("nacos.endpoint"))是否设置了 nacos.endpoint 变量值,如果没
有,则会从系统环境变量中变量名为 nacos.endpoint 指定的值来初始化。
如果通过解析出来的占位符还没有正确初始化 endpoint,则会从系统环境变量中变量名为 ALIBABA_ALIWARE_ENDPOINT_URL 指定的值来初始化。
如果经过以上两步还没有被初始化,这时如果您设置了默认值,这个时候就会使用默认值来初始化 endpoint,否则的话以解析出来的占位符返回。
2. 关闭 E ndpoint 参数规则解析 当关闭了 E ndpoint 参数规则解析的时候,这个时候就以用户态在构造 Nacos Client 时通过 properties 参数输入的 endpoint 值为主。
默认情况下,Nacos Client 是开启 E ndpoint 参数规则解析的能力。如果你想关闭该能力,可在Nacos Client初始化的时候在传入的properties实例中指定key 为 isUseEndpointParsingRule,值为 false 即可关闭。
本文作者:
彭兵庭:花名得少,GitHub ID @pbting,阿里巴巴高级开发工程师,主要研究方向分布式系统中间件,致力于打造一套通用的分布式系统中间件开发框架,降低分布式系统中间件的开发门槛。Spring Cloud Alibaba 和 Nacos 开源项目 committer。目前在软负载团队参与产品架构升级的相关工作。
/ Nacos Sync 的设计原理和规划 /
第一时间获得下期分享
☟ ☟ ☟
Tips:
# 点下“ 在 看”:heart:
# 然后,公众号对话框内发送“ 搓澡巾 ”,试试手气?:laughing:
# 本期奖品是来自 淘宝心选纯棉麻强力搓澡净一条 。