Nacos注册中心源码分析一

Nacos核心功能点

服务注册:Nacos客户端会通过发送REST请求的方式向Nacos服务端注册自己的服务,发布元数据,比如ip地址、端口等信息。Nacos服务端接收到注册请求后,就会把这些元数据信息存储在一个双层的内存Map中。

服务心跳:在服务注册后,Nacos客户端会维护一个定时心跳来持续通知Nacos服务端,说明服务一直处于可用状态,防止被剔除。默认5s发送一次心跳。

服务健康检查:Nacos服务端会开启一个定时任务用来检查注册服务实例的健康情况,对于超过15s没有收到客户端心跳的实例会将它的healthy属性置为false(客户端服务发现时不会发现),如果某个实例超过30秒没有收到心跳,直接剔除该实例(被剔除的实例如果恢复发送心跳则会重新注册)

服务发现:服务消费者在调用服务提供者的服务时,会发送一个REST请求给Nacos服务端,获取上面注册的服务清单,并且缓存在Nacos客户端本地,同时会在Nacos客户端本地开启一个定时任务定时拉取服务端最新的注册表信息更新到本地缓存

服务同步:Nacos服务端集群之间会互相同步服务实例,用来保证服务信息的一致性。

源码入口

熟悉SpringBoot源码的同学们应该知道,SpringBoot启动的时候会自动去找jar包下面的Spring.factories里面的配置并且自动装配成Bean,而Nacos也是借助SpringBoot的自动装配机制完成核心功能,找到spring-cloud-alibaba-nacos-discovery.jar里面的spring.factories文件里的EnableAutoConfiguration对应的NacosDiscoveryAutoConfiguration这个类

在这个类里面会初始化一个叫NacosAutoServiceRegistration的类,而这个NacosAutoServiceRegistration类继承了AbstractAutoServiceRegistration类,然后父类AbstractAutoServiceRegistration实现了ApplicationListener

看过spring源码的应该很熟悉这个类了,实现了这个ApplicationListener这个类,spring容器启动后会回调里面onApplicationEvent

方法,在父类这个方法里面有一个bind(event)方法,跟进去

@Deprecated
public void bind(WebServerInitializedEvent event) {
   ApplicationContext context = event.getApplicationContext();
   if (context instanceof ConfigurableWebServerApplicationContext) {
      if ("management".equals(((ConfigurableWebServerApplicationContext) context)
            .getServerNamespace())) {
         return;
      }
   }
   this.port.compareAndSet(0, event.getWebServer().getPort());
   this.start();
}

里面调用了一个start()方法

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

   // only initialize if nonSecurePort is greater than 0 and it isn't already running
   // because of containerPortInitializer below
   if (!this.running.get()) {
      this.context.publishEvent(
            new InstancePreRegisteredEvent(this, getRegistration()));
      register();
      if (shouldRegisterManagement()) {
         registerManagement();
      }
      this.context.publishEvent(
            new InstanceRegisteredEvent<>(this, getConfiguration()));
      this.running.compareAndSet(false, true);
   }

}

在start方法里面有一个关键的代码,register()方法,跟进源码最后会调用到

@Override
public void register(Registration registration) {

   if (StringUtils.isEmpty(registration.getServiceId())) {
      log.warn("No service to register for nacos client...");
      return;
   }

   String serviceId = registration.getServiceId();
   String group = nacosDiscoveryProperties.getGroup();

   Instance instance = getNacosInstanceFromRegistration(registration);

   try {
      namingService.registerInstance(serviceId, group, instance);
      log.info("nacos registry, {} {} {}:{} register finished", group, serviceId,
            instance.getIp(), instance.getPort());
   }
   catch (Exception e) {
      log.error("nacos registry, {} register failed...{},", serviceId,
            registration.toString(), e);
   }
}

里面又调用了namingService.registerInstance(serviceId, group, instance);继续跟进源码

@Override
public void registerInstance(String serviceName, String groupName, Instance instance) throws NacosException {

    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);
        long instanceInterval = instance.getInstanceHeartBeatInterval();
        beatInfo.setPeriod(instanceInterval == 0 ? DEFAULT_HEART_BEAT_INTERVAL : instanceInterval);

        beatReactor.addBeatInfo(NamingUtils.getGroupedName(serviceName, groupName), beatInfo);
    }

    serverProxy.registerService(NamingUtils.getGroupedName(serviceName, groupName), groupName, instance);
}

在这个方法里面有两个核心的操作,一个发送心跳,一个是客户端注册服务。我们今天只看这个注册服务的主线,发送心跳暂时跳过,后面会详细讲,

serverProxy.registerService(NamingUtils.getGroupedName(serviceName, groupName), groupName, instance);

继续跟进这个主线逻辑里面的代码

首先会封装一些请求的参数信息,然后调用reqAPI方法,最终会调用httpclient发送http请求向服务端注册服务

到这里客户端是如何注册服务到注册中心的完整流程已经结束,下节内容一起来学习服务端是如何将客户端注册的服务存储的

