[iOS - swift] [오픈소스 까보기] SDWebImage - 메모리 캐싱, 디스크 캐싱 (NSCache, NSMapTable, fileManager, weakCache)

1. SDWebImage 오픈소스 까보기 - 캐싱 처리 로직

2. SDWebImage 오픈소스 까보기 - 메모리 캐싱, 디스크 캐싱 

SDWebImage 메모리 캐시

• SDMemoryCache.m 코드를 보면 SDMemoryCache를 선언해 놓았으며 이것은 NSCache 타입이므로 일반적으로 swift에서 메모리 캐싱을 사용하는 방법과 유사 (NSCache를 통해 메모리 캐싱하는 방법은 이전 포스팅 글 참고)

@interface SDMemoryCache <KeyType, ObjectType> () {
#if SD_UIKIT
    SD_LOCK_DECLARE(_weakCacheLock); // a lock to keep the access to `weakCache` thread-safe
#endif
}

...
@interface SDMemoryCache <KeyType, ObjectType> : NSCache <KeyType, ObjectType> <SDMemoryCache>

• 이 NSCache 타입의 SDMemoryCache 내부를 재정의하고 사용하는 상태이고, 여기에 더해서 NSMapTable을 통해 weakCache까지 사용

@property (nonatomic, strong, nonnull) NSMapTable<KeyType, ObjectType> *weakCache; // strong-weak cache

• NSCache에 있는 setObject, objectForKey를 재정의하여 안에서 weakCache를 사용

// `setObject:forKey:` just call this with 0 cost. Override this is enough
- (void)setObject:(id)obj forKey:(id)key cost:(NSUInteger)g {
    [super setObject:obj forKey:key cost:g];
    if (!self.config.shouldUseWeakMemoryCache) {
        return;
    }
    if (key && obj) {
        // Store weak cache
        SD_LOCK(_weakCacheLock);
        [self.weakCache setObject:obj forKey:key];
        SD_UNLOCK(_weakCacheLock);
    }
}

- (id)objectForKey:(id)key {
    id obj = [super objectForKey:key];
    if (!self.config.shouldUseWeakMemoryCache) {
        return obj;
    }
    if (key && !obj) {
        // Check weak cache
        SD_LOCK(_weakCacheLock);
        obj = [self.weakCache objectForKey:key];
        SD_UNLOCK(_weakCacheLock);
        if (obj) {
            // Sync cache
            NSUInteger cost = 0;
            if ([obj isKindOfClass:[UIImage class]]) {
                cost = [(UIImage *)obj sd_memoryCost];
            }
            [super setObject:obj forKey:key cost:cost];
        }
    }
    return obj;
}

• KVO를 사용하여 메모리 캐싱 정책이 변경될때마다 실시간으로 변경

#pragma mark - KVO

- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context {
    if (context == SDMemoryCacheContext) {
        if ([keyPath isEqualToString:NSStringFromSelector(@selector(maxMemoryCost))]) {
            self.totalCostLimit = self.config.maxMemoryCost;
        } else if ([keyPath isEqualToString:NSStringFromSelector(@selector(maxMemoryCount))]) {
            self.countLimit = self.config.maxMemoryCount;
        }
    } else {
        [super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
    }
}

@end

메모리 캐싱에서 NSMaptable을 별도로 사용하여 weakCache로 두는 이유?

• NSMapTable개념은 이전 포스팅 글 참고
• strong 참조가 아닌 weak 참조로 이미지를 메모리에 저장하여 메모리 관리를 더욱 효율적으로 할 수 있기 때문
• didReceiveMemoryWarning: NSCache 캐시를 제거하지만, weakCache에 저장된 이미지 데이터는 유지
  • weakCache는 NSCache안의 인스턴스가 아닌, 전역적으로 선언된 상태이므로 weakCache는 제거 안됨
  • 메모리 경고가 발생하면 NSCache는 날아가지만 weakCache에 남아 있으므로 원복이 쉽게 가능

- (void)didReceiveMemoryWarning:(NSNotification *)notification {
    // Only remove cache, but keep weak cache
    [super removeAllObjects];
}

디스크 캐싱

• SDDiskCache.m 파일
• NSFileManager을 사용하여 데이터 저장
• 디스크 캐싱은 memoryCache처럼 weakCache를 별도로 두지 않으며 fileManager하나로만 제어

@property (nonatomic, strong, nonnull) NSFileManager *fileManager;

...

- (void)setData:(NSData *)data forKey:(NSString *)key {
    NSParameterAssert(data);
    NSParameterAssert(key);
    
    // get cache Path for image key
    NSString *cachePathForKey = [self cachePathForKey:key];
    // transform to NSURL
    NSURL *fileURL = [NSURL fileURLWithPath:cachePathForKey isDirectory:NO];
    
    [data writeToURL:fileURL options:self.config.diskCacheWritingOptions error:nil];
}

* 참고

https://github.com/SDWebImage/SDWebImage/blob/c614dffdfd3097ebfb1055a37beee1883eb9f2de/SDWebImage/Core/SDImageCacheConfig.m#L11

https://github.com/onevcat/Kingfisher

https://github.com/SDWebImage/SDWebImage/tree/c614dffdfd3097ebfb1055a37beee1883eb9f2de