Nacos的服务注册之客户端

news2024/12/24 22:13:34

服务注册到Nacos以后,会保存在一个本地注册表中,这个注册表是一个map.
private Map<String, Map<String, Service>> serviceMap = new ConcurrentHashMap<>();

key是namespace,用来隔离环境
value又是一个map
key是group
value又是一个service
service中又维护了一个map
key是服务的某个集群的名称
value是Cluster类型
Cluster内部又维护了一个set< Instance >集合,该集合就是集群下的实例的集合
Instance:包含石榴的IP、Port、健康状态、权重等信息
每一服务注册到Nacos时,就会把信息组织并存入这个Map中.

服务注册接口

nacos提供了服务注册的API接口,客户端只需要向该接口发送请求,即可实现服务注册.
请求接口: /nacos/v1/ns/instance

客户端

首先我们需要找到服务注册的入口.

NacosServiceRegistryAutoConfiguration
因为Nacos的客户端是基于SpringBoot的自动装配实现的,我们可以在nacos-discovery依赖:
spring-cloud-starter-alibaba-nacos-discovery-2.2.3.RELEASE.jar
在这里插入图片描述
可以看到,很多配置个配置类被夹在了,其中跟服务注册有关的就是NacosServiceRegistryAutoConfiguration

NacosAutoServiceRegistration
看看他构造器:

可以看到AbstractAutoServiceRegistration也被初始化了

从实现关系上,可以看到其实AbstractAutoServiceRegistration是一个监听器,监听的事件是WebServerInitializedEvent(服务初始化完成),当监听到该事件之后,就会执行对应的bind方法.

    public void bind(WebServerInitializedEvent event) {
    	// 获取上下文
        ApplicationContext context = event.getApplicationContext();
        // // 判断服务的 namespace,一般都是null
        if (!(context instanceof ConfigurableWebServerApplicationContext) || !"management".equals(((ConfigurableWebServerApplicationContext)context).getServerNamespace())) {
        	// 记录当前 web 服务的端口
            this.port.compareAndSet(0, event.getWebServer().getPort());
            // 启动当前服务注册流程
            this.start();
        }
    }

我们来看他的start方法:

    public void start() {
        if (!this.isEnabled()) {
            if (logger.isDebugEnabled()) {
                logger.debug("Discovery Lifecycle disabled. Not starting");
            }

        } else {
        	// 当前服务处于未运行状态时,才进行初始化
            if (!this.running.get()) {
            	// 发布服务开始注册的事件
                this.context.publishEvent(new InstancePreRegisteredEvent(this, this.getRegistration()));
                // 开始注册
                this.register();
                if (this.shouldRegisterManagement()) {
                    this.registerManagement();
                }
				// 发布注册完成事件
                this.context.publishEvent(new InstanceRegisteredEvent(this, this.getConfiguration()));
                // 服务状态设置为运行中,基于AtomicBoolean
                this.running.compareAndSet(false, true);
            }

        }
    }

这里最关键的就是this.register();方法.

    protected void register() {
        this.serviceRegistry.register(this.getRegistration());
    }

从源码中,我们可以看到serviceRegistry的实现类NacosServiceRegistry
NacosServiceRegistry
ServiceRegistry接口是服务注册、发现的规约接口，定义了register、deregister等方法的声明。

    public void register(Registration registration) {
    	// 判断serviceId是否为空,也就是spring.application.name不能为空
        if (StringUtils.isEmpty(registration.getServiceId())) {
            log.warn("No service to register for nacos client...");
        } else {
        	// 获取 serviceId 和 Group
            String serviceId = registration.getServiceId();
            String group = this.nacosDiscoveryProperties.getGroup();
            // 封装服务实例的基本信息,如cluster-name、是否为临时实例、权重、IP、端口号等
            Instance instance = this.getNacosInstanceFromRegistration(registration);

            try {
            	// namingService:Nacos的命名服务,就是注册中心服务
            	// 开始注册服务
                this.namingService.registerInstance(serviceId, group, instance);
                log.info("nacos registry, {} {} {}:{} register finished", new Object[]{group, serviceId, instance.getIp(), instance.getPort()});
            } catch (Exception var6) {
                log.error("nacos registry, {} register failed...{},", new Object[]{serviceId, registration.toString(), var6});
            }

        }
    }

其中namingService的registerInstance方法真正进行注册

    public void registerInstance(String serviceName, String groupName, Instance instance) throws NacosException {
		// 是否是临时实例,如果是的话,需要 定时发送心跳
		// 默认是true
        if (instance.isEphemeral()) {
            BeatInfo beatInfo = new BeatInfo();
            beatInfo.setServiceName(NamingUtils.getGroupedName(serviceName, groupName));
            beatInfo.setIp(instance.getIp());
            beatInfo.setPort(instance.getPort());
            beatInfo.setCluster(instance.getClusterName());
            beatInfo.setWeight(instance.getWeight());
            beatInfo.setMetadata(instance.getMetadata());
            beatInfo.setScheduled(false);
            beatInfo.setPeriod(instance.getInstanceHeartBeatInterval());

            // 发送心跳到 Nacos 服务
            beatReactor.addBeatInfo(NamingUtils.getGroupedName(serviceName, groupName), beatInfo);
        }
		// 拼接得到新的服务名，格式为：groupName@@serviceId
		// 发送注册服务实例的请求
        serverProxy.registerService(NamingUtils.getGroupedName(serviceName, groupName), groupName, instance);
    }

我们接着看serverProxy里的registerService方法

    public void registerService(String serviceName, String groupName, Instance instance) throws NacosException {

        NAMING_LOGGER.info("[REGISTER-SERVICE] {} registering service {} with instance: {}",
            namespaceId, serviceName, instance);

		// 组织参数
        final Map<String, String> params = new HashMap<String, String>(9);
        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", JSON.toJSONString(instance.getMetadata()));
		
		// 请求api
        reqAPI(UtilAndComs.NACOS_URL_INSTANCE, params, HttpMethod.POST);

    }