2009年5月31日日曜日

NSTimerは基本的にretainせずassignでよい

NSTimerを初めて使ってみたのでハマったところをメモしておきます。


■NSTimerはNSRunLoopにretainされる。NSTimerは引数targetで与えられたオブジェクトをretainする。
いちばんハマったのがこの挙動です。
AppleのNSTimerについての公式ドキュメント(http://www.devworld.apple.com/documentation/Cocoa/Conceptual/Timers/Articles/usingTimers.html#//apple_ref/doc/uid/20000807-CJBJCBDE)にもクラスリファレンスにもきちんとと明記されていたのですが・・・思いっきり見落としてました。

これらがいったいどんな問題を引き起こすか。
たとえば普通のクラスと同じ感覚でdealloc中にNSTimerのinvalidateを呼び出すコードを書くと、永遠にdeallocが呼び出されなくなってしまいます。
// ViewControllerがNSTimerを使っているとして・・・
- (void)viewDidLoad
{
    timer = [NSTimer scheduledTimerWithTimeInterval:interval
                                             target:self // このselfはretainされる
                                           selector:@selector(timerFired)
                                           userInfo:nil
                                            repeats:YES];
}
- (void)dealloc
{
    [displayLabel release];
    [timerLabel release];
    // ここでinvalidateしてはいけない、永遠にdealloc自体が呼び出されなくなる
    [timer invalidate];
    [timer release];
}

なぜなら、
  • NSTimerがdeallocを呼び出すオブジェクトをretainしている、したがってNSTimerがreleaseされるまでdeallocが呼ばれない
  • NSTimerはNSRunLoopにretainされている、従ってNSTimerのinvalidateが実行されるまではNSTimerはreleaseされない
  • invalidateを呼び出しているのはこのdeallocの中以外にない。・・・詰みました。
こうならないようにするためには、dealloc以外の箇所から、適切にinvalidateメソッドを呼び出してやる必要があります。ということで、ViewControllerの中でNSTimerを使うときは、以下の2点に気をつければ良さそうです。
  1. NSTimerのオブジェクトは基本retainしない（自分でNSRunLoopにaddTimerとかしたい場合は別として）
  2. 通常deallocのタイミングでオブジェクトをreleaseするのと同じようにNSTimerをinvalidateしたい場合は、- (void)viewWillDisappear:(BOOL)animated を使う

- (void)viewWillDisappear:(BOOL)animated
{
    if (timer)
    {
        // ここでタイマーをinvalidateする
        // invalidateするとNSRunLoopがretainされていたこのタイマーをreleaseしてくれる
        [timer invalidate];
        timer = nil;
    }
}

■userInfoはただのNSDictionary
そのまんまです。クラスリファレンスを見ても
The user info the new timer.

This parameter may be nil.
としか書いてなくて困ったのですが、本当にただのNSDictionaryです。適当に使ってくれってことでしょうか。


■次のタイマーイベントまでの間隔をリセットしたいときはsetFireDate:
たとえば何らかの理由でタイマーのFireイベントに登録していたセレクタを自分で呼び出しちゃって、次のタイマーイベントまでの間隔をリセットしたいときなどは以下のような具合にするとよいです。
if (timer)
{
    // timerのsetFireDateに、次にタイマーイベントが発生する日時をセットする
    // NSDateに、dateWithTimeIntervalSinceNowという便利なメソッドがあるのでこれを使う
    [timer setFireDate:[NSDate dateWithTimeIntervalSinceNow:interval]];
}

■っていうか
今このBlogを書くためにNSTimerでぐぐったらここに書いてあるようなことがいろいろ見つかってしまいました・・・＞＜
先にちゃんと調べてから作らないと無駄ですね−。
投稿時間：
タグ： ,