Eureka Server缓存机制

Eureka Server的缓存机制依赖于谷歌的gauva cache , 在Eureka中通过

com.netflix.eureka.registry.ResponseCacheImpl , 这个操作类来实现缓存的机制。

入口

启动eureka server进入到 org.springframework.cloud.netflix.eureka.server.EurekaServerAutoConfiguration

EurekaServerAutoConfiguration#eurekaServerContext

@Bean                                                                           
@ConditionalOnMissingBean                                                       
public EurekaServerContext eurekaServerContext(ServerCodecs serverCodecs,       
        PeerAwareInstanceRegistry registry, PeerEurekaNodes peerEurekaNodes) {  
    return new DefaultEurekaServerContext(this.eurekaServerConfig, serverCodecs,
            registry, peerEurekaNodes, this.applicationInfoManager);            
}                                                                               

中间步骤省略,debug打断点即可

ResponseCacheImpl(EurekaServerConfig serverConfig, ServerCodecs serverCodecs, AbstractInstanceRegistry registry) {                                                 
    this.serverConfig = serverConfig;                                                                                                                              
    this.serverCodecs = serverCodecs;      
    //是否使用只读缓存,默认true                                                                                                                        
    this.shouldUseReadOnlyResponseCache = serverConfig.shouldUseReadOnlyResponseCache();                                                                           
    this.registry = registry;                                                                                                                                      
    //缓存更新的时间间隔,默认为30秒                                                                                                                                
    long responseCacheUpdateIntervalMs = serverConfig.getResponseCacheUpdateIntervalMs();                                                                          
    this.readWriteCacheMap =                                                                                                                                       
            CacheBuilder.newBuilder().initialCapacity(serverConfig.getInitialCapacityOfResponseCache())   
                    //readWriteCacheMap黑夜过期时间为180秒                                                         
                    .expireAfterWrite(serverConfig.getResponseCacheAutoExpirationInSeconds(), TimeUnit.SECONDS)                                                    
                    .removalListener(new RemovalListener() {                                                                                           
                        @Override                                                                                                                                  
                        public void onRemoval(RemovalNotification notification) {                                                                      
                            Key removedKey = notification.getKey();                                                                                                
                            if (removedKey.hasRegions()) {                                                                                                         
                                Key cloneWithNoRegions = removedKey.cloneWithoutRegions();                                                                         
                                regionSpecificKeys.remove(cloneWithNoRegions, removedKey);                                                                         
                            }                                                                                                                                      
                        }                                                                                                                                          
                    }) 
                    //缓存加载器,当缓存不存在时,会自动执行load方法,进行缓存加载。同时返回缓存数据      
                    .build(new CacheLoader() {                                                                                                         
                        @Override                                                                                                                                  
                        public Value load(Key key) throws Exception {                                                                                              
                            if (key.hasRegions()) {                                                                                                                
                                Key cloneWithNoRegions = key.cloneWithoutRegions();                                                                                
                                regionSpecificKeys.put(cloneWithNoRegions, key);                                                                                   
                            }                                                                                                                                      
                            Value value = generatePayload(key);                                                                                                    
                            return value;                                                                                                                          
                        }                                                                                                                                          
                    });                                                                                                                                            
    // 是否使用只读缓存,如果使用,此处则启动一个定时器,用来复制readWriteCacheMap 的数据至readOnlyCacheMap                                                                                                                                                              
    if (shouldUseReadOnlyResponseCache) {                                                                                                                          
        timer.schedule(getCacheUpdateTask(),                                                                                                                       
                new Date(((System.currentTimeMillis() / responseCacheUpdateIntervalMs) * responseCacheUpdateIntervalMs)                                            
                        + responseCacheUpdateIntervalMs),  
                        //默认每30s从readWriteCacheMap更新,Eureka client默认从这里更新服务注册信息,可配置直接从readWriteCacheMap更新                                                                                                        
                responseCacheUpdateIntervalMs);                                                                                                                    
    }                                                                                                                                                              
                                                                                                                                                                   
    try {                                                                                                                                                          
        Monitors.registerObject(this);                                                                                                                             
    } catch (Throwable e) {                                                                                                                                        
        logger.warn("Cannot register the JMX monitor for the InstanceRegistry", e);                                                                                
    }                                                                                                                                                              
}                                                                                                                                                                  

