[iOS] 使用 blockable NSTimer 避免内存泄漏

背景

此知识点,从阅读《Effective Objective-C》中学习到,现扩展到 Swift 并兼容 iOS 10+

NSTimer 提供定时执行任务的功能,可用于延时或者重复处理事务。使用 NSTimer 执行重复任务时(非重复任务会在触发后自动撤销 invalidate),必须注意的是一个内存泄露的问题,原因是 iOS 10 以前 Timer 基于 Target-action 的 API 设计下:
OC:

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

Swift:

   class func scheduledTimer(timeInterval ti: TimeInterval, 
                                   target aTarget: Any, 
                            selector aSelector: Selector, 
                                userInfo: Any?,
                             repeats yesOrNo: Bool) -> Timer
  • NSTimer 被所在的 Runloop 强引用

Timers work in conjunction with run loops. To use a timer effectively, you should be aware of how run loops operate—see NSRunLoop
and Threading Programming Guide. Note in particular that run loops maintain strong references to their timers, so you don’t have to maintain your own strong reference to a timer after you have added it to a run loop.

  • NSTimer 需要在安装的线程 / runloop 进行移除,如果从非安装线程进行移除,那么 timer 可能无法从 Runloop 中移除,也将导致相关的线程、target 和 userInfo 无法释放,慎用子线程 NSTimer !!

You must send this message from the thread on which the timer was installed. If you send this message from another thread, the input source associated with the timer may not be removed from its run loop, which could prevent the thread from exiting properly.

  • NSTimer 会强引用其 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.

也就是说,如果是在主线程,即便调用 timer 的对象(target)没有对 timer 进行强引用(比如说使用了 weak 弱引用),因为 NSRunloop -> NSTimer -> target,而导致 target 无法释放,除非为 target 独立设计一个 stopTimer 的方法。
OC:

- (void)stopTimer {
    [_timer invalidate];
}

Swift:

func stopTimer() {
      timer.invalidate()
}

如果单单在 dealloc/deinit 处执行撤销 Timer 的操作无法达到预期效果,因为 target 被强引用不会调用销毁/析构的方法。
OC:

- (void)dealloc {
    [_timer invalidate];
}

Swift:

deinit {
     timer.invalidate()
}

解决方案

逆向地看:

  • 不让 timer 强引用调用者,如此调用者可以正常释放,在调用者释放时即可顺利地撤销 Timer
  • 那么选择一个类对象作为 target 是合适的,因为类对象本身就是单例的存在,不存在多余的泄露问题。
  • 当 target 成为一个类对象后,Timer 将通过 selector 回调类对象,此时思考如何将定时器事件如何回调给原来的调用者,对比 delegate/notification/block,使用 block 更合适,这样业务紧凑,且无需更多的配套参数。使用 block 作为一个 timer 的 userInfos,在 timer 回调时调用 block 即可:

OC:

@implementation NSTimer (GSBlockable)

+ (NSTimer *)gs_scheduledTimerWithTimeInterval:(NSTimeInterval)interval
                                       repeats:(BOOL)repeats
                                         block:(void (^)(NSTimer * _Nonnull))block
{
    if ([UIDevice currentDevice].systemVersion.doubleValue <= 10.0) {
        return [self scheduledTimerWithTimeInterval:interval
                                                target:self
                                              selector:@selector(gs_timerTick:)
                                              userInfo:[block copy]
                                               repeats:repeats];
    } else {
        return [self scheduledTimerWithTimeInterval:interval
                                                 repeats:repeats 
                                                block:block];
    }
}


+ (void)gs_timerTick:(NSTimer *)timer {
    void (^block)(NSTimer *) = timer.userInfo;
    !block ?: block(timer);
}

@end

Swift:

extension Timer {
    open class func gsx_scheduledTimer(withTimeInterval interval: TimeInterval,
                                       repeats: Bool,
                                       block: @escaping (Timer) -> Swift.Void) -> Timer
    {
        if false {
            return scheduledTimer(withTimeInterval: interval,
                                               repeats: repeats, 
                                                  block: block);
            
        } else {
            return scheduledTimer(timeInterval: interval, 
                                  target: self,
                               selector: #selector(Timer.gsx_timerTick), 
                              userInfo: block, 
                          repeats: repeats)
        }
    }
    
    open class func gsx_timerTick(timer: Timer) {
        if let  block = timer.userInfo as? (Timer)-> Swift.Void {
            block(timer)
        }
    }
}
  • 此时则需要注意不能让 block 强引用了调用者,应该在 block 内使用调用着的 weak 引用,否则仍然会造成内存泄漏, Runloop -> Timer -> UserInfo(block) -> sender。
    OC:
    __weak typeof(self) weakSelf = self;
    self.timer = [NSTimer gs_scheduledTimerWithTimeInterval:3 
                                               repeats:YES
                                               block:^(NSTimer * _Nonnull timer) {
        [weakSelf printSomething];
    }];

- (void)printSomething {
    NSLog(@"TimerVC ....");
}

- (void)dealloc {
    NSLog(@"timervc dealloc");
    [_timer invalidate];
}

Swift:

timer = Timer.gsx_scheduledTimer(withTimeInterval: 3, 
                                repeats: true, 
                                block: {[weak self](theTimer) in
            self?.printSth()
        })

    func printSth() {
        print("tick")
    }
    
    deinit {
        print("deinit")
        timer?.invalidate()
    }

小结

  1. 使用类对象对 timer 进行 block 封装来避免 timer,
  2. 使用 block 封装 timer 的回调逻辑
  3. 在 block 内使用 weak 引用避 block 潜在的强应用
  4. 在 dealloc/deinit 时,撤销 timer
  5. 当系统版本达到 iOS 10 时直接使用已有 API 即可。

update 2017-10-18

  • BlocksKit 中学习到 利用 CoreFoundation 框架中 CGTimer 的函数应用 CFRunLoopTimerCreateWithHandler()
  • 从 YYKit 中了解到一种使用 YYWeakProxy(基于 NSProxy) 的方法来避免 Timer 对 target 强引用的方式。(在评论中 未来行者同学也有提及类似方案。)

PS

使用 GCD 亦可实现安全的 block + timer

加我微信沟通。


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

推荐阅读更多精彩内容