微服务系列（二）(5) Nacos源码分析

微服务系列（二）(5) Nacos源码分析

Nacos (official site: http://nacos.io) is an easy-to-use platform designed for dynamic service discovery and configuration and service management. It helps you to build cloud native applications and microservices platform easily.

Service is a first-class citizen in Nacos. Nacos supports almost all type of services，for example，Dubbo/gRPC service、Spring Cloud RESTFul service or Kubernetes service.

这里引用官网的一段介绍，Nacos作为阿里开源的微服务组件，相对于Spring Cloud生态的Eureka又有哪些不同呢？下面就针对通信原理、存储机制和集群模式三个核心要点来深入Nacos源码。

首先看看官网提供的架构图

可以看到，nacos内部提供了Config Service和Naming Service，底层由Nacos Core支持，外层提供OpenAPI供使用，并提供了User Console、Admin Console方便用户使用。

从github上clone代码：https://github.com/alibaba/nacos

从架构图上可以知道，Nacos提供了两种服务，一种是用于服务注册、发现的Naming Service，一种是用于配置中心、动态配置的Config Service，而他们底层均由core模块来支持。

这次源码分析的目的是为了探究其注册中心的实现，所以会通过core模块-naming模块来跟踪源码。

没有尝试过Nacos的小伙伴，或许可以先了解如何使用Nacos：https://nacos.io/en-us/docs/quick-start.html

从OpenAPI可以了解到，Nacos通过提供一系列的http接口来提供Naming服务和Config服务：

服务注册URI：/nacos/v1/ns/instance POST

服务取消注册URI：/nacos/v1/ns/instance DELETE

心跳检测URI：/nacos/v1/ns/instance/beat PUT

… …

可以看到其遵循了REST API的风格。

并且我们可以直观的认识到，Nacos通过http这样无状态的协议来进行client-server端的通信。

那么差不多可以开始进入源码分析的部分了，先了解一下core模块，或许和我们想象的不太一样…

作为Config Service和Naming Service的公共支持组件，core仅仅提供了一些工具类以及使用spring boot starter的方式将nacos配置文件加载到Environment。

这里先重点看一个后面会经常打交道的类

com.alibaba.nacos.core.utils.WebUtils

它提供了

com.alibaba.nacos.core.utils.WebUtils#required：通过参数名key，解析HttpServletRequest请求中的参数，并转码为UTF-8编码。

com.alibaba.nacos.core.utils.WebUtils#optional：在required方法的基础上增加了默认值，如果获取不到，则返回默认值。

好吧，没想到core模块的部分这么少，进入naming模块。

还记得Nacos的OpenAPI吗，使用了http协议来交互，那么在server端必定提供了http接口的入口，并且刚才在core模块看到其依赖了spring boot starter，一个合理的猜想是：其http接口由集成了Spring的web服务器支持，简单地说就是像我们平时写的业务服务一样，有controller层和service层。

以OpenAPI作为入口来学习，找到/nacos/v1/ns/instance服务注册接口：

com.alibaba.nacos.naming.controllers.InstanceController

@RequestMapping(value = "/instance", method = RequestMethod.POST)
public String register(HttpServletRequest request) throws Exception {
   

    OverrideParameterRequestWrapper requestWrapper = OverrideParameterRequestWrapper.buildRequest(request);

    String serviceJson = WebUtils.optional(request, "service", StringUtils.EMPTY);

    // set service info:
    if (StringUtils.isNotEmpty(serviceJson)) {
   
        JSONObject service = JSON.parseObject(serviceJson);
        requestWrapper.addParameter("serviceName", service.getString("name"));
    }

    return regService(requestWrapper);
}

熟悉的com.alibaba.nacos.core.utils.WebUtils#optional

可以看到在controller层只是将请求参数解析出来，封装成requestWrapper后交给下层的服务来处理

public String regService(HttpServletRequest request) throws Exception {
   

    String dom = WebUtils.required(request, "serviceName");
    String tenant = WebUtils.optional(request, "tid", StringUtils.EMPTY);
    String app = WebUtils.optional(request, "app", "DEFAULT");
    String env = WebUtils.optional(request, "env", StringUtils.EMPTY);
    String metadata = WebUtils.optional(request, "metadata", StringUtils.EMPTY);
    String namespaceId = WebUtils.optional(request, Constants.REQUEST_PARAM_NAMESPACE_ID, UtilsAndCommons.getDefaultNamespaceId());

    VirtualClusterDomain virtualClusterDomain = (VirtualClusterDomain) domainsManager.getDomain(namespaceId, dom);

    IpAddress ipAddress = getIPAddress(request);
    ipAddress.setApp(app);
    ipAddress.setServiceName(dom);
    ipAddress.setInstanceId(ipAddress.generateInstanceId());
    ipAddress.setLastBeat(System.currentTimeMillis());