Nacos学习手册
初探Nacos
组内最近需要搭建一个微服务治理及动态配置管理平台,在调研了一些诸如Eureka、Consul等开源框架后,无意识中找到了阿里近年发布的一款比较靠谱的产品:Nacos。 进入到其官方文档和GitHub中看了一下,较为丰富的API以及较高的社区活跃度让我决定用它来试一试。
Nacos是什么
Nacos 致力于发现、配置和管理微服务。它提供了一组简单易用的特性集,帮助快速实现动态服务发现、服务配置、服务元数据及流量管理。使用Nacos 可以更敏捷和容易地构建、交付和管理微服务平台。 Nacos 是构建以“服务”为中心的现代应用架构 (例如微服务范式、云原生范式) 的服务基础设施。
服务(Service)是 Nacos 世界的一等公民。Nacos 支持几乎所有主流类型的“服务”的发现、配置和管理:
Kubernetes Service.
gRPC & Dubbo RPC Service.
Spring Cloud RESTful Service.
Nacos 的关键特性包括:
- 服务发现和服务健康监测 ,支持基于DNS和RPC的服务发现,支持基于传输层和应用层的监控检查;
- 动态配置服务 ,可以以中心化、外部化和动态化的方式管理所有环境的应用配置和服务配置,同时支持版本追踪和一键回滚等功能;
- 动态 DNS 服务 ,动态 DNS 服务支持权重路由,让您更容易地实现中间层负载均衡、更灵活的路由策略、流量控制以及数据中心内网的简单DNS解析服务;
- 服务及其元数据管理 ,管理数据中心的所有服务及元数据,包括管理服务的描述、生命周期、服务的静态依赖分析、服务的健康状态、服务的流量管理、路由及安全策略、服务的 SLA 以及最首要的 metrics 统计数据。
Nacos生态图
Nacos概念(Concepts)
命名空间(Namespace)
- 不同命名空间可以作为生产和开发环境的隔离。
配置(Configuration)
- 系统中一些配置信息可以注册到Nacos进行管理;
- 利用Nacos进行配置的动态发布。
配置管理(Configuration Management)
- 系统配置的编辑、存储、分发、变更管理、历史版本管理、变更审计等所有与配置相关的活动。
配置ID和配置分组(Data ID & Group)
- 配置ID作为配置的唯一标识;
- 配置分组内可以有多个配置ID,形成一个配置集。
服务名(Service)
- 注册服务的唯一标识。
服务注册中心(Service Registry)
- 存储服务实例和服务负载均衡策略的数据库。
服务发现(Service Discovery)
- 在计算机网络上,(通常使用服务名)对服务下的实例的地址和元数据进行探测,并以预先定义的接口提供给客户端进行查询。
服务分组(Service Group)
- 不同的服务可以归类到同一分组。
虚拟集群(Virtual Cluster)
- 同一个服务下的所有服务实例组成一个默认集群, 集群可以被进一步按需求划分,划分的单位可以是虚拟集群。
实例(Instance)
- 提供一个或多个服务的具有可访问网络地址(IP:Port)的进程。
权重(Weight)
- 实例级别的配置。权重为浮点数。权重越大,分配给该实例的流量越大。
健康检查(Health Check)
- 通过TCP/HTTP的方式检查服务下某实例的健康度,从而确定该实例是否能够提供服务,对于不健康的实例服务端则不会返回。
健康保护阈值(Protect Threshold)
- 为了防止因过多实例 (Instance) 不健康导致流量全部流向健康实例 (Instance) ,继而造成流量压力把健康 健康实例 (Instance) 压垮并形成雪崩效应,应将健康保护阈值定义为一个 0 到 1 之间的浮点数。当域名健康实例 (Instance) 占总服务实例 (Instance) 的比例小于该值时,无论实例 (Instance) 是否健康,都会将这个实例 (Instance) 返回给客户端。这样做虽然损失了一部分流量,但是保证了集群的剩余健康实例 (Instance) 能正常工作。
Nacos架构
基本架构
逻辑架构
领域模型
- 数据模型
- 服务领域模型
- 配置领域模型
Nacos部署
Nacos获取
通过源码或者发行包获取。
- 从 Github 上下载源码方式
git clone https://github.com/alibaba/nacos.git
cd nacos/
mvn -Prelease-nacos clean install -U
ls -al distribution/target/
// change the $version to your actual path
cd distribution/target/nacos-server-$version/nacos/bin
- 下载编译后压缩包方式
https://github.com/alibaba/nacos/releases
unzip nacos-server-$version.zip 或者 tar -xvf nacos-server-$version.tar.gz
cd nacos/bin
Nacos部署
- 单机模式 - 用于测试和单机试用
0.7版本之后,Nacos支持MySQL数据存储
安装步骤如下:
- 安装数据库,版本要求:5.6.5+
- 初始化mysql数据库,数据库初始化文件:nacos-mysql.sql
- 修改conf/application.properties文件,添加mysql数据源的url、用户名和密码。
spring.datasource.platform=mysql
db.num=1
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=user_name
db.password=pwd
- 集群模式 - 用于生产环境,确保高可用
- 修改conf目录下cluster.conf文件
#ip:port
200.8.9.16:8848
200.8.9.17:8848
200.8.9.18:8848
- 配置mysql数据库,同单机模式一样
- 无参模式启动startup.sh脚本
- Nginx配置
upstream nacosserver {
server 10.152.73.201:8848;
server 10.152.90.146:8848;
server 10.153.13.216:8848;
}
server {
listen 8080;
server_name localhost;
location / {
proxy_pass http://nacosserver/;
}
error_page 500 502 503 504 /50x.html;
location = /50x.html {
root html;
}
}
- 多集群模式 - 用于多数据中心场景
拓展单集群模式
Nacos启动
- 单机启动
sh startup.sh -m standalone
- 集群启动
sh startup.sh
- 关闭服务器
sh shutdown.sh
Nacos访问
http://10.142.73.201:8080/nacos/index.html
默认用户名:nacos
默认密码:nacos
修改nacos密码:
目前nacos暂不提供用户管理页面,需要手动对Nacos的user表进行密码修改
利用Nacos源码中PasswordEncoderUtil类生成密码,修改数据库即可
package com.alibaba.nacos.console.utils;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
/**
* Password encoder tool
*
* @author nacos
*/
public class PasswordEncoderUtil {
public static void main(String[] args) {
System.out.println(new BCryptPasswordEncoder().encode("nacos"));
}
}
Open API
这里仅列举项目中用到的一些API,更丰富的API详情可参考官方文档
获取配置列表
请求类型
GET
请求URL
/nacos/v1/cs/configs?search=accurate
请求参数
名称 | 类型 | 描述 |
---|---|---|
dataId | string | 配置ID |
group | string | 配置分组 |
appName | string | 应用名称 |
PageNo | int | 页码 |
pageSize | int | 页数量 |
获取配置详情
请求类型
GET
请求URL
/nacos/v1/cs/configs?show=all
请求参数
名称 | 类型 | 描述 |
---|---|---|
dataId | string | 配置ID |
group | string | 配置分组 |
获取配置历史列表
请求类型
GET
请求URL
/nacos/v1/cs/history?search=accurate
请求参数
名称 | 类型 | 描述 |
---|---|---|
dataId | string | 配置ID |
group | string | 配置分组 |
pageNo | int | 页码 |
pageSize | int | 页数量 |
获取配置历史详情
请求类型
GET
请求URL
/nacos/v1/cs/history
请求参数
名称 | 类型 | 描述 |
---|---|---|
dataId | string | 配置ID |
group | string | 配置分组 |
nid | int | 配置主键 |
删除配置
请求类型
DELETE
请求URL
/nacos/v1/cs/configs
请求参数
名称 | 类型 | 描述 |
---|---|---|
dataId | string | 配置ID |
group | string | 配置分组 |
添加修改回滚配置
请求类型
POST
请求URL
/nacos/v1/cs/configs
请求参数
名称 | 类型 | 描述 |
---|---|---|
dataId | string | 配置ID |
group | string | 配置分组 |
content | string | 配置内容 |
desc | string | 配置描述 |
type | string | 配置类型 |
获取服务列表
请求类型
GET
请求URL
/nacos/v1/ns/catalog/serviceList
请求参数
名称 | 类型 | 描述 |
---|---|---|
pageNo | int | 页码 |
pageSize | int | 页数量 |
keyword | string | 服务名称 |
删除服务
请求类型
DELETE
请求URL
/nacos/v1/ns/service
请求参数
名称 | 类型 | 描述 |
---|---|---|
serviceName | string | 服务名称 |
获取服务详情
请求类型
GET
请求URL
/nacos/v1/ns/
请求参数
名称 | 类型 | 描述 |
---|---|---|
serviceName | string | 服务名称 |
获取实例列表
请求类型
GET
请求URL
/nacos/v1/ns/instance/list
请求参数
名称 | 类型 | 描述 |
---|---|---|
serviceName | string | 服务名称 |
修改实例
请求类型
PUT
请求URL
/nacos/v1/ns/instance
请求参数
名称 | 类型 | 描述 |
---|---|---|
serviceName | string | 服务名称 |
ip | string | IP地址 |
port | int | 端口号 |
clusterName | string | 集群名称 |
weight | double | 权重 |
enable | bool | 是否上线 |
JAVA SDK
Nacos Spring Cloud
官网Demo:nacos-spring-cloud-config-example
启用配置管理
- 添加Maven依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
<version>${latest.version}</version>
</dependency>
- 配置文件
在bootstrap.yml
中配置Nacos服务地址和应用名称
spring:
cloud:
nacos:
config:
file-extension: yaml
server-addr:
10.142.73.201:8080
application:
name: nacos-manager
profiles:
active: online
说明:之所以需要配置 spring.application.name ,是因为它是构成 Nacos 配置管理 dataId字段的一部分。
在 Nacos Spring Cloud 中,dataId 的完整格式如下:
${prefix}-${spring.profile.active}.${file-extension}
1. prefix默认为spring.application.name 的值,也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
2. spring.profile.active即为当前环境对应的 profile,详情可以参考 Spring Boot文档。注意:当 spring.profile.active 为空时,对应的连接符 - 也将不存在,dataId 的拼接格式变成 ${prefix}.${file-extension}。
3. file-exetension 为配置内容的数据格式,可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持properties和yaml类型。
- 启用注解
通过Spring Cloud 原生注解 @RefreshScope 实现配置自动更新:
@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController {
@Value("${useLocalCache:false}")
private boolean useLocalCache;
@RequestMapping("/get")
public boolean get() {
return useLocalCache;
}
}
- Nacos平台发布配置
- 运行项目
- Nacos平台更新配置
- 读取项目中最新配置
启动服务发现
官网Demo:nacos-spring-cloud-discovery-example
- 添加Maven依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
<version>${latest.version}</version>
</dependency>
- 配置服务提供者
i. 在bootstrap.yml
中配置Nacos服务地址和应用名称
spring:
cloud:
nacos:
discovery:
server-addr: 10.142.73.201:8080
cluster-name: nacos-provider
application:
name: nacos-provider
ii. 通过 Spring Cloud 原生注解 @EnableDiscoveryClient 开启服务注册发现功能:
@SpringBootApplication
@EnableDiscoveryClient
public class NacosProviderApplication {
public static void main(String[] args) {
SpringApplication.run(NacosProviderApplication.class, args);
}
@RestController
class EchoController {
@RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
public String echo(@PathVariable String string) {
return "Hello Nacos Discovery " + string;
}
}
}
- 配置服务消费者
i. 在bootstrap.yml
中配置Nacos服务地址和应用名称
spring:
cloud:
nacos:
discovery:
server-addr: 10.142.73.201:8080
cluster-name: nacos-consumer
application:
name: nacos-consumer
ii. 通过 Spring Cloud 原生注解 @EnableDiscoveryClient 开启服务注册发现功能。
@SpringBootApplication
@EnableDiscoveryClient
public class NacosConsumerApplication {
@Bean
public RestTemplate restTemplate() {
return new RestTemplate();
}
public static void main(String[] args) {
SpringApplication.run(NacosConsumerApplication.class, args);
}
@RestController
public class TestController {
private final RestTemplate restTemplate;
@Autowired
public TestController(RestTemplate restTemplate) {this.restTemplate = restTemplate;}
@RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
public String echo(@PathVariable String str) {
return restTemplate.getForObject("http://nacos-provider/echo/" + str, String.class);
}
}
}
- 启动服务
分别启动NacosProviderApplication和NacosConsumerApplication服务
NodeJS
Python
Spring Cloud生态配置服务对比
1、Spring Cloud Config
GitHub地址
https://github.com/spring-cloud/spring-cloud-config ,Star数1178,官方组件,社区较活跃
开源厂商
Pivotal(Spring官方团队)
产品特点
- 遵循Spring Cloud Config的配置管理规范
- 后端存储支持丰富(支持Git、SVN、MySQL、Vault、本地存储等)
成功案例
N多,目前用Spring Cloud的大多团队都是用的Spring Cloud Config
缺点
- 没有界面,管理麻烦
- 没有权限管理
- 依赖繁多(如需实现配置批量刷新,需要借助Spring Cloud Bus,依赖Kafka或RabbitMQ)
- 由于依赖太多,集群搭建很麻烦——GitLab、MQ、Config Server本身都得做集群
2、Apollo
GitHub地址
https://github.com/ctripcorp/apollo ,Star数11169,社区很活跃
开源厂商
携程
产品特点
- 概念较为清晰,上手简单
- 完善的流程、权限控制
- 界面友好
- 文档较为丰富
成功案例
携程、网易蜂巢、中国平安等,更多公司详见https://github.com/ctripcorp/apollo
缺点
暂未发现
3、Nacos
GitHub地址
https://github.com/alibaba/nacos ,Star数3820,社区非常活跃
开源厂商
阿里巴巴
产品特点
- 目前在Spring Cloud孵化器中孵化,孵化成功后,将成为Spring Cloud官方推荐的组件之一
- 不仅能做配置管理,也能做注册中心
- 界面友好
- 上手简单
- 文档丰富
成功案例
阿里巴巴、虎牙直播、工商银行软件开发中心、爱奇艺等,更多公司详见https://github.com/alibaba/nacos/issues/273
缺点
暂未发现
4、Disconf
GitHub地址
https://github.com/knightliao/disconf ,Start数4505,社区活跃度一般
开源厂商
原百度员工,现在蚂蚁金服
产品特点
- 界面良好
- 部署简单
成功案例
百度、滴滴出行、顺丰、网易等,更多公司详见https://github.com/knightliao/disconf
缺点
最新的版本发布于两年前,有点久了。
5、Spring Cloud Consul
GitHub地址
https://github.com/spring-cloud/spring-cloud-consul ,Star数493,官方组件,社区较活跃
开源厂商
Pivotal(Spring官方团队)
产品特点
- 有个还算将就的界面
- 使用较为简单
- 遵循Spring Cloud Config的配置管理规范
- 不仅能做配置管理,也能做注册中心
成功案例
暂未发现
缺点
- 没有权限管理
- 管理界面不够友善
- 要想用得好,得了解Spring Cloud Config管理规范
6、Spring Cloud Zookeeper
GitHub地址
https://github.com/spring-cloud/spring-cloud-zookeeper ,Star数330,官方组件,社区较活跃
开源厂商
Pivotal(Spring官方团队)
产品特点
- 使用较为简单
- 遵循Spring Cloud Config的配置管理规范
- 不仅能做配置管理,也能做注册中心
成功案例
暂未发现
缺点
- 无界面
- 无权限管理
- 要想用得好,得了解Spring Cloud Config管理规范
结论
以上配置服务在调研过程中会存在先入为主的个人因素,但排除有明显缺点的项目之后,Nacos显然没有拒绝的理由。