深入理解SpringCloud之Eureka注册过程分析

public class EurekaBootStrap implements ServletContextListener { 
 //...省略相关代码
/**
  * Initializes Eureka, including syncing up with other Eureka peers and publishing the registry.
  *
  * @see
  * javax.servlet.ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)
  */
 @Override
 public void contextInitialized(ServletContextEvent event) {
  try {
   initEurekaEnvironment();
   initEurekaServerContext();
   ServletContext sc = event.getServletContext();
   sc.setAttribute(EurekaServerContext.class.getName(), serverContext);
  } catch (Throwable e) {
   logger.error("Cannot bootstrap eureka server :", e);
   throw new RuntimeException("Cannot bootstrap eureka server :", e);
  }
 }
　　//省略相关代码.....
}

/**
  * init hook for server context. Override for custom logic.
  */
 protected void initEurekaServerContext() throws Exception {
　　　　// .....
  ApplicationInfoManager applicationInfoManager = null;

  if (eurekaClient == null) {
   EurekaInstanceConfig instanceConfig = isCloud(ConfigurationManager.getDeploymentContext())
     ? new CloudInstanceConfig()
     : new MyDataCenterInstanceConfig();
   
   applicationInfoManager = new ApplicationInfoManager(
     instanceConfig, new EurekaConfigBasedInstanceInfoProvider(instanceConfig).get());
   
   EurekaClientConfig eurekaClientConfig = new DefaultEurekaClientConfig();
   eurekaClient = new DiscoveryClient(applicationInfoManager, eurekaClientConfig);
  } else {
   applicationInfoManager = eurekaClient.getApplicationInfoManager();
  }

  PeerAwareInstanceRegistry registry;
  if (isAws(applicationInfoManager.getInfo())) {
   registry = new AwsInstanceRegistry(
     eurekaServerConfig,
     eurekaClient.getEurekaClientConfig(),
     serverCodecs,
     eurekaClient
   );
   awsBinder = new AwsBinderDelegate(eurekaServerConfig, eurekaClient.getEurekaClientConfig(), registry, applicationInfoManager);
   awsBinder.start();
  } else {
   registry = new PeerAwareInstanceRegistryImpl(
     eurekaServerConfig,
     eurekaClient.getEurekaClientConfig(),
     serverCodecs,
     eurekaClient
   );
  }

　　　　//....省略部分代码
 }

 /**
  * Registers the information about the {@link InstanceInfo} and replicates
  * this information to all peer eureka nodes. If this is replication event
  * from other replica nodes then it is not replicated.
  *
  * @param info
  *   the {@link InstanceInfo} to be registered and replicated.
  * @param isReplication
  *   true if this is a replication event from other replica nodes,
  *   false otherwise.
  */
 @Override
 public void register(final InstanceInfo info, final boolean isReplication) {
  int leaseDuration = Lease.DEFAULT_DURATION_IN_SECS;
  if (info.getLeaseInfo() != null && info.getLeaseInfo().getDurationInSecs() > 0) {
   leaseDuration = info.getLeaseInfo().getDurationInSecs();
  }
  super.register(info, leaseDuration, isReplication);
  replicateToPeers(Action.Register, info.getAppName(), info.getId(), info, null, isReplication);
 }

 /**
  * Registers a new instance with a given duration.
  *
  * @see com.netflix.eureka.lease.LeaseManager#register(java.lang.Object, int, boolean)
  */
 public void register(InstanceInfo registrant, int leaseDuration, boolean isReplication) {
try {
   read.lock();
   Map<String, Lease<InstanceInfo>> gMap = registry.get(registrant.getAppName());
   REGISTER.increment(isReplication);
   if (gMap == null) {
    final ConcurrentHashMap<String, Lease<InstanceInfo>> gNewMap = new ConcurrentHashMap<String, Lease<InstanceInfo>>();
    gMap = registry.putIfAbsent(registrant.getAppName(), gNewMap);
    if (gMap == null) {
     gMap = gNewMap;
    }
   }
   Lease<InstanceInfo> existingLease = gMap.get(registrant.getId());
   // Retain the last dirty timestamp without overwriting it, if there is already a lease
   if (existingLease != null && (existingLease.getHolder() != null)) {
    Long existingLastDirtyTimestamp = existingLease.getHolder().getLastDirtyTimestamp();
    Long registrationLastDirtyTimestamp = registrant.getLastDirtyTimestamp();
    logger.debug("Existing lease found (existing={}, provided={}", existingLastDirtyTimestamp, registrationLastDirtyTimestamp);

    // this is a > instead of a >= because if the timestamps are equal, we still take the remote transmitted
    // InstanceInfo instead of the server local copy.
    if (existingLastDirtyTimestamp > registrationLastDirtyTimestamp) {
     logger.warn("There is an existing lease and the existing lease's dirty timestamp {} is greater" +
       " than the one that is being registered {}", existingLastDirtyTimestamp, registrationLastDirtyTimestamp);
     logger.warn("Using the existing instanceInfo instead of the new instanceInfo as the registrant");
     registrant = existingLease.getHolder();
    }
   } else {
    // The lease does not exist and hence it is a new registration
    synchronized (lock) {
     if (this.expectedNumberOfRenewsPerMin > 0) {
      // Since the client wants to cancel it, reduce the threshold
      // (1
      // for 30 seconds, 2 for a minute)
      this.expectedNumberOfRenewsPerMin = this.expectedNumberOfRenewsPerMin + 2;
      this.numberOfRenewsPerMinThreshold =
        (int) (this.expectedNumberOfRenewsPerMin * serverConfig.getRenewalPercentThreshold());
     }
    }
    logger.debug("No previous lease information found; it is new registration");
   }
   Lease<InstanceInfo> lease = new Lease<InstanceInfo>(registrant, leaseDuration);
   if (existingLease != null) {
    lease.setServiceUpTimestamp(existingLease.getServiceUpTimestamp());
   }
   gMap.put(registrant.getId(), lease);
 
   //。。。省略部分代码
}

/*
 * Copyright 2012 Netflix, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.netflix.eureka.lease;

import com.netflix.eureka.registry.AbstractInstanceRegistry;

/**
 * Describes a time-based availability of a {@link T}. Purpose is to avoid
 * accumulation of instances in {@link AbstractInstanceRegistry} as result of ungraceful
 * shutdowns that is not uncommon in AWS environments.
 *
 * If a lease elapses without renewals, it will eventually expire consequently
 * marking the associated {@link T} for immediate eviction - this is similar to
 * an explicit cancellation except that there is no communication between the
 * {@link T} and {@link LeaseManager}.
 *
 * @author Karthik Ranganathan, Greg Kim
 */
public class Lease<T> {

 enum Action {
  Register, Cancel, Renew
 };

 public static final int DEFAULT_DURATION_IN_SECS = 90;

 private T holder;
 private long evictionTimestamp;
 private long registrationTimestamp;
 private long serviceUpTimestamp;
 // Make it volatile so that the expiration task would see this quicker
 private volatile long lastUpdateTimestamp;
 private long duration;

 public Lease(T r, int durationInSecs) {
  holder = r;
  registrationTimestamp = System.currentTimeMillis();
  lastUpdateTimestamp = registrationTimestamp;
  duration = (durationInSecs * 1000);

 }

 /**
  * Renew the lease, use renewal duration if it was specified by the
  * associated {@link T} during registration, otherwise default duration is
  * {@link #DEFAULT_DURATION_IN_SECS}.
  */
 public void renew() {
  lastUpdateTimestamp = System.currentTimeMillis() + duration;

 }

 /**
  * Cancels the lease by updating the eviction time.
  */
 public void cancel() {
  if (evictionTimestamp <= 0) {
   evictionTimestamp = System.currentTimeMillis();
  }
 }

 /**
  * Mark the service as up. This will only take affect the first time called,
  * subsequent calls will be ignored.
  */
 public void serviceUp() {
  if (serviceUpTimestamp == 0) {
   serviceUpTimestamp = System.currentTimeMillis();
  }
 }

 /**
  * Set the leases service UP timestamp.
  */
 public void setServiceUpTimestamp(long serviceUpTimestamp) {
  this.serviceUpTimestamp = serviceUpTimestamp;
 }

 /**
  * Checks if the lease of a given {@link com.netflix.appinfo.InstanceInfo} has expired or not.
  */
 public boolean isExpired() {
  return isExpired(0l);
 }

 /**
  * Checks if the lease of a given {@link com.netflix.appinfo.InstanceInfo} has expired or not.
  *
  * Note that due to renew() doing the 'wrong" thing and setting lastUpdateTimestamp to +duration more than
  * what it should be, the expiry will actually be 2 * duration. This is a minor bug and should only affect
  * instances that ungracefully shutdown. Due to possible wide ranging impact to existing usage, this will
  * not be fixed.
  *
  * @param additionalLeaseMs any additional lease time to add to the lease evaluation in ms.
  */
 public boolean isExpired(long additionalLeaseMs) {
  return (evictionTimestamp > 0 || System.currentTimeMillis() > (lastUpdateTimestamp + duration + additionalLeaseMs));
 }

 /**
  * Gets the milliseconds since epoch when the lease was registered.
  *
  * @return the milliseconds since epoch when the lease was registered.
  */
 public long getRegistrationTimestamp() {
  return registrationTimestamp;
 }

 /**
  * Gets the milliseconds since epoch when the lease was last renewed.
  * Note that the value returned here is actually not the last lease renewal time but the renewal + duration.
  *
  * @return the milliseconds since epoch when the lease was last renewed.
  */
 public long getLastRenewalTimestamp() {
  return lastUpdateTimestamp;
 }

 /**
  * Gets the milliseconds since epoch when the lease was evicted.
  *
  * @return the milliseconds since epoch when the lease was evicted.
  */
 public long getEvictionTimestamp() {
  return evictionTimestamp;
 }

 /**
  * Gets the milliseconds since epoch when the service for the lease was marked as up.
  *
  * @return the milliseconds since epoch when the service for the lease was marked as up.
  */
 public long getServiceUpTimestamp() {
  return serviceUpTimestamp;
 }

 /**
  * Returns the holder of the lease.
  */
 public T getHolder() {
  return holder;
 }

}

 @Inject
 DiscoveryClient(ApplicationInfoManager applicationInfoManager, EurekaClientConfig config, AbstractDiscoveryClientOptionalArgs args,
     Provider<BackupRegistry> backupRegistryProvider) {

//....省略部分代码

  if (!config.shouldRegisterWithEureka() && !config.shouldFetchRegistry()) {
   logger.info("Client configured to neither register nor query for data.");
   scheduler = null;
   heartbeatExecutor = null;
   cacheRefreshExecutor = null;
   eurekaTransport = null;
   instanceRegionChecker = new InstanceRegionChecker(new PropertyBasedAzToRegionMapper(config), clientConfig.getRegion());

   // This is a bit of hack to allow for existing code using DiscoveryManager.getInstance()
   // to work with DI'd DiscoveryClient
   DiscoveryManager.getInstance().setDiscoveryClient(this);
   DiscoveryManager.getInstance().setEurekaClientConfig(config);

   initTimestampMs = System.currentTimeMillis();
   logger.info("Discovery Client initialized at timestamp {} with initial instances count: {}",
     initTimestampMs, this.getApplications().size());

   return; // no need to setup up an network tasks and we are done
  }

 try {
   // default size of 2 - 1 each for heartbeat and cacheRefresh
   scheduler = Executors.newScheduledThreadPool(2,
     new ThreadFactoryBuilder()
       .setNameFormat("DiscoveryClient-%d")
       .setDaemon(true)
       .build());

   heartbeatExecutor = new ThreadPoolExecutor(
     1, clientConfig.getHeartbeatExecutorThreadPoolSize(), 0, TimeUnit.SECONDS,
     new SynchronousQueue<Runnable>(),
     new ThreadFactoryBuilder()
       .setNameFormat("DiscoveryClient-HeartbeatExecutor-%d")
       .setDaemon(true)
       .build()
   ); // use direct handoff

   cacheRefreshExecutor = new ThreadPoolExecutor(
     1, clientConfig.getCacheRefreshExecutorThreadPoolSize(), 0, TimeUnit.SECONDS,
     new SynchronousQueue<Runnable>(),
     new ThreadFactoryBuilder()
       .setNameFormat("DiscoveryClient-CacheRefreshExecutor-%d")
       .setDaemon(true)
       .build()
   ); // use direct handoff

   eurekaTransport = new EurekaTransport();
   scheduleServerEndpointTask(eurekaTransport, args);

  　　　　//....省略部分代码
  　　initScheduledTasks();
 

 //....
}

 // Heartbeat timer
   scheduler.schedule(
     new TimedSupervisorTask(
       "heartbeat",
       scheduler,
       heartbeatExecutor,
       renewalIntervalInSecs,
       TimeUnit.SECONDS,
       expBackOffBound,
       new HeartbeatThread()
     ),
     renewalIntervalInSecs, TimeUnit.SECONDS);

 /**
  * The heartbeat task that renews the lease in the given intervals.
  */
 private class HeartbeatThread implements Runnable {

  public void run() {
   if (renew()) {
    lastSuccessfulHeartbeatTimestamp = System.currentTimeMillis();
   }
  }
 }

 /**
  * Renew with the eureka service by making the appropriate REST call
  */
 boolean renew() {
  EurekaHttpResponse<InstanceInfo> httpResponse;
  try {
   httpResponse = eurekaTransport.registrationClient.sendHeartBeat(instanceInfo.getAppName(), instanceInfo.getId(), instanceInfo, null);
   logger.debug("{} - Heartbeat status: {}", PREFIX + appPathIdentifier, httpResponse.getStatusCode());
   if (httpResponse.getStatusCode() == 404) {
    REREGISTER_COUNTER.increment();
    logger.info("{} - Re-registering apps/{}", PREFIX + appPathIdentifier, instanceInfo.getAppName());
    long timestamp = instanceInfo.setIsDirtyWithTime();
    boolean success = register();
    if (success) {
     instanceInfo.unsetIsDirty(timestamp);
    }
    return success;
   }
   return httpResponse.getStatusCode() == 200;
  } catch (Throwable e) {
   logger.error("{} - was unable to send heartbeat!", PREFIX + appPathIdentifier, e);
   return false;
  }
 }

 /**
  * Register with the eureka service by making the appropriate REST call.
  */
 boolean register() throws Throwable {
  logger.info(PREFIX + appPathIdentifier + ": registering service...");
  EurekaHttpResponse<Void> httpResponse;
  try {
   httpResponse = eurekaTransport.registrationClient.register(instanceInfo);
  } catch (Exception e) {
   logger.warn("{} - registration failed {}", PREFIX + appPathIdentifier, e.getMessage(), e);
   throw e;
  }
  if (logger.isInfoEnabled()) {
   logger.info("{} - registration status: {}", PREFIX + appPathIdentifier, httpResponse.getStatusCode());
  }
  return httpResponse.getStatusCode() == 204;
 }

private static final class EurekaTransport {
  private ClosableResolver bootstrapResolver;
  private TransportClientFactory transportClientFactory;

  private EurekaHttpClient registrationClient;
  private EurekaHttpClientFactory registrationClientFactory;

  private EurekaHttpClient queryClient;
  private EurekaHttpClientFactory queryClientFactory;

  void shutdown() {
   if (registrationClientFactory != null) {
    registrationClientFactory.shutdown();
   }

   if (queryClientFactory != null) {
    queryClientFactory.shutdown();
   }

   if (registrationClient != null) {
    registrationClient.shutdown();
   }

   if (queryClient != null) {
    queryClient.shutdown();
   }

   if (transportClientFactory != null) {
    transportClientFactory.shutdown();
   }

   if (bootstrapResolver != null) {
    bootstrapResolver.shutdown();
   }
  }
 }

 /**
  * Registers information about a particular instance for an
  * {@link com.netflix.discovery.shared.Application}.
  *
  * @param info
  *   {@link InstanceInfo} information of the instance.
  * @param isReplication
  *   a header parameter containing information whether this is
  *   replicated from other nodes.
  */
 @POST
 @Consumes({"application/json", "application/xml"})
 public Response addInstance(InstanceInfo info,
        @HeaderParam(PeerEurekaNode.HEADER_REPLICATION) String isReplication) {
  logger.debug("Registering instance {} (replication={})", info.getId(), isReplication);
  // validate that the instanceinfo contains all the necessary required fields
  if (isBlank(info.getId())) {
   return Response.status(400).entity("Missing instanceId").build();
  } else if (isBlank(info.getHostName())) {
   return Response.status(400).entity("Missing hostname").build();
  } else if (isBlank(info.getIPAddr())) {
   return Response.status(400).entity("Missing ip address").build();
  } else if (isBlank(info.getAppName())) {
   return Response.status(400).entity("Missing appName").build();
  } else if (!appName.equals(info.getAppName())) {
   return Response.status(400).entity("Mismatched appName, expecting " + appName + " but was " + info.getAppName()).build();
  } else if (info.getDataCenterInfo() == null) {
   return Response.status(400).entity("Missing dataCenterInfo").build();
  } else if (info.getDataCenterInfo().getName() == null) {
   return Response.status(400).entity("Missing dataCenterInfo Name").build();
  }

  // handle cases where clients may be registering with bad DataCenterInfo with missing data
  DataCenterInfo dataCenterInfo = info.getDataCenterInfo();
  if (dataCenterInfo instanceof UniqueIdentifier) {
   String dataCenterInfoId = ((UniqueIdentifier) dataCenterInfo).getId();
   if (isBlank(dataCenterInfoId)) {
    boolean experimental = "true".equalsIgnoreCase(serverConfig.getExperimental("registration.validation.dataCenterInfoId"));
    if (experimental) {
     String entity = "DataCenterInfo of type " + dataCenterInfo.getClass() + " must contain a valid id";
     return Response.status(400).entity(entity).build();
    } else if (dataCenterInfo instanceof AmazonInfo) {
     AmazonInfo amazonInfo = (AmazonInfo) dataCenterInfo;
     String effectiveId = amazonInfo.get(AmazonInfo.MetaDataKey.instanceId);
     if (effectiveId == null) {
      amazonInfo.getMetadata().put(AmazonInfo.MetaDataKey.instanceId.getName(), info.getId());
     }
    } else {
     logger.warn("Registering DataCenterInfo of type {} without an appropriate id", dataCenterInfo.getClass());
    }
   }
  }

  registry.register(info, "true".equals(isReplication));
  return Response.status(204).build(); // 204 to be backwards compatible
 }