weex的数据缓存模块之storage实现源码阅读

本文假设你对weex有基本的了解！（本文的目的是讲解iOS的一种缓存方案实现，weex的部分不懂并无大碍。如果不关心，可以直接从iOS实现的部分开始阅读）

weex Module的简单介绍

言归正题，先从官方文档了解Storage的使用方式。
我们发现，客户端主要提供了4个API：

• setItem(key, value, callback)
• getItem(key, callback)
• removeItem(key, callback)
• length(callback)

下面，我们逐一分析他们的具体实现。

Storage 实现

1. 存储数据

先上代码：

- (void)setObject:(NSString *)obj forKey:(NSString *)key persistent:(BOOL)persistent callback:(WXModuleCallback)callback {
    NSString *filePath = [WXStorageModule filePathForKey:key];
    if (obj.length <= WXStorageLineLimit) {
        if ([WXStorageNullValue isEqualToString:self.memory[key]]) {
            [[WXUtility globalCache] removeObjectForKey:key];
            [[NSFileManager defaultManager] removeItemAtPath:filePath error:nil];
        }
        self.memory[key] = obj;
        NSDictionary *dict = [self.memory copy];
        [self write:dict toFilePath:[WXStorageModule filePath]];
        [self setInfo:@{@"persistent":@(persistent),@"size":@(obj.length)} ForKey:key];
        [self updateIndexForKey:key];
        [self checkStorageLimit];
        if (callback) {
            callback(@{@"result":@"success"});
        }
        return;
    }
    
    [[WXUtility globalCache] setObject:obj forKey:key cost:obj.length];
    
    if (![WXStorageNullValue isEqualToString:self.memory[key]]) {
        self.memory[key] = WXStorageNullValue;
        NSDictionary *dict = [self.memory copy];
        [self write:dict toFilePath:[WXStorageModule filePath]];
    }
    
    dispatch_async([WXStorageModule storageQueue], ^{
        [obj writeToFile:filePath atomically:YES encoding:NSUTF8StringEncoding error:NULL];
    });
    
    [self setInfo:@{@"persistent":@(persistent),@"size":@(obj.length)} ForKey:key];
    [self updateIndexForKey:key];
    
    [self checkStorageLimit];
    if (callback) {
        callback(@{@"result":@"success"});
    }
}

代码解析：

• 首先，在这个方法之前，检验了key的类型。只能是NSString或NSNumber，且不能为空，并去除了空格和回车字符。
• 其次，根据key的name在沙盒的~/Document目录下生成一个wxStorage目录。文件名是name的MD5值。wxStorage目录下存放数据内容时会生成3个文件，分别是：wxStorage.plist，wxStorage.info.plist，wxStorage.index.plist。第一个存放数据键值对；第二个存放数据的额外信息，如存放时间、数据长度、索引信息等；第三个存放key值，用于遍历。
• 如果data的内容length小于Limit(weex指定为1024byte)，则将该key/value直接写入memory字典。memory是weex自身实现的一个线程安全型的字典。随后，方法会依次把数据写入上一步所说的3个plist文件中。检查storage是否超出Limit限制。如果是，则删除部分内容。
• 如果data的内容length大于Limit，先将该key/value存放于globalCache中。这是一个基于NSCache实现的全局缓存，目的是为了数据能在内存中存储，被高效地使用。存储的步骤和上面的“小数据”一样。不同的是，大数据不是直接存放在plist中。plist中存放了一个假数据，并和之前一样同步的被写入plist文件。而真数据是额外开了一个队列，异步写入的。filePath即是当前目录，文件名为key的MD5值。

总结一下：数据先是存放在了一个线程安全的字典中；以1024byte为分界线，如果是“小数据”，则同步写入一个管理文件；如果是“大数据”，则异步写入文件，每个数据单独存放为一个文件。

2. 获取数据

- (void)getItem:(NSString *)key callback:(WXModuleCallback)callback
{
    if ([self checkInput:key]) {
        if (callback) {
            callback(@{@"result":@"failed",@"data":@"key must a string or number!"}); // forgive my english
        }
        return;
    }
    
    if ([key isKindOfClass:[NSNumber class]]) {
        key = [((NSNumber *)key) stringValue]; // oh no!
    }
    
    if ([WXUtility isBlankString:key]) {
        if (callback) {
            callback(@{@"result":@"failed",@"data":@"invalid_param"});
        }
        return ;
    }
    
    NSString *value = [self.memory objectForKey:key];
    if ([WXStorageNullValue isEqualToString:value]) {
        value = [[WXUtility globalCache] objectForKey:key];
        if (!value) {
            NSString *filePath = [WXStorageModule filePathForKey:key];
            NSString *contents = [WXUtility stringWithContentsOfFile:filePath];
            if (contents) {
                [[WXUtility globalCache] setObject:contents forKey:key cost:contents.length];
                value = contents;
            }
        }
    }
    if (!value) {
        [self executeRemoveItem:key];
        if (callback) {
            callback(@{@"result":@"failed",@"data":@"undefined"});
        }
        return;
    }
    [self updateTimestampForKey:key];
    [self updateIndexForKey:key];
    if (callback) {
        callback(@{@"result":@"success",@"data":value});
    }
}

了解了如何存储，获取就相对简单了。依次，先从memory字典中找，然后去globalCache中找，最后去filePath下找；如果都没找到，则移除该key，并把文件中和该key相关的内容都删除了。

总结

对比YYCache的实现，weex的storage模块实现比较简单，条理清晰。在简单的数据缓存上完全够用了。