Spring Cloud Alibaba——Nacos服务发现:
前言
CMDB在企业中，一般用于存放与机器设备、应用、服务等相关的元数据。当企业的机器及应用达到一定规模后就需要这样一个系统来存储和管理它们的元数据。有一些广泛使用的属性，例如机器的IP、主机名、机房、应用、region等，这些数据一般会在机器部署时录入到CMDB，运维或者监控平台会使用这些数据进行展示或者相关的运维操作。
在服务进行多机房或者多地域部署时，跨地域的服务访问往往延迟较高，一个城市内的机房间的典型网络延迟在1ms左右，而跨城市的网络延迟，例如上海到北京大概为30ms。此时自然而然的一个想法就是能不能让服务消费者和服务提供者进行同地域访问。
在Nacos的服务发现组件中，对接CMDB，然后通过配置的访问规则，来实现服务消费者到服务提供者的同地域优先。
服务的同地域优先访问
这实际上就是一种负载均衡策略，在Nacos的规划中，丰富的服务端的可配置负载均衡策略是我们的重要发展方向，这与当前已有的注册中心产品不太一样。在设计如何在开源的场景中，支持就近访问的时候，与企业自带的CMDB集成是考虑的一个核心问题。除此之外，也在考虑将Nacos自身扩展为一个实现基础功能的CMDB。无论如何，都需要能够从某个地方获取IP的环境信息，这些信息要么是从企业的CMDB中查询而来，要么是从自己内置的存储中查询而来。
CMDB插件机制
先不考虑如何将CMDB的数据应用于负载均衡，我们需要首先在Nacos里将CMDB的数据通过某种方法获取。在实际使用中，基本上每个公司都会通过购买或者自研搭建自己的CMDB，那么为了能够解耦各个企业的CMDB具体实现，一个比较好的策略是使用SPI机制，约定CMDB的抽象调用接口，由各个企业添加自己的CMDB插件，无需任何代码上的重新构建，即可在运行状态下对接上企业的CMDB。
Nacos CMDB SPI机制原理
Nacos定义了一个SPI接口，里面包含了与第三方CMDB约定的一些方法。用户依照约定实现了相应的SPI接口后，将实现打成jar包放置到Nacos安装目录下，重启Nacos即可让Nacos与CMDB的数据打通。整个流程并不复杂，但是理解CMDB SPI接口里方法和相应概念的含义不太简单。在这里对CMDB机制的相关概念和接口含义做一个详细说明。
CMDB抽象概念
实体（Entity）
实体是作为CMDB里数据的承载方，在一般的CMDB中，一个实体可以指一个IP、应用或者服务。而这个实体会有很多属性，例如IP的机房信息，服务的版本信息等。
实体类型（Entity Type）
我们并不限定实体一定是IP、应用或者服务，这取决于实际的业务场景。Nacos有计划在未来支持不同的实体类型，不过就目前来说，服务发现需要的实体类型是IP。
标签（Label）
Label是我们抽象出的Entity属性，Label定义为一个描述Entity属性的K-V键值对。Label的key和value的取值范围一般都是预先定义好的，当需要对Label进行变更，如增加新的key或者value时，需要调用单独的接口并触发相应的事件。一个常见的Label的例子是IP的机房信息，我们认为机房（site）是Label的key，而机房的集合（site1, site2, site3）是Label的value，这个Label的定义就是：site: {site1, site2, site3}。
实体事件（Entity Event）
实体的标签的变更事件。当CMDB的实体属性发生变化，需要有一个事件机制来通知所有订阅方。为了保证实体事件携带的变更信息是最新准确的，这个事件里只会包含变更的实体的标识以及变更事件的类型，不会包含变更的标签的值。
CMDB约定接口
在设计与CMDB交互接口的时候，我们参考了内部对CMDB的访问接口，并与若干个外部客户进行了讨论。我们最终确定了以下要求第三方CMDB插件必须实现的接口：
获取标签列表
Set<String> getLabelNames();
这个方法将返回CMDB中需要被Nacos识别的标签名集合，CMDB插件可以按需决定返回什么标签个Nacos。不在这个集合的标签将会被Nacos忽略，即使这个标签出现在实体的属性里。我们允许这个集合会在运行时动态变化，Nacos会定时去调用这个接口刷新标签集合。
获取实体类型
Set<String> getEntityTypes();
获取CMDB里的实体的类型集合，不在这个集合的实体类型会被Nacos忽略。服务发现模块目前需要的实体类型是ip，如果想要通过打通CMDB数据来实现服务的高级负载均衡，请务必在返回集合里包含“ip”。
获取标签详情
Label getLabel(String labelName);
获取标签的详细信息。返回的Label类里包含标签的名字和标签值的集合。如果某个实体的这个标签的值不在标签值集合里，将会被视为无效。
查询实体的标签值
String getLabelValue(String entityName, String entityType, String labelName);
Map<String, String> getLabelValues(String entityName, String entityType);
这里包含两个方法，一个是获取实体某一个标签名对应的值，一个是获取实体所有标签的键值对。参数里包含实体的值和实体的类型。注意，这个方法并不会在每次在Nacos内部触发查询时去调用，Nacos内部有一个CMDB数据的缓存，只有当这个缓存失效或者不存在时，才会去访问CMDB插件查询数据。为了让CMDB插件的实现尽量简单，我们在Nacos内部实现了相应的缓存和刷新逻辑。
查询实体
Map<String, Map<String, Entity>> getAllEntities();
Entity getEntity(String entityName, String entityType);
查询实体包含两个方法：查询所有实体和查询单个实体。查询单个实体目前其实就是查询这个实体的所有标签，不过我们将这个方法与获取所有标签的方法区分开来，因为查询单个实体方法后面可能会进行扩展，比查询所有标签获取的信息要更多。
查询所有实体则是一次性将CMDB的所有数据拉取过来，该方法可能会比较消耗性能，无论是对于Nacos还是CMDB。Nacos内部调用该方法的策略是通过可配置的定时任务周期来定时拉取所有数据，在实现该CMDB插件时，也请关注CMDB服务本身的性能，采取合适的策略。
查询实体事件
List<EntityEvent> getEntityEvents(long timestamp);
这个方法意在获取最近一段时间内实体的变更消息，增量的去拉取变更的实体。因为Nacos不会实时去访问CMDB插件查询实体，需要这个拉取事件的方法来获取实体的更新。参数里的timestamp为上一次拉取事件的时间，CMDB插件可以选择使用或者忽略这个参数。
CMDB插件开发流程
参考：https://github.com/nacos-group/nacos-examples，这里已经给出了一个示例plugin实现。
具体步骤如下：
- 1、新建一个maven工程，引入依赖nacos-api:
<dependencies>
<dependency>
<groupId>com.alibaba.nacos</groupId>
<artifactId>nacos-api</artifactId>
<version>1.4.2</version>
</dependency>
</dependencies>
- 2、引入打包插件：
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
</plugin>
</plugins>
</build>
- 3、定义实现类，继承com.alibaba.nacos.api.cmdb.CmdbService，并实现相关方法。
package com.yibo.cmdb;
import com.alibaba.nacos.api.cmdb.pojo.*;
import com.alibaba.nacos.api.cmdb.spi.CmdbService;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
/**
* @Author: huangyibo
* @Date: 2021/7/31 23:59
* @Description:
*/
public class CmdbServiceImpl implements CmdbService {
private int index = 1;
private Map<String,Map<String, Entity>> entityMap = new ConcurrentHashMap<String, Map<String, Entity>>();
private Map<String,Label> labelMap = new ConcurrentHashMap<String, Label>();
/**
* CMDB_DATA_TABLE:模拟cmdb数据库数据
*/
public CmdbServiceImpl() {
Label label = new Label();
label.setName("cluster");
Set<String> values = new HashSet<String>();
values.add("shenzhen");
values.add("shanghai");
label.setValues(values);
labelMap.put(label.getName(),label);
entityMap.put(PreservedEntityTypes.ip.name(),new HashMap<String, Entity>());
//深圳cluster的ip
Entity entityShen = new Entity();
entityShen.setName("192.168.50.253");
entityShen.setType(PreservedEntityTypes.ip.name());
Map<String,String> lableShen = new HashMap<String, String>();
lableShen.put("cluster","shenzhen");
entityShen.setLabels(lableShen);
entityMap.get(PreservedEntityTypes.ip.name()).put(entityShen.getName(),entityShen);
//上海cluster的ip
Entity entityShang = new Entity();
entityShang.setName("192.168.50.175");
entityShang.setType(PreservedEntityTypes.ip.name());
Map<String,String> lableShang = new HashMap<String, String>();
lableShang.put("cluster","shanghai");
entityShang.setLabels(lableShang);
entityMap.get(PreservedEntityTypes.ip.name()).put(entityShang.getName(),entityShang);
}
public Set<String> getLabelNames() {
Set<String> labelNames = new HashSet<>();
labelMap.forEach((key,value) -> {
labelNames.add(key);
});
return labelNames;
}
public Set<String> getEntityTypes() {
Set<String> types = new HashSet<>();
entityMap.forEach((key,value) -> {
types.add(key);
});
return types;
}
public Label getLabel(String labelName) {
return labelMap.get(labelName);
}
public String getLabelValue(String entityName, String entityType, String labelName) {
return entityMap.get(entityType).get(entityName).getLabels().get(labelName);
}
public Map<String, String> getLabelValues(String entityName, String entityType) {
return entityMap.get(entityType).get(entityName).getLabels();
}
public Map<String, Map<String, Entity>> getAllEntities() {
return entityMap;
}
public List<EntityEvent> getEntityEvents(long timestamp) {
Entity entity = new Entity();
entity.setName("1.1.1.1");
entity.setType(PreservedEntityTypes.ip.name());
Map<String, String> labels = new HashMap<>();
labels.put("cluster1", "x1" + ((index % 3) + 1));
labels.put("cluster2", "x2" + ((index++ % 3) + 1));
entity.setLabels(labels);
entityMap.get(PreservedEntityTypes.ip.name()).put("1.1.1.1", entity);
EntityEvent entityEvent = new EntityEvent();
entityEvent.setEntityName("1.1.1.1");
entityEvent.setEntityType("PreservedEntityTypes.ip.name()");
entityEvent.setType(EntityEventType.ENTITY_ADD_OR_UPDATE);
List<EntityEvent> list = new ArrayList<>();
list.add(entityEvent);
return list;
}
public Entity getEntity(String entityName, String entityType) {
return entityMap.get(entityType).get(entityName);
}
}
- 4、在src/main/resource/目录下新建目录：META-INF/services。
- 且在该目录下新建
com.alibaba.nacos.api.cmdb.CmdbService文件 - 将CmdbService接口的实现类全名写入该文件
- 且在该目录下新建
com.yibo.cmdb.CmdbServiceImpl
- 5、代码自测完成后，执行命令进行打包：
mvn package assembly:single -Dmaven.test.skip=true
- 6、将target目录下的包含依赖的jar包上传到nacos CMDB插件目录：
{nacos.home}/plugins/cmdb
- 7、在nacos的application.properties里打开加载插件开关：
nacos.cmdb.loadDataAtStart=true
重启nacos Server，即可加载到您实现的nacos-cmdb插件获取您的CMDB数据。
使用Selector实现同机房优先访问
在拿到CMDB的数据之后，就可以运用CMDB数据的强大威力来实现多种灵活的负载均衡策略了，下面举例来说明如何使用CMDB数据和Selector来实现就近访问。
假设目前Nacos已经通过CMDB拿到了一些IP的机房信息，且它们对应的标签信息如下：
192.168.50.253
cluster: shenzhen
192.168.50.175
cluster: shanghai
服务详情
然后我们修改服务的“服务路由类型”，并配置为基于同cluster优先的服务路由：
编辑服务路由类型
这里我们将服务路由类型选择为标签，然后输入标签的表达式：
CONSUMER.label.cluster= PROVIDER.label.cluster
这个表达式的格式和我们抽象的Selector机制有关，在这里您需要记住的就是，任何一个如下格式的表达式：
CONSUMER.label.labelName = PROVIDER.label.labelName
将能够实现基于同labelName优先的负载均衡策略。
以上，便是我们在Nacos中通过打通CMDB，实现就近访问的实践。
