Nacos深度剖析：配置及高可用方案全攻略

第1章Nacos服务端配置参数

对于Server端来说，一般是设置在{nacos.home}/conf/application.properties里，如果参数名后标注了(-D)的，则表示是 JVM 的参数，需要在{nacos.home}/bin/startup.sh里进行相应的设置。例如像设置 nacos.home 的值，可以在{nacos.home}/bin/startup.sh进行如下设置。

1.1全局参数

参数名	含义	可选值	默认值	支持版本
nacos.home(-D)	Nacos的根目录	目录路径	Nacos安装的目录	>= 0.1.0
nacos.standalone(-D)	是否在单机模式	true/false	false	>= 0.1.0
nacos.functionMode(-D)	启动模式，支持只启动某一个模块，不设置时所有模块都会启动	config/naming/空	空	>= 0.9.0
nacos.inetutils.prefer-hostname-over-ip	cluster.conf里是否应该填hostname	true/false	false	>= 0.3.0
nacos.inetutils.ip-address	本机IP，该参数设置后，将会使用这个IP去cluster.conf里进行匹配，请确保这个IP的值在cluster.conf里是存在的	本机IP	null	>= 0.3.0

1.2 Naming模块参数

参数名	含义	可选值	默认值	支持版本
nacos.naming.data.warmup	是否在Server启动时进行数据预热	true/false	false	>= 1.0.2
nacos.naming.expireInstance	是否自动摘除临时实例	true/false	true	>= 1.0.2
nacos.naming.distro.taskDispatchPeriod	同步任务生成的周期，单位为毫秒	正整数	2000	>= 1.0.2
nacos.naming.distro.batchSyncKeyCount	同步任务每批的key的数目	正整数	1000	>= 1.0.2
nacos.naming.distro.syncRetryDelay	同步任务失败的重试间隔，单位为毫秒	正整数	5000	>= 1.0.2

除了上面列到的在application.properties里配置的属性，还有一些可以在运行时调用接口来进行调节，这些参数都在OPenAPI里的查看系统当前数据指标这个API里有声明。

1.3 Config模块参数

参数名	含义	可选值	默认值	支持版本
db.num	数据库数目	正整数	0	>= 0.1.0
db.url.0	第一个数据库的URL	字符串	空	>= 0.1.0
db.url.1	第二个数据库的URL	字符串	空	>= 0.1.0
db.user	数据库连接的用户名	字符串	空	>= 0.1.0
db.password	数据库连接的密码	字符串	空	>= 0.1.0
spring.datasource.platform	数据库类型	字符串	mysql	>=1.3.0
db.pool.config.xxx	数据库连接池参数，使用的是hikari连接池，参数与hikari连接池相同，如	db.pool.config. connectionTimeout或db.pool.config. maximumPoolSize 字符串	同hikariCp对应默认配置	>=1

当前数据库配置支持多数据源。通过db.num来指定数据源个数，db.url.index为对应的数据库的链接。db.user以及db.password没有设置index时,所有的链接都以db.user和db.password用作认证。如果不同数据源的用户名称或者用户密码不一样时，可以通过符号,来进行切割，或者指定db.user.index,db.user.password来设置对应数据库链接的用户或者密码。需要注意的是，当db.user和db.password没有指定下标时，因为当前机制会根据,进行切割。所以当用户名或者密码存在,时，会把,切割后前面的值当成最后的值进行认证，会导致认证失败。
Nacos从1.3版本开始使用HikariCP连接池，但在1.4.1版本前，连接池配置由系统默认值定义，无法自定义配置。在1.4.1后，提供了一个方法能够配置HikariCP连接池。 db.pool.config为配置前缀，xxx为实际的hikariCP配置，如db.pool.config.connectionTimeout或db.pool.config.maximumPoolSize等。更多hikariCP的配置请查看HikariCP 需要注意的是，url,user,password会由db.url.n,db.user,db.password覆盖，driverClassName则是默认的MySQL8 driver（该版本mysql driver支持mysql5.x)

1.4 CMDB模块参数

参数名	含义	可选值	默认值	支持版本
nacos.cmdb.loadDataAtStart	是否打开CMDB	true/false	false	>= 0.7.0
nacos.cmdb.dumpTaskInterval	全量dump的间隔，单位为秒	正整数	3600	>= 0.7.0
nacos.cmdb.eventTaskInterval	变更事件的拉取间隔，单位为秒	正整数	10	>= 0.7.0
nacos.cmdb.labelTaskInterval	标签集合的拉取间隔，单位为秒	正整数	300	>= 0.7.0

第2章Nacos Client配置参数

客户端的参数分为两种，一种是通过-D参数进行指定的配置，一种是构造客户端时，通过Properties对象指定的配置，以下没有带-D标注的都是通过Properties注入的配置。

2.1 通用参数

参数名	含义	可选值	默认值	支持版本
endpoint	连接Nacos Server指定的连接点，可以参考文档	域名	空	>= 0.1.0
endpointPort	连接Nacos Server指定的连接点端口，可以参考文档	合法端口号	空	>= 0.1.0
namespace	命名空间的ID	命名空间的ID	config模块为空，naming模块为public	>= 0.8.0
serverAddr Nacos	Server的地址列表，这个值的优先级比endpoint高	ip:port,ip:port,…	空	>= 0.1.0
JM.LOG.PATH(-D)	客户端日志的目录	目录路径	用户根目录	>= 0.1.0

2.2Naming客户端