通过上面可以很简单的看出, Eureka Server的缓存是通过一个只读缓存,一个读写缓存来实现的。

readWriteCacheMap: 此处存放的是最终的缓存, 当服务下线,过期,注册,状态变更,都会来清除这个缓存里面的数据。 然后通过CacheLoader进行缓存加载,在进行readWriteCacheMap.get(key)的时候,首先看这个缓存里面有没有该数据,如果没有则通过CacheLoader的load方法去加载,加载成功之后将数据放入缓存,同时返回数据

readOnlyCacheMap: 这是一个JVM的CurrentHashMap只读缓存,这个主要是为了供客户端获取注册信息时使用,其缓存更新,依赖于定时器的更新,通过和readWriteCacheMap 的值做对比,如果数据不一致,则以readWriteCacheMap 的数据为准。

CacheUpdateTask

readOnlyCacheMap 定时器的任务执行类。

private TimerTask getCacheUpdateTask() {                                                                                            
    return new TimerTask() {                                                                                                        
        @Override                                                                                                                   
        public void run() {                                                                                                         
            logger.debug("Updating the client cache from response cache");   
            //循环readOnlyCacheMap里面的KEY                                                       
            for (Key key : readOnlyCacheMap.keySet()) {                                                                             
                if (logger.isDebugEnabled()) {                                                                                      
                    logger.debug("Updating the client cache from response cache for key : {} {} {} {}",                             
                            key.getEntityType(), key.getName(), key.getVersion(), key.getType());                                   
                }                                                                                                                   
                try {     
                    //版本号                                                                                                          
                    CurrentRequestVersion.set(key.getVersion()); 
                    //从readWriteCacheMap获取数据                                                                   
                    Value cacheValue = readWriteCacheMap.get(key);  
                    //当前的只读数据                                                                
                    Value currentCacheValue = readOnlyCacheMap.get(key);                                                            
                    if (cacheValue != currentCacheValue) {   
                        //如果不一致,覆盖只读缓存里面的数据,以readWriteCacheMap为准                                                                       
                        readOnlyCacheMap.put(key, cacheValue);                                                                      
                    }                                                                                                               
                } catch (Throwable th) {                                                                                            
                    logger.error("Error while updating the client cache from response cache for key {}", key.toStringCompact(), th);
                } finally {                                                                                                         
                    CurrentRequestVersion.remove();                                                                                 
                }                                                                                                                   
            }                                                                                                                       
        }                                                                                                                           
    };                                                                                                                              
}                                                                                                                                   

invalidate缓存过期

这个方法,是在服务下线, 过期,注册,状态变更的时候会调用的,从上面可以看到,这里的缓存清除只是会去清除readWriteCacheMap这个缓存, readOnlyCacheMap 只读 缓存并没有更新,也就说当客户端的信息发生变化之后, 只读缓存不是第一时间感知到的。 只读缓存的更新只能依赖那个30秒的定时任务来更新。

public void invalidate(Key... keys) {
    // 循环传入的key一次调用API进行清除
    for (Key key : keys) {
        logger.debug("Invalidating the response cache key : {} {} {} {}, {}",
                key.getEntityType(), key.getName(), key.getVersion(), key.getType(), key.getEurekaAccept());
        // 清除缓存
        readWriteCacheMap.invalidate(key);
        Collection keysWithRegions = regionSpecificKeys.get(key);
        if (null != keysWithRegions && !keysWithRegions.isEmpty()) {
            for (Key keysWithRegion : keysWithRegions) {
                logger.debug("Invalidating the response cache key : {} {} {} {} {}",
                        key.getEntityType(), key.getName(), key.getVersion(), key.getType(), key.getEurekaAccept());
                readWriteCacheMap.invalidate(keysWithRegion);
            }
        }
    }
}
 @VisibleForTesting                                                      
String get(final Key key, boolean useReadOnlyCache) {                   
    Value payload = getValue(key, useReadOnlyCache);                    
    if (payload == null || payload.getPayload().equals(EMPTY_PAYLOAD)) {
        return null;                                                    
    } else {                                                            
        return payload.getPayload();                                    
    }                                                                   
}     

/**                                                                
 * Get the payload in both compressed and uncompressed form.       
 */                                                                
