解除NSTimer潜在的“保留环”问题

NSTimer是Foundation框架中的一个使用频率很高的类,然而其调用过程中很容易引入潜在的“保留环“问题。可能是因为NSTimer的提供的API足够便利与顺手,以至于这个问题不容易被察觉到。这篇博客旨在阐述这个问题并提供解决方法。

以下的NSTimer提供的三个常用的创建或者初始化的API:

+ (NSTimer *)timerWithTimeInterval:(NSTimeInterval)ti target:(id)aTarget selector:(SEL)aSelector userInfo:(nullable id)userInfo repeats:(BOOL)yesOrNo;

+ (NSTimer *)scheduledTimerWithTimeInterval:(NSTimeInterval)ti target:(id)aTarget selector:(SEL)aSelector userInfo:(nullable id)userInfo repeats:(BOOL)yesOrNo;

- (instancetype)initWithFireDate:(NSDate *)date interval:(NSTimeInterval)ti target:(id)t selector:(SEL)s userInfo:(nullable id)ui repeats:(BOOL)rep NS_DESIGNATED_INITIALIZER;

这三个API有一个共同的点,即都需要提供一个target参数。这个target参数会被创建的NSTimer实例对象强引用一次,直到NSTimer实例对象调用invalidate方法后失效才释放。API文档原文如下:

target: The object to which to send the message specified by aSelector when the timer fires. The timer maintains a strong reference to target until it (the timer) is invalidated.

多数情况,我们都会将创建后NSTimer实例对象保存为当前类的实例变量,然后NSTimer的target参数设置为self指针。我写代码的习惯就是这样的。实例代码如下:

#import <Foundation/Foundation.h>

@interface MyObject : NSObject {
    NSTimer *mTimer;
}
@end

@implementation MyObject

- (id)init {
    if ((self = [super init])) {
        //此处参数repeats = YES;
        mTimer = [NSTimer scheduledTimerWithTimeInterval:1.0 target:self selector:@selector(timerFiredFun) userInfo:nil repeats:YES];
        [mTimer setFireDate:[NSDate distantPast]];
     
    }
    return self;
}

- (void)dealloc {
    [mTimer invalidate];
    mTimer = nil;
}

- (void)timerFiredFun{
    NSLog(@"%s" , __func__);
}

@end

int main (int argc , const char * argv[]) {
    
    MyObject *myObjcet = [MyObject new];
    //self只是一个空消息,避免编译器发出myObjcet未使用的警告
    [myObjcet self];
    //NSTimer依赖于RunLoop而存活,手动激活RunLoop
    while (1) {
        [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantFuture]];
    }
  
    return 0;
}

上述代码就是典型的计时器使用情景之一。如果计时器只是一次执行而非反复触发,那么计时器会在执行后自动失效,也就不会有“保留环”的问题。但是如果是设置反复触发的计时器类型,那么NSTimer对象会强引用MyObject对象,而当前类也一直持有NSTimer对象,因此,如果NSTimer不调用invalidate设置无效,MyObject对象不会背释放,其dealloc函数也一直被调用,然而NSTimer的invalidate恰好是MyObject对象的dealloc函数中调用。这样两个对象都不会释放。

出现“保留环”的根本原因在于NSTimer对象在创建的API隐性地强引用一次target,因此,解除“保留环”的关键在于避开NSTimer对象对self指针的强引用。以下是提供的一种解决方案:

NSTimer+BlockSupported分类


#import <Foundation/Foundation.h>

typedef void(^ICETimerScheduleBlock)(void);

@interface NSTimer (BlockSupported)

+ (NSTimer *)ice_scheduledTimerWithTimeInterval:(NSTimeInterval)ti
                                         block:(ICETimerScheduleBlock)block
                                       repeats:(BOOL)yesOrNo;

@end

#import "NSTimer+BlockSupported.h"

@implementation NSTimer (BlockSupported)

+ (NSTimer *)ice_scheduledTimerWithTimeInterval:(NSTimeInterval)ti
                                         block:(ICETimerScheduleBlock)block
                                       repeats:(BOOL)yesOrNo {
    //Timer会对target强引用,但是此处target变成Timer类对象。因为类对象生命周期与应用程序一置的,不受引用计数限制,所以没关系。
    return [NSTimer scheduledTimerWithTimeInterval:ti target:self selector:@selector(ice_timerFiredFun:) userInfo:block repeats:yesOrNo];
    
}

+ (void)ice_timerFiredFun:(NSTimer *)timer {
    ICETimerScheduleBlock block = timer.userInfo;
    if (block) {
        block();
    }
}

@end

使用方式

__weak typeof(self) weakSelf = self;
mTimer = [NSTimer zd_scheduledTimerWithTimeInterval:1.0f block:^{
    //添加一次局部强引用,确保即使在block执行过程中外部的self被释放了也能顺利完成。局部变量strongSelf的生命周期只限于当前block,不会一直持有self,所以不影响外部self对象的引用计数平衡。
    //如果局部强引用,weakSelf可能会在block执行过程中因为外部self释放而被设置为nil。
    __strong typeof(weakSelf) strongSelf = weakSelf;
    [strongSelf timerFiredFun];
} repeats:YES];

上述解决方案使用了NSTimer+BlockSupported分类对NSTimer原生函数进行了二次封装,将调用方需要的执行的函数转移到block中执行,再结合__weak指针解除NSTimer对self的强引用。NSTimer原生API调用照样会对target强引用,但是此时的target变成Timer类对象。因为类对象生命周期与应用程序一置的,不受引用计数限制,所以没关系。

这种类型的“保留环”问题很隐蔽,因此很有分析与记录价值,与君共享。

GitHub Demo

注:这个解决方案参考了Effective Objective-C 2.0一书中第52条,有兴趣的同学可以自行查阅。

博客地址

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,905评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,140评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,791评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,483评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,476评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,516评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,905评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,560评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,778评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,557评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,635评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,338评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,925评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,898评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,142评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,818评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,347评论 2 342

推荐阅读更多精彩内容