Nacos 注册服务源码涉及的主要类有以下几个: 1. NamingService:命名服务接口,定义了注册、注销、查询服务的方法。 2. NamingServiceImpl:命名服务的实现类,实现了 NamingService 接口。 3. ServerListManager:服务列表管理器,负责管理服务列表。 4. Instance:服务实例对象,包含了服务实例的基本信息。 5. Service:服务对象,包含了服务的基本信息和服务实例列表。 6. ServiceInfo:服务信息对象,包含了所有服务和服务实例的信息。 7. ServerProxy:服务代理类,负责与服务注册中心通信。 下面对这些类进行详细的分析。 1. NamingService 命名服务接口,定义了注册、注销、查询服务的方法。 ```java public interface NamingService { /** * 注册一个服务实例 */ void registerInstance(String serviceName, Instance instance) throws NacosException; /** * 注销一个服务实例 */ void deregisterInstance(String serviceName, Instance instance) throws NacosException; /** * 查询一个服务的所有实例 */ List<Instance> getAllInstances(String serviceName) throws NacosException; /** * 监听一个服务的实例变化 */ void subscribe(String serviceName, EventListener listener) throws NacosException; /** * 取消监听一个服务的实例变化 */ void unsubscribe(String serviceName, EventListener listener) throws NacosException; } ``` 2. NamingServiceImpl 命名服务的实现类,实现了 NamingService 接口。 ```java public class NamingServiceImpl implements NamingService { private ServerProxy serverProxy; public NamingServiceImpl(ServerProxy serverProxy) { this.serverProxy = serverProxy; } @Override public void registerInstance(String serviceName, Instance instance) throws NacosException { serverProxy.registerService(serviceName, instance); } @Override public void deregisterInstance(String serviceName, Instance instance) throws NacosException { serverProxy.deregisterService(serviceName, instance); } @Override public List<Instance> getAllInstances(String serviceName) throws NacosException { return serverProxy.getAllInstances(serviceName); } @Override public void subscribe(String serviceName, EventListener listener) throws NacosException { serverProxy.subscribe(serviceName, listener); } @Override public void unsubscribe(String serviceName, EventListener listener) throws NacosException { serverProxy.unsubscribe(serviceName, listener); } } ``` 3. ServerListManager 服务列表管理器,负责管理服务列表。 ```java public class ServerListManager { private DiscoveryConfig config; private List<ServerInfo> serverList = new ArrayList<>(); private AtomicInteger index = new AtomicInteger(0); public ServerListManager(DiscoveryConfig config) { this.config = config; initServerList(); } private void initServerList() { // 读取配置文件中的服务地址列表 String serverListStr = config.getServerList(); String[] serverArr = serverListStr.split(","); for (int i = 0; i < serverArr.length; i++) { String[] serverInfoArr = serverArr[i].split(":"); String ip = serverInfoArr[0]; int port = Integer.parseInt(serverInfoArr[1]); ServerInfo serverInfo = new ServerInfo(ip, port); serverList.add(serverInfo); } } public ServerInfo getNextServer() { // 轮询获取服务地址 int i = index.getAndIncrement() % serverList.size(); return serverList.get(i); } } ``` 4. Instance 服务实例对象,包含了服务实例的基本信息。 ```java public class Instance { private String serviceName; private String ip; private int port; public Instance(String serviceName, String ip, int port) { this.serviceName = serviceName; this.ip = ip; this.port = port; } public String getServiceName() { return serviceName; } public void setServiceName(String serviceName) { this.serviceName = serviceName; } public String getIp() { return ip; } public void setIp(String ip) { this.ip = ip; } public int getPort() { return port; } public void setPort(int port) { this.port = port; } } ``` 5. Service 服务对象,包含了服务的基本信息和服务实例列表。 ```java public class Service { private String name; private List<Instance> instances = new ArrayList<>(); public Service(String name) { this.name = name; } public String getName() { return name; } public List<Instance> getInstances() { return instances; } public void addInstance(Instance instance) { instances.add(instance); } public void removeInstance(Instance instance) { instances.remove(instance); } } ``` 6. ServiceInfo 服务信息对象,包含了所有服务和服务实例的信息。 ```java public class ServiceInfo { private Map<String, Service> serviceMap = new HashMap<>(); public void addService(Service service) { serviceMap.put(service.getName(), service); } public void removeService(Service service) { serviceMap.remove(service.getName()); } public List<Service> getServices() { return new ArrayList<>(serviceMap.values()); } } ``` 7. ServerProxy 服务代理类,负责与服务注册中心通信。 ```java public class ServerProxy { private ServerListManager serverListManager; public ServerProxy(ServerListManager serverListManager) { this.serverListManager = serverListManager; } public void registerService(String serviceName, Instance instance) throws NacosException { ServerInfo serverInfo = serverListManager.getNextServer(); try (Socket socket = new Socket(serverInfo.getIp(), serverInfo.getPort())) { // 向注册中心发送注册请求 // ... } catch (IOException e) { // 处理异常 } } public void deregisterService(String serviceName, Instance instance) throws NacosException { // 向注册中心发送注销请求 // ... } public List<Instance> getAllInstances(String serviceName) throws NacosException { // 从注册中心获取服务实例列表 // ... return instances; } public void subscribe(String serviceName, EventListener listener) throws NacosException { // 向注册中心发送订阅请求 // ... } public void unsubscribe(String serviceName, EventListener listener) throws NacosException { // 向注册中心发送取消订阅请求 // ... } } ``` 以上就是 Nacos 注册服务源码分析的内容。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值