参数名	含义	可选值	默认值	支持版本
namingLoadCacheAtStart	启动时是否优先 读取本地缓存	true/false	false	>= 1.0.0
namingCacheRegistryDir	指定缓存子目录，位置为 …/nacos/{SUB_DIR}/naming	子目录路径	空字符串	>=2.0.2
namingClientBeatThreadCount	客户端心跳的线程池大小	正整数	机器的CPU数的一半	>= 1.0.0
namingPollingThreadCount	客户端定时轮询数据 更新的线程池大小	正整数	机器的CPU数的一半	>= 1.0.0
com.alibaba.nacos.naming.cache.dir(-D)	客户端缓存目录	目录路径	{user.home}/nacos/naming	>= 1.0.0
com.alibaba.nacos.naming.log.level(-D)	Naming客户端的日志级别	info,error,warn等	info	>= 1.0.0
com.alibaba.nacos.client.naming.tls.enable(-D)	是否打开HTTPS	true/false	false	>= 1.0.0

2.3 Config客户端

参数名	含义	可选值	默认值	支持版本
configLongPollTimeout (config.long-poll.timeout 1.0.1版本)	长轮询的超时时间，单位为毫秒	正整数	30000	>= 1.0.2
configRetryTime (config.retry.time 1.0.1版本)	长轮询任务重试时间,单位为毫秒	正整数	2000	>= 1.0.2
maxRetry	长轮询的重试次数	正整数	3	>= 1.0.2
enableRemoteSyncConfig	监听器首次添加时拉取远端配置	布尔值	false	>= 1.0.2
com.alibaba.nacos.config.log.level (-D)	Config客户端的日志级别	info,error,warn等	info	>= 1.0.0
JM.SNAPSHOT.PATH(-D)	客户端缓存目录	目录路径	{user.home}/nacos/config	>= 1.0.0

第3章Nacos单机与集群

3.1 Nacos端口介绍

在部署 Nacos 集群前,熟悉各个端口的作用也是非常必要的。下表是Nacos主要端口情况：

端口	与主端口的偏移量	描述
8848	0	主端口，客户端、控制台及OpenAPI所使用的HTTP端口
9848	1000	客户端gRPC请求服务端端口，用于客户端向服务端发起连接和请求
9849	1001	服务端gRPC请求服务端端口，用于服务间同步等
7848	-1000	Jraft请求服务端端口，用于处理服务端间的Raft相关请求

使用VIP/nginx请求时，需要配置成TCP转发，不能配置http2转发，否则连接会被nginx断开。 9849和7848端口为服务端之间的通信端口，请勿暴露到外部网络环境和客户端测。

3.2 容器常用属性配置

属性名称 描述 选项
MODE 系统启动方式: 集群/单机 cluster/standalone默认 cluster
NACOS_SERVERS 集群地址 p1:port1空格ip2:port2 空格ip3:port3
PREFER_HOST_MODE 支持IP还是域名模式 hostname/ip 默认 ip
NACOS_SERVER_PORT Nacos 运行端口 默认 8848
NACOS_SERVER_IP 多网卡模式下可以指定IP
SPRING_DATASOURCE_PLATFORM 单机模式下支持MYSQL数据库 mysql / 空 默认:空
MYSQL_SERVICE_HOST 数据库 连接地址
MYSQL_SERVICE_PORT 数据库端口 默认 : 3306
MYSQL_SERVICE_DB_NAME 数据库库名
MYSQL_SERVICE_USER 数据库用户名
MYSQL_SERVICE_PASSWORD 数据库用户密码
MYSQL_SERVICE_DB_PARAM 数据库连接参数 default : characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useSSL=false
MYSQL_DATABASE_NUM 数据库编号 默认 :1
JVM_XMS -Xms 默认 :1g
JVM_XMX -Xmx 默认 :1g
JVM_XMN -Xmn 默认 :512m
JVM_MS -XX:MetaspaceSize 默认 :128m
JVM_MMS -XX:MaxMetaspaceSize 默认 :320m
NACOS_DEBUG 是否开启远程DEBUG y/n 默认 :n
TOMCAT_ACCESSLOG_ENABLED server.tomcat.accesslog.enabled 默认 :false
NACOS_AUTH_SYSTEM_TYPE 权限系统类型选择,目前只支持nacos类型 默认 :nacos
NACOS_AUTH_ENABLE 是否开启权限系统 默认 :false
NACOS_AUTH_TOKEN_EXPIRE_SECONDS token 失效时间 默认 :18000
NACOS_AUTH_TOKEN token 默认 :SecretKey012345678901234567890123456789012345678901234567890123456789
NACOS_AUTH_CACHE_ENABLE 权限缓存开关 ,开启后权限缓存的更新默认有15秒的延迟 默认 : false
MEMBER_LIST 通过环境变量的方式设置集群地址 例子:192.168.16.101:8847?raft_port=8807,192.168.16.101?raft_port=8808,192.168.16.101:8849?raft_port=8809
EMBEDDED_STORAGE 是否开启集群嵌入式存储模式 embedded 默认 : none
NACOS_AUTH_CACHE_ENABLE nacos.core.auth.caching.enabled default : false
NACOS_AUTH_USER_AGENT_AUTH_WHITE_ENABLE nacos.core.auth.enable.userAgentAuthWhite default : false
NACOS_AUTH_IDENTITY_KEY nacos.core.auth.server.identity.key default : serverIdentity
NACOS_AUTH_IDENTITY_VALUE nacos.core.auth.server.identity.value default : security
NACOS_SECURITY_IGNORE_URLS nacos.security.ignore.urls default : /,/error,//*.css,//.js,/**/.html,//*.map,//.svg,/**/.png,//*.ico,/console-fe/public/,/v1/auth/,/v1/console/health/,/actuator/,/v1/console/server/