手撕Nacos源碼，今日撕客戶端源碼
共 26739字，需瀏覽 54分鐘
·
2024-05-15 21:38
來(lái)源：juejin.cn/post/7117517682001494047
推薦：https://t.zsxq.com/2M0HH
Nacos源碼剖析
Nacos源碼有很多值得我們學(xué)習(xí)的地方，為了深入理解Nacos，我們剖析源碼，分析如下2個(gè)知識(shí)點(diǎn)：
1:Nacos對(duì)注冊(cè)中心的訪問(wèn)原理
2:Nacos注冊(cè)服務(wù)處理流程
源碼環(huán)境搭建
1、從官方項(xiàng)目上克隆下來(lái)，并且檢出 1.4.1 版本，導(dǎo)入idea。nacos源碼環(huán)境搭建起來(lái)比較輕松，幾乎不會(huì)報(bào)什么錯(cuò)誤，導(dǎo)入后編譯安裝到本地環(huán)境即可
2、找到config 模塊中找到 \resources\META-INF\nacos-db.sql，在本地mysql中創(chuàng)建數(shù)據(jù)庫(kù)nacos-config，將該腳本導(dǎo)入執(zhí)行創(chuàng)建表。
3、找到console模塊下的配置文件application.properties，修改相關(guān)配置
#*************** Config Module Related Configurations ***************#
### If use MySQL as datasource:
spring.datasource.platform=mysql
### Count of DB:
db.num=1
### Connect URL of DB:
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos-config?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC
db.user.0=nacos
db.password.0=nacos
4、找到console模塊下的啟動(dòng)類，啟動(dòng)nacos的服務(wù)端，啟動(dòng)時(shí)添加啟動(dòng)參數(shù)，指定啟動(dòng)模式為非集群?jiǎn)?dòng)
-Dnacos.standalone=true
5、訪問(wèn)本地的nacos：http://localhost:8848/nacos
至此，源碼環(huán)境搭建成功！
nacos客戶端
首先要搞清楚：nacos的客戶端其實(shí)在我們自己的服務(wù)里，我們引入了nacos的相關(guān)坐標(biāo)依賴，nacos客戶端以jar包的形式在我們的服務(wù)中工作
對(duì)于nacos的客戶端，它都要幫我們實(shí)現(xiàn)什么功能呢？
它的主要工作有：服務(wù)注冊(cè)、服務(wù)發(fā)現(xiàn)、服務(wù)下線操作、服務(wù)訂閱操作等相關(guān)操作。
客戶端與注冊(cè)中心服務(wù)端的交互，主要集中在服務(wù)注冊(cè)、服務(wù)下線、服務(wù)發(fā)現(xiàn)、訂閱某個(gè)服務(wù)，其實(shí)使用最多的就是服務(wù)注冊(cè)和服務(wù)發(fā)現(xiàn)，下面我會(huì)從源碼的角度分析一下這四個(gè)功能。
在Nacos源碼中nacos-example中com.alibaba.nacos.example.NamingExample類分別演示了這4個(gè)功能的操作，我們可以把它當(dāng)做入口，代碼如下：
public class NamingExample {
public static void main(String[] args) throws NacosException {
Properties properties = new Properties();
properties.setProperty("serverAddr", System.getProperty("serverAddr"));
properties.setProperty("namespace", System.getProperty("namespace"));
NamingService naming = NamingFactory.createNamingService(properties);
//服務(wù)注冊(cè)
naming.registerInstance("nacos.test.3", "11.11.11.11", 8888, "TEST1");
naming.registerInstance("nacos.test.3", "2.2.2.2", 9999, "DEFAULT");
//服務(wù)發(fā)現(xiàn)
System.out.println(naming.getAllInstances("nacos.test.3"));
//服務(wù)下線
naming.deregisterInstance("nacos.test.3", "2.2.2.2", 9999, "DEFAULT");
System.out.println(naming.getAllInstances("nacos.test.3"));
//服務(wù)訂閱
Executor executor = new ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<Runnable>(),
new ThreadFactory() {
@Override
public Thread newThread(Runnable r) {
Thread thread = new Thread(r);
thread.setName("test-thread");
return thread;
}
});
naming.subscribe("nacos.test.3", new AbstractEventListener() {
//EventListener onEvent is sync to handle, If process too low in onEvent, maybe block other onEvent callback.
//So you can override getExecutor() to async handle event.
@Override
public Executor getExecutor() {
return executor;
}
@Override
public void onEvent(Event event) {
System.out.println(((NamingEvent) event).getServiceName());
System.out.println(((NamingEvent) event).getInstances());
}
});
}
}
服務(wù)注冊(cè)
我們沿著案例中的服務(wù)注冊(cè)方法調(diào)用找到nacos-api中的NamingService.registerInstance()并找到它的實(shí)現(xiàn)類和方法com.alibaba.nacos.client.naming.NacosNamingService，代碼如下：
/***
* 服務(wù)注冊(cè)
* @param serviceName 服務(wù)名字
* @param ip 服務(wù)IP
* @param port 服務(wù)端口
* @param clusterName 集群名字
* @throws NacosException
*/
@Override
public void registerInstance(String serviceName, String ip, int port, String clusterName) throws NacosException {
registerInstance(serviceName, Constants.DEFAULT_GROUP, ip, port, clusterName);
}
@Override
public void registerInstance(String serviceName, String groupName, String ip, int port, String clusterName)
throws NacosException {
//設(shè)置實(shí)例IP：Port，默認(rèn)權(quán)重為1.0
Instance instance = new Instance();
instance.setIp(ip);
instance.setPort(port);
instance.setWeight(1.0);
instance.setClusterName(clusterName);
//注冊(cè)實(shí)例
registerInstance(serviceName, groupName, instance);
}
@Override
public void registerInstance(String serviceName, Instance instance) throws NacosException {
registerInstance(serviceName, Constants.DEFAULT_GROUP, instance);
}
/***
* 實(shí)例注冊(cè)
* @param serviceName name of service
* @param groupName group of service
* @param instance instance to register
* @throws NacosException
*/
@Override
public void registerInstance(String serviceName, String groupName, Instance instance) throws NacosException {
NamingUtils.checkInstanceIsLegal(instance);
String groupedServiceName = NamingUtils.getGroupedName(serviceName, groupName);
//該字段表示注冊(cè)的實(shí)例是否是臨時(shí)實(shí)例還是持久化實(shí)例。
// 如果是臨時(shí)實(shí)例，則不會(huì)在 Nacos 服務(wù)端持久化存儲(chǔ)，需要通過(guò)上報(bào)心跳的方式進(jìn)行包活，
// 如果一段時(shí)間內(nèi)沒(méi)有上報(bào)心跳，則會(huì)被 Nacos 服務(wù)端摘除。
if (instance.isEphemeral()) {
//為注冊(cè)服務(wù)設(shè)置一個(gè)定時(shí)任務(wù)獲取心跳信息，默認(rèn)為5s匯報(bào)一次
BeatInfo beatInfo = beatReactor.buildBeatInfo(groupedServiceName, instance);
beatReactor.addBeatInfo(groupedServiceName, beatInfo);
}
//注冊(cè)到服務(wù)端
serverProxy.registerService(groupedServiceName, groupName, instance);
}
注冊(cè)主要做了兩件事，第一件事：為注冊(cè)的服務(wù)設(shè)置一個(gè)定時(shí)心跳任務(wù)。 第二件事：將服務(wù)注冊(cè)到服務(wù)端。
1:啟動(dòng)一個(gè)定時(shí)心跳任務(wù)，時(shí)間間隔為5s,如果服務(wù)正常，不做處理，如果不正常，重新注冊(cè)
2:發(fā)送http請(qǐng)求給注冊(cè)中心服務(wù)端，調(diào)用服務(wù)注冊(cè)接口，注冊(cè)服務(wù)
上面代碼我們可以看到定時(shí)任務(wù)添加，但并未完全看到遠(yuǎn)程請(qǐng)求，serverProxy.registerService()方法如下，會(huì)先封裝請(qǐng)求參數(shù)，接下來(lái)調(diào)用reqApi()而reqApi()最后會(huì)調(diào)用callServer()，代碼如下：
public void registerService(String serviceName, String groupName, Instance instance) throws NacosException {
NAMING_LOGGER.info("[REGISTER-SERVICE] {} registering service {} with instance: {}", namespaceId, serviceName,
instance);
//封裝Http請(qǐng)求參數(shù)
final Map<String, String> params = new HashMap<String, String>(16);
params.put(CommonParams.NAMESPACE_ID, namespaceId);
params.put(CommonParams.SERVICE_NAME, serviceName);
params.put(CommonParams.GROUP_NAME, groupName);
params.put(CommonParams.CLUSTER_NAME, instance.getClusterName());
params.put("ip", instance.getIp());
params.put("port", String.valueOf(instance.getPort()));
params.put("weight", String.valueOf(instance.getWeight()));
params.put("enable", String.valueOf(instance.isEnabled()));
params.put("healthy", String.valueOf(instance.isHealthy()));
params.put("ephemeral", String.valueOf(instance.isEphemeral()));
params.put("metadata", JacksonUtils.toJson(instance.getMetadata()));
//執(zhí)行Http請(qǐng)求
reqApi(UtilAndComs.nacosUrlInstance, params, HttpMethod.POST);
}
/***
*執(zhí)行遠(yuǎn)程調(diào)用
**/
public String callServer(String api, Map<String, String> params, Map<String, String> body, String curServer,
String method) throws NacosException {
long start = System.currentTimeMillis();
long end = 0;
injectSecurityInfo(params);
//封裝請(qǐng)求頭部
Header header = builderHeader();
//請(qǐng)求是Http還是Https協(xié)議
String url;
if (curServer.startsWith(UtilAndComs.HTTPS) || curServer.startsWith(UtilAndComs.HTTP)) {
url = curServer + api;
} else {
if (!IPUtil.containsPort(curServer)) {
curServer = curServer + IPUtil.IP_PORT_SPLITER + serverPort;
}
url = NamingHttpClientManager.getInstance().getPrefix() + curServer + api;
}
try {
//執(zhí)行遠(yuǎn)程請(qǐng)求,并獲取結(jié)果集
HttpRestResult<String> restResult = nacosRestTemplate
.exchangeForm(url, header, Query.newInstance().initParams(params), body, method, String.class);
end = System.currentTimeMillis();
MetricsMonitor.getNamingRequestMonitor(method, url, String.valueOf(restResult.getCode()))
.observe(end - start);
//結(jié)果集解析
if (restResult.ok()) {
return restResult.getData();
}
if (HttpStatus.SC_NOT_MODIFIED == restResult.getCode()) {
return StringUtils.EMPTY;
}
throw new NacosException(restResult.getCode(), restResult.getMessage());
} catch (Exception e) {
NAMING_LOGGER.error("[NA] failed to request", e);
throw new NacosException(NacosException.SERVER_ERROR, e);
}
}
執(zhí)行遠(yuǎn)程Http請(qǐng)求的對(duì)象是NacosRestTemplate，該對(duì)象就是封裝了普通的Http請(qǐng)求，大家可以自己查閱一下。
服務(wù)發(fā)現(xiàn)
兩個(gè)入口：
1、NamingService.getAllInstances(serviceName)
我們沿著案例中的服務(wù)發(fā)現(xiàn)方法調(diào)用找到nacos-api中的NamingService.getAllInstances()并找到它的實(shí)現(xiàn)類和方法com.alibaba.nacos.client.naming.NacosNamingService.getAllInstances()，代碼如下：
@Override
public List<Instance> getAllInstances(String serviceName, String groupName, List<String> clusters,
boolean subscribe) throws NacosException {
ServiceInfo serviceInfo;
/*默認(rèn)true->獲取服務(wù)實(shí)例*/
if (subscribe) {
//從本地緩存中獲取，如果本地緩存不存在從服務(wù)端拉取
//本地緩存會(huì)存儲(chǔ)在HostReactor.serviceInfoMap中，它是一個(gè)Map對(duì)象
serviceInfo = hostReactor.getServiceInfo(NamingUtils.getGroupedName(serviceName, groupName),
StringUtils.join(clusters, ","));
} else {
serviceInfo = hostReactor
.getServiceInfoDirectlyFromServer(NamingUtils.getGroupedName(serviceName, groupName),
StringUtils.join(clusters, ","));
}
List<Instance> list;
if (serviceInfo == null || CollectionUtils.isEmpty(list = serviceInfo.getHosts())) {
return new ArrayList<Instance>();
}
return list;
}
上面的代碼調(diào)用了hostReactor.getServiceInfo()方法，該方法會(huì)先調(diào)用getServiceInfo0()方法從本地緩存獲取數(shù)據(jù)，緩存沒(méi)有數(shù)據(jù)，就構(gòu)建實(shí)例更新到Nacos，并從Nacos中獲取最新數(shù)據(jù)，getServiceInfo0()方法源碼如下：
public ServiceInfo getServiceInfo(final String serviceName, final String clusters) {
NAMING_LOGGER.debug("failover-mode: " + failoverReactor.isFailoverSwitch());
String key = ServiceInfo.getKey(serviceName, clusters);
if (failoverReactor.isFailoverSwitch()) {
return failoverReactor.getService(key);
}
/*1。先從本地緩存中獲取服務(wù)對(duì)象，因?yàn)閱?dòng)是第一次進(jìn)來(lái)，所以緩存暫不存在*/
ServiceInfo serviceObj = getServiceInfo0(serviceName, clusters);
if (null == serviceObj) {
/*構(gòu)建服務(wù)實(shí)例*/
serviceObj = new ServiceInfo(serviceName, clusters);
/*將服務(wù)實(shí)例存放到緩存中*/
serviceInfoMap.put(serviceObj.getKey(), serviceObj);
/*更新nacos-上的服務(wù)*/
updatingMap.put(serviceName, new Object());
/*主動(dòng)獲取，并且更新到緩存本地，以及已過(guò)期的服務(wù)更新等*/
updateServiceNow(serviceName, clusters);
updatingMap.remove(serviceName);
} else if (updatingMap.containsKey(serviceName)) {
if (UPDATE_HOLD_INTERVAL > 0) {
// hold a moment waiting for update finish
synchronized (serviceObj) {
try {
serviceObj.wait(UPDATE_HOLD_INTERVAL);
} catch (InterruptedException e) {
NAMING_LOGGER
.error("[getServiceInfo] serviceName:" + serviceName + ", clusters:" + clusters, e);
}
}
}
}
/*2.開(kāi)啟定時(shí)任務(wù)*/
scheduleUpdateIfAbsent(serviceName, clusters);
return serviceInfoMap.get(serviceObj.getKey());
}
updateServiceNow(serviceName, clusters);主從從遠(yuǎn)程服務(wù)器獲取更新數(shù)據(jù)，最終會(huì)調(diào)用updateService()方法，在該方法中完成遠(yuǎn)程請(qǐng)求和數(shù)據(jù)處理，源碼如下：
public void updateService(String serviceName, String clusters) throws NacosException {
/*獲取本地緩存列表中所存在的服務(wù)*/
ServiceInfo oldService = getServiceInfo0(serviceName, clusters);
try {
/*獲取服務(wù)以及提供者端口信息，端口等*/
String result = serverProxy.queryList(serviceName, clusters, pushReceiver.getUdpPort(), false);
if (StringUtils.isNotEmpty(result)) {
/*對(duì)結(jié)果進(jìn)行處理*/
processServiceJson(result);
}
} finally {
if (oldService != null) {
synchronized (oldService) {
oldService.notifyAll();
}
}
}
}
服務(wù)下線
我們沿著案例中的服務(wù)下線方法調(diào)用找到nacos-api中的NamingService.deregisterInstance()并找到它的實(shí)現(xiàn)類和方法NacosNamingService.deregisterInstance()，代碼如下：
@Override
public void deregisterInstance(String serviceName, String groupName, String ip, int port, String clusterName)
throws NacosException {
//構(gòu)建實(shí)例信息
Instance instance = new Instance();
instance.setIp(ip);
instance.setPort(port);
instance.setClusterName(clusterName);
//服務(wù)下線操作
deregisterInstance(serviceName, groupName, instance);
}
@Override
public void deregisterInstance(String serviceName, String groupName, Instance instance) throws NacosException {
if (instance.isEphemeral()) {
//移除心跳信息監(jiān)測(cè)的定時(shí)任務(wù)
beatReactor.removeBeatInfo(NamingUtils.getGroupedName(serviceName, groupName), instance.getIp(),
instance.getPort());
}
//發(fā)送遠(yuǎn)程請(qǐng)求執(zhí)行服務(wù)下線銷毀操作
serverProxy.deregisterService(NamingUtils.getGroupedName(serviceName, groupName), instance);
}
服務(wù)下線方法比較簡(jiǎn)單，和服務(wù)注冊(cè)做的事情正好相反，也做了兩件事，第一件事：不在進(jìn)行心跳檢測(cè)。 第二件事：請(qǐng)求服務(wù)端服務(wù)下線接口。
服務(wù)訂閱
我們可以查看訂閱服務(wù)的案例，會(huì)先創(chuàng)建一個(gè)線程池，接下來(lái)會(huì)把線程池封裝到監(jiān)聽(tīng)器中，而監(jiān)聽(tīng)器中可以監(jiān)聽(tīng)指定實(shí)例信息，代碼如下：
//服務(wù)訂閱
Executor executor = new ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<Runnable>(),
new ThreadFactory() {
@Override
public Thread newThread(Runnable r) {
Thread thread = new Thread(r);
thread.setName("test-thread");
return thread;
}
});
naming.subscribe("nacos.test.3", new AbstractEventListener() {
//EventListener onEvent is sync to handle, If process too low in onEvent, maybe block other onEvent callback.
//So you can override getExecutor() to async handle event.
@Override
public Executor getExecutor() {
return executor;
}
//讀取監(jiān)聽(tīng)到的服務(wù)實(shí)例
@Override
public void onEvent(Event event) {
System.out.println(((NamingEvent) event).getServiceName());
System.out.println(((NamingEvent) event).getInstances());
}
});
我們沿著案例中的服務(wù)訂閱方法調(diào)用找到nacos-api中的NamingService.subscribe()并找到它的實(shí)現(xiàn)類和方法NacosNamingService.deregisterInstance()，代碼如下：
public void subscribe(String serviceName, String clusters, EventListener eventListener) {
//注冊(cè)監(jiān)聽(tīng)
notifier.registerListener(serviceName, clusters, eventListener);
//獲取并更新服務(wù)實(shí)例
getServiceInfo(serviceName, clusters);
}
此時(shí)會(huì)注冊(cè)監(jiān)聽(tīng)，注冊(cè)監(jiān)聽(tīng)，注冊(cè)監(jiān)聽(tīng)就是將當(dāng)前的監(jiān)聽(tīng)對(duì)象信息注入到listenerMap集合中，在監(jiān)聽(tīng)對(duì)象的指定方法onEvent中可以讀取實(shí)例信息，代碼如下：
public void registerListener(String serviceName, String clusters, EventListener listener) {
String key = ServiceInfo.getKey(serviceName, clusters);
ConcurrentHashSet<EventListener> eventListeners = listenerMap.get(key);
if (eventListeners == null) {
synchronized (lock) {
eventListeners = listenerMap.get(key);
if (eventListeners == null) {
eventListeners = new ConcurrentHashSet<EventListener>();
listenerMap.put(key, eventListeners);
}
}
}
//將當(dāng)前監(jiān)聽(tīng)對(duì)象放入到集合中，在監(jiān)聽(tīng)對(duì)象的onEvent中可以讀出對(duì)應(yīng)的實(shí)例對(duì)象
eventListeners.add(listener);
}