完了！用完NSCache怀疑人生了....

在最近的一次项目模块化实践中，我重构了Hybrid模块的API分发机制。重构中使用了NSCache，结果bug改到怀疑人生。

之前的hybrid模块，API的实现与js-bridge耦合，业务使用时需要集中注册API，由于部分UI接口需要依赖于宿主工程，对于模块的各业务扩展性支持不好。基于此，本次重构主要是针对hybrid的api分发机制。

核心思想是，通过api-manager来对api进行统一管理与分发，全局维护一组api实例，api遵循api-protocol协议并在load中异步进行注册，webview根据group来标识一组api。

基于此，api-manger需要通过缓存来保存当前的api实例，确保app中所有的webview都可以使用，由于注册可以使用异步注册，避免出现多线程问题，这个地方的缓存采用了NSCache。

先还原一下现场：ApiManager是一个单例，strong强引用了一个NSCache的实例,通过提供的宏异步注册了api，代码大概长这样：

@interface ApiManager ()
@property (nonatomic, strong) NSCache *cache;
@end

@implementation ApiManager
static id _instance;
+ (instancetype)manager {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        _instance = [[self alloc] init];
    });
    return _instance;
}

- (void)addObject:(id)object forKey:(NSString *)key {
    [self.cache setObject:object forKey:key];
}

- (id)objectForkey:(NSString *)key {
    return [self.cache objectForKey:key];
}

- (NSCache *)cache {
    if (_cache == nil) {
        _cache = [[NSCache alloc] init];
    }
    return _cache;
}
@end

当兴高采烈的提测之后，噩梦开始了！提审前一天测试报了bug，APP打开了webview,进入后台之后再次进入前台，界面上的按钮失效了。

经过确认，cache缓存的ui-api注册之后，js端通过js-bridge给webview设置了一个原生按钮并注册了点击事件。切换前后台之后，点击事件的target被置为了nil,导致无法响应。

代码大概是这样的:


@interface UserInterfaceApi : NSObject

- (id)setNavigationBar:(id)parameter callback:(block)callback {
    ...
    if (leftItem != nil) {
        UIBarButtonItem *backButton = [[UIBarButtonItem alloc] initWithImage:image
                                                                       style:UIBarButtonItemStylePlain
                                                                      target:self
                                                                      action:@selector(actionLeft:)];
    }
    ...
}

- (void)actionLeft:(id)sender {
    ...
}

@end

唯一的原因是ui-api被释放了，但在哪里释放的呢？可能的原因有：

其他业务监听了前后台事件，并同构apimanager的接口移除了api

系统收到了内存告警的通知，自动清除了cache

其他webview实例dealloc时clean了当前的api

搜索整个工程，监听前后台事件的位置并没有与api-manager交互，切换前后台时也没有收到系统内存告警。查了业务，并没有其他webview主动释放，那问题出在哪里呢？

排除了上述三个原因之后，只能从cache这里入手了。整个app运行期间，api仅仅被cache强引用，webview通过groupId来与api绑定时也是使用的弱引用，所以只可能是NSCache出现了问题。

查阅官方文档，重新阅读了一下这段话

The NSCache class incorporates various auto-eviction policies, which ensure that a cache doesn’t use too much of the system’s memory. If memory is needed by other applications, these policies remove some items from the cache, minimizing its memory footprint.

如果其他应用需要内存时，系统会将NSCache移除，也就是说系统会自己判断在某个合适的时机清空cache。之前总以为系统内存告警时会被移除，难道合适的时机还包括前后台切换？

于是，将NSCahe换成了NSMutableDictionary试了一次，发现bug消失了。看来前后台切换，系统确实会清理掉NSCache。

问题解决了，那我们来重新总结一下NSCache。继续翻看苹果开发者文档，我们发现NSCache有以下特点:

系统会在合适的时间清理掉NSCache

NSCache是线程安全的

key对象不会被拷贝，也即key无需遵循NSCopying协议

最后，NSCache使用时需要慎重考虑当前的业务环境。

更多内容欢迎关注我的公众账号，搜索“ smallyou_chmn” 查看更多精彩内容