@VisibleForTesting                                                 
Value getValue(final Key key, boolean useReadOnlyCache) {          
    Value payload = null;                                          
    try {     
        //是否使用只读缓存                                                     
        if (useReadOnlyCache) {                                    
            final Value currentPayload = readOnlyCacheMap.get(key);
            if (currentPayload != null) {                          
                payload = currentPayload;                          
            } else { 
                //只读缓存里面没有,就到读写缓存里面去获取
                //同时将数据,放入只读缓存                                              
                payload = readWriteCacheMap.get(key);              
                readOnlyCacheMap.put(key, payload);                
            }                                                      
        } else {                                                   
            payload = readWriteCacheMap.get(key);                  
        }                                                          
    } catch (Throwable t) {                                        
        logger.error("Cannot get value for key : {}", key, t);     
    }                                                              
    return payload;                                                
}                                                                                                                                    

useReadOnlyCache: shouldUseReadOnlyResponseCache ,可以配置是否使用只读缓存,默认是true

readWriteCacheMap.get(key): 这个使用的是gauva 的缓存机制,如果当前的缓存里面这个key没有,那么

会直接调用CacheLoader.load()方法,从最上面的代码可以看到, load方法,主要是执行了generatePayload()

方法。

/*                                                                                                                  
 * Generate pay load for the given key.                                                                             
 */                                                                                                                 
private Value generatePayload(Key key) {                                                                            
    Stopwatch tracer = null;                                                                                        
    try {                                                                                                           
        String payload;                                                                                             
        switch (key.getEntityType()) {                                                                              
            case Application:                                                                                       
                boolean isRemoteRegionRequested = key.hasRegions();                                                 
                //全量获取                                                                                       
                if (ALL_APPS.equals(key.getName())) { 
                    //是否是分区域获取注册表信息                                                              
                    if (isRemoteRegionRequested) {                                                                  
                        tracer = serializeAllAppsWithRemoteRegionTimer.start();                                     
                        payload = getPayLoad(key, registry.getApplicationsFromMultipleRegions(key.getRegions()));   
                    } else {                                                                                        
                        tracer = serializeAllAppsTimer.start();
                        //调用registry.getApplications() 获取应用信息。同时调用getPayLoad进行编码                                                    
                        payload = getPayLoad(key, registry.getApplications());                                      
                    }   
                // 增量获取                                                                                            
                } else if (ALL_APPS_DELTA.equals(key.getName())) { 
                    //是否是分区域获取注册表信息                                                 
                    if (isRemoteRegionRequested) {                                                                  
                        tracer = serializeDeltaAppsWithRemoteRegionTimer.start();                                   
                        versionDeltaWithRegions.incrementAndGet();                                                  
                        versionDeltaWithRegionsLegacy.incrementAndGet();                                            
                        payload = getPayLoad(key,                                                                   
                                registry.getApplicationDeltasFromMultipleRegions(key.getRegions()));                
                    } else {                                                                                        
                        tracer = serializeDeltaAppsTimer.start();                                                   
                        versionDelta.incrementAndGet();                                                             
                        versionDeltaLegacy.incrementAndGet(); 
                        //调用registry.getApplicationDeltas() 获取增量注册信息                                                      
                        payload = getPayLoad(key, registry.getApplicationDeltas());                                 
                    }                                                                                               
                } else {  
                    // 根据key直接获取注册信息                                                                                          
                    tracer = serializeOneApptimer.start();                                                          
                    payload = getPayLoad(key, registry.getApplication(key.getName()));                              
                }                                                                                                   
                break;                                                                                              
            case VIP:                                                                                               
            case SVIP:                                                                                              
                tracer = serializeViptimer.start();                                                                 
                payload = getPayLoad(key, getApplicationsForVip(key, registry));                                    
                break;                                                                                              
            default:                                                                                                
                logger.error("Unidentified entity type: {} found in the cache key.", key.getEntityType());          
                payload = "";                                                                                       
                break;                                                                                              
        }                                                                                                           
        return new Value(payload);                                                                                  
    } finally {                                                                                                     
        if (tracer != null) {                                                                                       
            tracer.stop();                                                                                          
        }                                                                                                           
    }                                                                                                               
}                                                                                                                   

entityType : 分为三种,Application, VIP, SVIP , 客户端获取注册信息的话,传入的主要是Application类型的,另外两种类型此处不做考虑 。

参考

参考一

你可能感兴趣的:(Eureka Server缓存机制)