从零开始:Nacos服务注册与配置中心实战教程
Nacos(Dynamic Naming and Configuration Service)是阿里巴巴开源的服务发现、配置管理工具,集注册中心与配置中心于一体,广泛应用于微服务架构。本文将从环境搭建到实战配置,带你快速掌握Nacos的核心用法。
一、Nacos简介
Nacos主要提供两大核心功能:
- 服务注册与发现:替代Eureka、Consul等,支持服务自动注册、健康检查、负载均衡。
- 动态配置管理:集中管理配置文件,支持动态更新无需重启服务,多环境配置隔离。
本文基于Nacos 2.1.0版本(当前稳定版),兼容Spring Cloud Alibaba 2.2.x及以上。
二、Nacos服务端部署
1. 单机版部署(开发环境)
方式1:Docker快速部署(推荐)
# 拉取镜像
docker pull nacos/nacos-server:v2.1.0-slim
1.创建挂载目录
mkdir -p /mydata/nacos/logs/ #新建logs目录
mkdir -p /mydata/nacos/conf/ #新建conf目录
ps:这一步是添加映射文件夹,将宿主机的文件映射到nacos容器中,你可以在配置好nacos后再这两个文件夹下查看日志和配置
2.启动nacos并复制文件到宿主机,关闭容器
docker run -d --name nacos-server -p 8848:8848 nacos/nacos-server:v2.3.1
这一步是先随便启动一下nacos然后nacos容器当中的配置文件和日志复制到我们刚才创建的目录下,为我们以后的挂载做准备
3.删除刚才随便创建的nacos服务
docker rm -f nacos
4.配置MySQL,将nacos按照生产环境标准去配置,默认为内置数据库(不推荐)
直接在你的服务器mysql数据库创建一个nacos-mysql-config的数据库,然后执行下面的语句即可
/** Copyright 1999-2018 Alibaba Group Holding Ltd.** Licensed under the Apache License, Version 2.0 (the "License");* you may not use this file except in compliance with the License.* You may obtain a copy of the License at** http://www.apache.org/licenses/LICENSE-2.0** Unless required by applicable law or agreed to in writing, software* distributed under the License is distributed on an "AS IS" BASIS,* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.* See the License for the specific language governing permissions and* limitations under the License.*//******************************************/
/* 表名称 = config_info */
/******************************************/
CREATE TABLE `config_info` (`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',`data_id` varchar(255) NOT NULL COMMENT 'data_id',`group_id` varchar(128) DEFAULT NULL COMMENT 'group_id',`content` longtext NOT NULL COMMENT 'content',`md5` varchar(32) DEFAULT NULL COMMENT 'md5',`gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',`gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',`src_user` text COMMENT 'source user',`src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip',`app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',`tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',`c_desc` varchar(256) DEFAULT NULL COMMENT 'configuration description',`c_use` varchar(64) DEFAULT NULL COMMENT 'configuration usage',`effect` varchar(64) DEFAULT NULL COMMENT '配置生效的描述',`type` varchar(64) DEFAULT NULL COMMENT '配置的类型',`c_schema` text COMMENT '配置的模式',`encrypted_data_key` text NOT NULL COMMENT '密钥',PRIMARY KEY (`id`),UNIQUE KEY `uk_configinfo_datagrouptenant` (`data_id`,`group_id`,`tenant_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_info';/******************************************/
/* 表名称 = config_info_aggr */
/******************************************/
CREATE TABLE `config_info_aggr` (`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',`data_id` varchar(255) NOT NULL COMMENT 'data_id',`group_id` varchar(128) NOT NULL COMMENT 'group_id',`datum_id` varchar(255) NOT NULL COMMENT 'datum_id',`content` longtext NOT NULL COMMENT '内容',`gmt_modified` datetime NOT NULL COMMENT '修改时间',`app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',`tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',PRIMARY KEY (`id`),UNIQUE KEY `uk_configinfoaggr_datagrouptenantdatum` (`data_id`,`group_id`,`tenant_id`,`datum_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='增加租户字段';/******************************************/
/* 表名称 = config_info_beta */
/******************************************/
CREATE TABLE `config_info_beta` (`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',`data_id` varchar(255) NOT NULL COMMENT 'data_id',`group_id` varchar(128) NOT NULL COMMENT 'group_id',`app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',`content` longtext NOT NULL COMMENT 'content',`beta_ips` varchar(1024) DEFAULT NULL COMMENT 'betaIps',`md5` varchar(32) DEFAULT NULL COMMENT 'md5',`gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',`gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',`src_user` text COMMENT 'source user',`src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip',`tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',`encrypted_data_key` text NOT NULL COMMENT '密钥',PRIMARY KEY (`id`),UNIQUE KEY `uk_configinfobeta_datagrouptenant` (`data_id`,`group_id`,`tenant_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_info_beta';/******************************************/
/* 表名称 = config_info_tag */
/******************************************/
CREATE TABLE `config_info_tag` (`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',`data_id` varchar(255) NOT NULL COMMENT 'data_id',`group_id` varchar(128) NOT NULL COMMENT 'group_id',`tenant_id` varchar(128) DEFAULT '' COMMENT 'tenant_id',`tag_id` varchar(128) NOT NULL COMMENT 'tag_id',`app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',`content` longtext NOT NULL COMMENT 'content',`md5` varchar(32) DEFAULT NULL COMMENT 'md5',`gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',`gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',`src_user` text COMMENT 'source user',`src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip',PRIMARY KEY (`id`),UNIQUE KEY `uk_configinfotag_datagrouptenanttag` (`data_id`,`group_id`,`tenant_id`,`tag_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_info_tag';/******************************************/
/* 表名称 = config_tags_relation */
/******************************************/
CREATE TABLE `config_tags_relation` (`id` bigint(20) NOT NULL COMMENT 'id',`tag_name` varchar(128) NOT NULL COMMENT 'tag_name',`tag_type` varchar(64) DEFAULT NULL COMMENT 'tag_type',`data_id` varchar(255) NOT NULL COMMENT 'data_id',`group_id` varchar(128) NOT NULL COMMENT 'group_id',`tenant_id` varchar(128) DEFAULT '' COMMENT 'tenant_id',`nid` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'nid, 自增长标识',PRIMARY KEY (`nid`),UNIQUE KEY `uk_configtagrelation_configidtag` (`id`,`tag_name`,`tag_type`),KEY `idx_tenant_id` (`tenant_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_tag_relation';/******************************************/
/* 表名称 = group_capacity */
/******************************************/
CREATE TABLE `group_capacity` (`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键ID',`group_id` varchar(128) NOT NULL DEFAULT '' COMMENT 'Group ID,空字符表示整个集群',`quota` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '配额,0表示使用默认值',`usage` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '使用量',`max_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '单个配置大小上限,单位为字节,0表示使用默认值',`max_aggr_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '聚合子配置最大个数,,0表示使用默认值',`max_aggr_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '单个聚合数据的子配置大小上限,单位为字节,0表示使用默认值',`max_history_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '最大变更历史数量',`gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',`gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',PRIMARY KEY (`id`),UNIQUE KEY `uk_group_id` (`group_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='集群、各Group容量信息表';/******************************************/
/* 表名称 = his_config_info */
/******************************************/
CREATE TABLE `his_config_info` (`id` bigint(20) unsigned NOT NULL COMMENT 'id',`nid` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT 'nid, 自增标识',`data_id` varchar(255) NOT NULL COMMENT 'data_id',`group_id` varchar(128) NOT NULL COMMENT 'group_id',`app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',`content` longtext NOT NULL COMMENT 'content',`md5` varchar(32) DEFAULT NULL COMMENT 'md5',`gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',`gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',`src_user` text COMMENT 'source user',`src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip',`op_type` char(10) DEFAULT NULL COMMENT 'operation type',`tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',`encrypted_data_key` text NOT NULL COMMENT '密钥',PRIMARY KEY (`nid`),KEY `idx_gmt_create` (`gmt_create`),KEY `idx_gmt_modified` (`gmt_modified`),KEY `idx_did` (`data_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='多租户改造';/******************************************/
/* 表名称 = tenant_capacity */
/******************************************/
CREATE TABLE `tenant_capacity` (`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键ID',`tenant_id` varchar(128) NOT NULL DEFAULT '' COMMENT 'Tenant ID',`quota` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '配额,0表示使用默认值',`usage` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '使用量',`max_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '单个配置大小上限,单位为字节,0表示使用默认值',`max_aggr_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '聚合子配置最大个数',`max_aggr_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '单个聚合数据的子配置大小上限,单位为字节,0表示使用默认值',`max_history_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '最大变更历史数量',`gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',`gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',PRIMARY KEY (`id`),UNIQUE KEY `uk_tenant_id` (`tenant_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='租户容量信息表';CREATE TABLE `tenant_info` (`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',`kp` varchar(128) NOT NULL COMMENT 'kp',`tenant_id` varchar(128) default '' COMMENT 'tenant_id',`tenant_name` varchar(128) default '' COMMENT 'tenant_name',`tenant_desc` varchar(256) DEFAULT NULL COMMENT 'tenant_desc',`create_source` varchar(32) DEFAULT NULL COMMENT 'create_source',`gmt_create` bigint(20) NOT NULL COMMENT '创建时间',`gmt_modified` bigint(20) NOT NULL COMMENT '修改时间',PRIMARY KEY (`id`),UNIQUE KEY `uk_tenant_info_kptenantid` (`kp`,`tenant_id`),KEY `idx_tenant_id` (`tenant_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='tenant_info';CREATE TABLE `users` (`username` varchar(50) NOT NULL PRIMARY KEY COMMENT 'username',`password` varchar(500) NOT NULL COMMENT 'password',`enabled` boolean NOT NULL COMMENT 'enabled'
);CREATE TABLE `roles` (`username` varchar(50) NOT NULL COMMENT 'username',`role` varchar(50) NOT NULL COMMENT 'role',UNIQUE INDEX `idx_user_role` (`username` ASC, `role` ASC) USING BTREE
);CREATE TABLE `permissions` (`role` varchar(50) NOT NULL COMMENT 'role',`resource` varchar(128) NOT NULL COMMENT 'resource',`action` varchar(8) NOT NULL COMMENT 'action',UNIQUE INDEX `uk_role_permission` (`role`,`resource`,`action`) USING BTREE
);INSERT INTO users (username, password, enabled) VALUES ('nacos', '$2a$10$EuWPZHzz32dJN7jexM34MOeYirDdFAZm2kuWj7VEOJhhZkDrxfvUu', TRUE);INSERT INTO roles (username, role) VALUES ('nacos', 'ROLE_ADMIN');
4.正式启动nacos
# 启动容器(单机模式,默认内存模式)
docker run -d \--name nacos \-p 8848:8848 \-p 9848:9848 \-p 9849:9849 \--privileged=true \-e JVM_XMS=256m \-e JVM_XMX=256m \-e JVM_XMN=128m \-e MODE=standalone \-e SPRING_DATASOURCE_PLATFORM=mysql \-e MYSQL_SERVICE_HOST=修改为你的数据库地址 \-e MYSQL_SERVICE_PORT=3306 \-e MYSQL_SERVICE_DB_NAME=nacos-mysql-config \-e MYSQL_SERVICE_USER=root \-e MYSQL_SERVICE_PASSWORD=修改为你的数据库密码 \-e NACOS_AUTH_TOKEN=修改为你加密后的token要求在加密前在32位以上 \-e NACOS_AUTH_IDENTITY_KEY=nacos \-e NACOS_AUTH_IDENTITY_VALUE=secret \-v /mydata/nacos/logs/:/home/nacos/logs \-v /mydata/nacos/conf/:/home/nacos/conf/ \--restart=always \nacos/nacos-server:v2.1.0-slim
5.放通你的防火墙对应的8848,9848,9849端口
这部分不过多说了,网上有很多教程,请你参考配置即可
6.访问你的nacos服务
这时候你的nacos服务应该说是已经启动好了,请你修改以下url就访问你的nacos服务了用户名和密码均为:nacos
http://你的IP地址:8848/nacos
方式2:源码包部署
- 从Nacos官网下载2.1.0版本压缩包。
- 解压后进入
bin
目录,执行启动命令:# Linux/Mac sh startup.sh -m standalone # Windows cmd startup.cmd -m standalone
2. 验证服务端是否启动
访问控制台:http://服务器IP:8848/nacos
,默认账号密码:nacos/nacos
。
若能登录,说明服务端部署成功。
三、客户端集成(Spring Cloud)
1. 引入依赖(Maven)
在pom.xml
中添加:
<!-- 服务发现依赖 -->
<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId><version>2.2.7.RELEASE</version>
</dependency><!-- 配置中心依赖(如需动态配置) -->
<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId><version>2.2.7.RELEASE</version>
</dependency>
2. 服务注册配置(application.yml)
spring:cloud:nacos:discovery:server-addr: xxxxxx:8848 # 服务端地址正确# 用户名密码:使用Nacos默认或服务端配置的账号(Docker未修改,默认是nacos/nacos)username: nacospassword: nacossecret-key: NWY0ZGNjM2IxxxxxxxxxxxxxxxxN2RlYjg4MmNmOTk=access-key: nacosconfig:server-addr: xxxxxxxxxxxx:8848group: DEFAULT_GROUPfile-extension: yml#读取配置中心文件配置config:import:- optional:nacos:${spring.application.name}.${spring.cloud.nacos.config.file-extension}
参考我的配置:
3. 启动类添加注解
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;@SpringBootApplication
@EnableDiscoveryClient // 开启服务注册发现(Spring Cloud 2020+可省略)
public class EBuiltAuthenticApplication {public static void main(String[] args) {SpringApplication.run(EBuiltAuthenticApplication.class, args);}
}
启动服务后,在Nacos控制台的「服务列表」中可看到注册的服务,说明集成成功。
四、动态配置中心使用
1. 添加配置文件(bootstrap.yml)
注意:配置中心需使用bootstrap.yml
(加载优先级高于application.yml
):
spring:application:name: e-built-authenticcloud:nacos:config:server-addr: 43.138.10.233:8848 # 配置中心地址file-extension: yaml # 配置文件格式(yaml/xml/properties)group: DEFAULT_GROUP # 配置分组(默认DEFAULT_GROUP)namespace: # 命名空间(用于多环境隔离,默认public)# 认证配置(同服务注册)username: nacospassword: nacos
2. 在Nacos控制台添加配置
- 进入控制台「配置管理」→「配置列表」,点击「+」新建配置:
- Data ID:
e-built-authentic.yaml
(格式:服务名.文件格式) - Group:
DEFAULT_GROUP
(与客户端配置一致) - 配置内容:
user:name: nacos-testage: 18
- Data ID:
3. 客户端获取动态配置
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@RefreshScope // 开启动态刷新配置
public class ConfigController {@Value("${user.name:default}")private String userName;@GetMapping("/user/name")public String getUserName() {return userName;}
}
- 访问
/user/name
,返回nacos-test
,说明配置生效。 - 在Nacos控制台修改
user.name
的值,无需重启服务,再次访问即可获取新值。
五、常见问题与解决方案
1. 服务注册失败:Client not connected
- 原因:网络不通或端口未开放。
- 解决:
- 开放Nacos端口:8848(HTTP)、9848-9849(gRPC)。
- 检查云服务器安全组、防火墙是否放行上述端口。
- 验证命令:
telnet 服务器IP 8848
(能连接则网络正常)。
2. 认证失败:authentication failed
- 原因:客户端与服务端认证参数不匹配。
- 解决:确保客户端
access-key
/secret-key
与服务端NACOS_AUTH_IDENTITY_KEY
/NACOS_AUTH_TOKEN
一致。
3. 配置不生效:@Value
获取为默认值
- 原因:
Data ID
或Group
与客户端配置不一致。 - 解决:
Data ID
必须为「服务名.文件格式」(如e-built-authentic.yaml
),Group
需与客户端group
配置一致。
六、生产环境注意事项
- 集群部署:生产环境需部署Nacos集群,避免单点故障。
- 数据持久化:默认使用内存存储,生产需配置MySQL持久化(修改
conf/application.properties
)。 - 安全加固:
- 开启认证(
NACOS_AUTH_ENABLE=true
)。 - 自定义复杂的
NACOS_AUTH_TOKEN
。 - 限制客户端IP访问(通过安全组或Nacos权限控制)。
- 开启认证(
- 版本兼容:Spring Cloud Alibaba与Nacos版本需严格匹配(参考官方兼容性文档)。
七、总结
Nacos作为微服务架构的核心组件,简化了服务注册发现与配置管理流程。本文从部署到实战,覆盖了开发环境的核心配置,掌握这些内容后,可进一步探索Nacos的高级特性(如配置灰度发布、服务路由等)。
如果在使用中遇到其他问题,欢迎在评论区交流~
本文同步发布于个人技术博客,转载请注明出处。更多微服务相关教程,敬请关注后续更新!