NSFetchedResultsControllerDelegate - メモリ管理に関するメモ

2010年7月28日水曜日 | Published in | 0 コメント

このエントリーをはてなブックマークに追加

NSFetchedResultsController を使っていて、NSFetchedResultsControllerDelegate を実装している時のメモリ管理に関する私的メモ。


Delegateのメソッドはいつ呼ばれるのか?


- controller:didChangeObject:atIndexPath:forChangeType:newIndexPath: は、NSManagedObjectContext に変化があった時に呼ばれる。

次のケースを想定してみる。

UINavigationController を使っていて、一覧画面から詳細画面へ移動してそこで NSManagedObjectContextに操作を加える。
ListViewController &ltNSFetchedResultsControllerDelegate> ⇒ (参照) UITableView* tableView
 ↓
DetailViewController ← NSManagedObjectContext操作(変更・削除など)
すると ListViewController の -controller:didChangeObject:atIndexPath:forChangeType:newIndexPath: が呼び出される。この時点ではまだ DetailViewController が表示されているものとする。

この Delegateメソッド内では通常 tableViewに対して操作を行っている。
- (void)controller:(NSFetchedResultsController *)controller didChangeObject:(id)anObject
       atIndexPath:(NSIndexPath *)indexPath forChangeType:(NSFetchedResultsChangeType)type
      newIndexPath:(NSIndexPath *)newIndexPath {

    UITableView *tableView = self.tableView;

    switch(type) {
            
        case NSFetchedResultsChangeInsert:
            [tableView insertRowsAtIndexPaths:[NSArray arrayWithObject:newIndexPath]
               withRowAnimation:UITableViewRowAnimationFade];
            break;
         :

上記のケースでメモリ不足が発生して ListViewController の viewが 開放された場合、self.tableView へのアクセスが安全かどうかが気になる。


ListViewController.view が UITableView の場合


通常 ListViewController は UITableViewController のサブクラスとなる。UITableViewの管理は親クラスの tableViewインスタンスで管理される。

このケースは問題ない。

流れとしては次のようになる。
DetailViewController表示
 ↓
メモリ不足発生
 ↓
ListViewController で viewDidUnload が呼び出され、view(tableView) が開放される
 ↓
DetailViewController で NSManagedObjectContext を操作
 ↓
ListViewController で controllerWillChangeContent: が呼び出される。
この中で self.tableView を参照。
   ↓
  self.tableViewへのアクセスをトリガーにして、ListViewController で
  viewDidLoad が呼び出される。これによって self.tableView の準備が完了する
   ↓
  controllerWillChangeContent: の処理を実行
 ↓
ListViewController の -controller:didChangeObject:atIndexPath:forChangeType:
 newIndexPath:呼び出しself.tableView への操作が無事に行われる
 ↓
ListViewController へ戻ると、変更が反映された表が表示されている。

UITableViewController を使う場合、self.view と self.tableView は等価となる。このため self.tableViewに対するアクセスによって、self.view に仕掛けられた KVO機構が発動して UITableViewがロードされ self.tableView で使えるようになると思われる(※これは推測)。=> KVOなんて使わなくて単なる getterメソッドの実装でそうなっている、と思われる。


ListViewController.view が UIView の場合


UIView の上に UITableView が載っているケース。この場合、ListViewController は UIViewController のサブクラスで tableView を定義して自前で管理する。
@interface RootViewController : UIViewController
  <NSFetchedResultsControllerDelegate> {

    UITableView* tableView_;
}
@property (nonatomic, retain) IBOutlet UITableView* tableView;
@end

@implementation RootViewController
  :
- (void)viewDidUnload {
    [super viewDidUnload];
    self.tableView = nil;
}
  :

結論からすると、このケースも実質問題がない。

DetailViewController表示
 ↓
メモリ不足発生
 ↓
ListViewController で viewDidUnload が呼び出され、view が開放される
 ↓         この時 tableView も開放される(self.tableView=nil)
 ↓
DetailViewController で NSManagedObjectContext を操作
 ↓
ListViewController の
-controller:didChangeObject:atIndexPath:forChangeType:newIndexPath:呼び出し
 ↓
self.tableViewに対してメッセージを送るが nil の為、何も起こらない
 ↓
ListViewControllerへ戻る
 ↓
viewが再ロードされ viewDidLoad が呼び出される。
UIViewControllerが参照するビューが芋づる式にロードされる。
 ↓
UITableView は新規表示になるのでデータは最新のものを読み直し。
この結果、正しいデータが表示される。


ソースコード


両方のケースを試せる。ただし切り替えは手作業が少々必要(現在は1番目のケースで動作する)。
NSFetchedResultControllerDelegateSample at 2010-07-28x from xcatsan's iOS-Sample-Code - GitHub


関連情報


Cocoaの日々: NSFetchedResultsControllerDelegate を使う

UIActionSheet を Blocks で処理する

| Published in | 0 コメント

このエントリーをはてなブックマークに追加

iOS4から UIView のアニメーション関連のメソッドで Blocksが利用できるようになった。最近よく利用しているがこれは非常に便利。一方、UIActionSheet で不便を感じていたので試しに Blocksが使える実装を書いてみた。

使い方はこんなイメージ:
ActionSheetBlocksExtension*  sheet = [[ActionSheetBlocksExtension alloc] 
            initWithTitle:@"Action sheet sample" 
            didClick:^(UIActionSheet* actionSheet, NSInteger buttonIndex) {
                NSLog(@"[1] index %d: %@", buttonIndex, actionSheet);
            }
            cancelButtonTitle:@"Cancel"
            destructiveButtonTitle:@"Destructive" 
            otherButtonTitles:@"Other-11", @"Other-12", @"Other-13", nil];


アーキテクチャ


UIActionSheet のサブクラスを作り、このクラスで UIActionSheetDelegate を実装する。できればカテゴリで行きたかったが、Delegate先になるのと Blockを保持する必要があったのでサブクラスとした。


実装


今回は ActionSheetBlocksExtension という UIActionSheet のサブクラスを作った。
@interface ActionSheetBlocksExtension : UIActionSheet <UIActionSheetDelegate> {

 void (^didClickBlock_)(UIActionSheet*, NSInteger);
}

- (id)initWithTitle:(NSString *)title
     didClick:(void (^)(UIActionSheet*, NSInteger))block
  cancelButtonTitle:(NSString *)cancelButtonTitle
destructiveButtonTitle:(NSString *)destructiveButtonTitle
  otherButtonTitles:(NSString *)firstOtherTitle,...;

@end

didClickBlock_ は引数で渡される Block を格納するためのメンバ変数。

実装:
#pragma mark -
#pragma mark Initialization & deallocation
- (id)initWithTitle:(NSString *)title
     didClick:(void (^)(UIActionSheet*, NSInteger))block
  cancelButtonTitle:(NSString *)cancelButtonTitle
destructiveButtonTitle:(NSString *)destructiveButtonTitle
 otherButtonTitles:(NSString *)firstOtherTitle,...
{
 self = [super initWithTitle:title
        delegate:self
     cancelButtonTitle:nil
   destructiveButtonTitle:nil
     otherButtonTitles:nil];


 if (self) {
  didClickBlock_ = [block retain];

  int index = 0;
  
  if (destructiveButtonTitle) {
   [self addButtonWithTitle:destructiveButtonTitle];
   self.destructiveButtonIndex = index;
   index++;
  }
  
  if (firstOtherTitle) {
   [self addButtonWithTitle:firstOtherTitle];
   index++;
 
   va_list args;
   va_start(args, firstOtherTitle);
   NSString* title;
   while (title = va_arg(args, NSString*)) {
    [self addButtonWithTitle:title];
    index++;
   }
   va_end(args);
  }
  
  [self addButtonWithTitle:cancelButtonTitle];
  self.cancelButtonIndex = index;
 }
 return self;
}

- (void) dealloc
{
 [didClickBlock_ release];
 [super dealloc];
}

#pragma mark -
#pragma mark UIActionSheetDelegate
- (void)actionSheet:(UIActionSheet*)actionSheet clickedButtonAtIndex:(NSInteger)buttonIndex
{
 didClickBlock_(actionSheet, buttonIndex);
}

特に難しいことはやっていない。初期化で渡された blockを didClickBlock_ へ格納しておき、ボタンが押された時に呼び出している。

UIActionSheet のサブクラスの初期化については前回取り上げたのでそちらを参照のこと。



サンプル


これを組み込んだサンプルを作ってみた。呼び出し側のコードはこんな感じ。
- (IBAction)openSheet1:(id)sender
{
 ActionSheetBlocksExtension*  sheet = [[ActionSheetBlocksExtension alloc] 
            initWithTitle:@"Action sheet sample" 
            didClick:^(UIActionSheet* actionSheet, NSInteger buttonIndex) {
             NSLog(@"[1] index %d: %@", buttonIndex, actionSheet);
            }
            cancelButtonTitle:@"Cancel"
            destructiveButtonTitle:@"Destructive" 
            otherButtonTitles:@"Other-11", @"Other-12", @"Other-13", nil];
    [sheet autorelease]; 
    [sheet showInView:self.view];
}
Blocks内の処理は、押されたボタンのindexとUIActionSheetのインスタンスをデバッグ出力している。

さて実行してみよう。テスト用に3つの UIActionSheet を作るようにしてみた。
UIActionSheetの表示

ボタンを押すと Blocksで定義したコードが呼び出されているのがわかる。
[67822:207] [1] index 4: <ActionSheetBlocksExtension: 0x5d14ab0;
 baseClass = UIActionSheet; frame = (0 124; 320 336); opaque = NO;
 layer = <CALayer: 0x5d0fa80>>


ソースコード


GitHubからどうぞ。
ActionSheetUsingBlocks at 2010-07-27 from xcatsan's iOS-Sample-Code - GitHub


参考情報


Blocks Programming Topics: Getting Started with Blocks
iPhone Dev Center 提供の Blocks解説



その他


Blocks は不慣れなので問題があるかもしれません。ツッコミがあれば是非コメントにどうぞ。

なお @marvelph @gnue のツイートが参考になりました。ありがとうございました。

UIActionSheet のサブクラス化

2010年7月27日火曜日 | Published in | 0 コメント

このエントリーをはてなブックマークに追加

初期化メソッドの最後が可変引数なので、これをオーバーライドする場合は工夫が必要。

初期化メソッドのオーバーライド


可変引数はあとから -[addButtonWithTitle:]で追加してやる。

- (id)initWithTitle:(NSString *)title
 delegate:(id < UIActionSheetDelegate >)delegate
 cancelButtonTitle:(NSString *)cancelButtonTitle
 destructiveButtonTitle:(NSString *)destructiveButtonTitle
 otherButtonTitles:(NSString *)firstOtherTitle,...
{
 self = [super initWithTitle:title
        delegate:delegate
     cancelButtonTitle:nil
   destructiveButtonTitle:nil
     otherButtonTitles:nil];


 if (self) {
  int index = 0;
  
  if (destructiveButtonTitle) {
   [self addButtonWithTitle:destructiveButtonTitle];
   self.destructiveButtonIndex = index;
   index++;
  }
  
  if (firstOtherTitle) {
   [self addButtonWithTitle:firstOtherTitle];
   index++;
 
   va_list args;
   va_start(args, firstOtherTitle);
   NSString* title;
   while (title = va_arg(args, NSString*)) {
    [self addButtonWithTitle:title];
    index++;
   }
   va_end(args);
  }
  
  [self addButtonWithTitle:cancelButtonTitle];
  self.cancelButtonIndex = index;
 }
 return self;
}

試しに呼び出すとこんな感じ。ちゃんと動いているようだ。

なお self=[super ...] で cancel と destructive ボタンを指定すると順番がおかしくなる。


これを防ぐために cancel と destructive ボタンも標準の順番に合うように追加している。


参考情報

UIActionSheet addButtonWithTitle: doesn't add buttons in the right order - Stack Overflow
今回の方法が載っていた
CodeResource - Uncategorized Messages - Uiactionsheet And Popviewcontrolleranimated
同様の方法が示されていた
Cocoa with Love: Variable argument lists in Cocoa
Cocoaにおける可変引数の記事
Cocoaの日々 - 2005年1月
当ブログでも大昔に取り上げたことがあった。
UIActionSheet Class Reference
リファレンス

- - - -
次回は UIActionSheet の Blocks化をやります(今回はその伏線)。

UISearchDisplayController で用意される UITableView を扱う上での注意点

2010年7月26日月曜日 | Published in | 0 コメント

このエントリーをはてなブックマークに追加

以前、UISearchDisplayController についてのまとめを書いた。
[参考] Cocoaの日々: UISearchDisplayController と NSFetchedResultContoller を組み合わせる (3) 考察

さらに分かったことがあるので追記する。


[1] 検索毎に新規に UISearchResultsTableView が作り直される


-[UISearchDisplayControllerDelegate searchDisplayController:willShowSearchResultsTableView:] において引数で渡される UITableView をデバッグ出力したところ、検索毎に異なることがわかった。
[44712:207] <UISearchResultsTableView: 0x6044c00; ...
[44712:207] <UISearchResultsTableView: 0x6099200; ...
[44712:207] <UISearchResultsTableView: 0x6828e00; ...

つまり検索毎に作り直されている。通常表示(非検索時)用の UITableView の属性はコピーされないようなので、必要ならこのデリゲートメソッドで毎回属性の設定を行ってやる。

[例]
- (void)searchDisplayController:(UISearchDisplayController *)controller
  willShowSearchResultsTableView:(UITableView *)tableView
{
 tableView.backgroundColor = [UIColor clearColor];
 tableView.separatorStyle = UITableViewCellSeparatorStyleNone;
}



[2] UISearchResultsTableView は UITableView の上に重なって表示される


UISearchResultsTableView は UITableView の上に重なって表示される。


この為、背景色を透明にしている場合は検索結果表示の下に通常表示のビューが重なって見えてしまう。

これでは困るので検索時には通常表示のビューを隠す必要がある。ただ単純に hidden=YES とすると、UISearchBarまでが非表示なってしまう。これは UISearchBar が通常表示ビュー UITableView のヘッダに描かれているため。ヘッダ以外の部分だけを隠せないものだろうか。

試しに UITableView の subviews を表示してみた。
[44878:207] (
    "<UITableViewCell: 0x68a1e80; frame = (0 404; 320 72); ...
    "<UITableViewCell: 0x689cc90; frame = (0 332; 320 72); ...
    "<UITableViewCell: 0x6897ab0; frame = (0 260; 320 72); ...
    "<UITableViewCell: 0x6892800; frame = (0 188; 320 72); ...
    "<UITableViewCell: 0x688d410; frame = (0 116; 320 72); ...
    "<UITableViewCell: 0x6876600; frame = (0 44; 320 72); ...
    "<UISearchBar: 0x6862260; frame = (0 0; 320 44); ...
    "<UIImageView: 0x6863840; frame = (0 0; 7 7); ...
なるほど。ヘッダと同じレベルで表示されているセルが1つずつ全部乗っているのか。
とすると、これらのセルを全部非表示にしてやる必要がありそうだ。ただそれをやると内部構造に依存するため今後の iOSのバージョンアップで非互換になる可能性がある。

色々考えたが、他に方法も無い(*1)のと恐らくこの構造が大きく変わることは無いと踏んで今回はセルを全部非表示にしてみる。
(*1) 今回背景色を透明にしているのは、ビュー階層の一番下に背景画像を表示しているからで、別の方法でこれが実現できれば内部構造に依存したコードを書く必要はなくなる。


まず現在表示されているセルの表示制御を行うメソッドを1つ用意する。
- (void)setDisplayedCellsHidden:(BOOL)hidden
{
 for (UIView* view in self.tableView.subviews) {
  if ([view isKindOfClass:[UITableViewCell class]]) {
   view.hidden = hidden;
  }
 }
}

これを検索開始と、検索終了のタイミングで呼び出す。

// 検索開始
- (void)searchDisplayController:(UISearchDisplayController *)controller
  willShowSearchResultsTableView:(UITableView *)tableView
{
  :
 [self setDisplayedCellsHidden:YES];
}

// 検索終了
- (void)searchBarCancelButtonClicked:(UISearchBar *)searchBar
{
  :
 [self setDisplayedCellsHidden:NO];
}

NSFetchedResultsControllerDelegate を使う

2010年7月25日日曜日 | Published in | 0 コメント

このエントリーをはてなブックマークに追加

[前回] Cocoaの日々: NSFetchedResultsController のおさらい

今回は NSFetchedResultsControllerDelegate について調べた。


NSFetchedResultsControllerDelegate


NSFetchedResultsControllerDelegate Protocol Reference

NSFetchedResultsControllerDelegate は NSFetchedResultsController からのコールバックを受け取るためのメソッドが定義されているプロトコル。NSFetchedResutlsController は NSManagedObjectContext に対する操作(追加・変更・削除)を監視していて、それらを検出するとこのプロトコルのメソッドを呼び出す。この辺りは前回の Cocoaの日々: NSFetchedResultsController のおさらい にて少し触れた。

これらのメソッドの使い方は上記リファレンスの Overviewに書かれている。また Xcodeで Core Data を使うプロジェクトを作成すると、これらの実装コードが自動的に生成される。


利用パターン


利用パターンは3つ。

[A] 操作毎に処理するパターン


このパターンは NSManagedObjectContext の変更毎に呼び出されるメソッドを実装し、処理を行うパターン。Overviewではこれらが "Typical Use"として紹介されている。Xcodeが生成するコードもこのパターンになっている。

具体的には次のメソッドを実装する。
– controllerWillChangeContent:
– controller:didChangeObject:atIndexPath:forChangeType:newIndexPath:
– controller:didChangeSection:atIndex:forChangeType:
– controllerDidChangeContent:

通常はこれらの処理で UITableView に対する操作を行う。以下、controller:didChangeObject:atIndexPath:forChangeType:newIndexPath: の実装例の引用:
- (void)controller:(NSFetchedResultsController *)controller didChangeObject:(id)anObject
    atIndexPath:(NSIndexPath *)indexPath forChangeType:(NSFetchedResultsChangeType)type
    newIndexPath:(NSIndexPath *)newIndexPath {
 
    UITableView *tableView = self.tableView;
 
    switch(type) {
 
        case NSFetchedResultsChangeInsert:
            [tableView insertRowsAtIndexPaths:[NSArray arrayWithObject:newIndexPath]
                       withRowAnimation:UITableViewRowAnimationFade];
            break;
 
        case NSFetchedResultsChangeDelete:
            [tableView deleteRowsAtIndexPaths:[NSArray arrayWithObject:indexPath]
                       withRowAnimation:UITableViewRowAnimationFade];
            break;
 
        case NSFetchedResultsChangeUpdate:
            [self configureCell:[tableView cellForRowAtIndexPath:indexPath]
                  atIndexPath:indexPath];
            break;
 
        case NSFetchedResultsChangeMove:
            [tableView deleteRowsAtIndexPaths:[NSArray arrayWithObject:indexPath]
                       withRowAnimation:UITableViewRowAnimationFade];
            [tableView insertRowsAtIndexPaths:[NSArray arrayWithObject:newIndexPath]
                       withRowAnimation:UITableViewRowAnimationFade];
            break;
    }
}

操作毎に UITableView のアニメーション付きで表示更新を行うと、ユーザには一件づつ処理が行われているのが視覚的にわかるようになる。


[B] 操作終了時のみ処理するパターン


controllerDidChangeContent: のみ実装するパターン。これは処理対象の件数が多く [A]のパターンではパフォーマンス的に問題が出る場合に採用する。例えば100件のデータを削除するなど。1件づつ視覚的フィードバックを行うと非常に時間がかかるため現実的ではない。この場合は操作最後に UITableView の全件読み直しを行う方法が取れる。

[実装例]
- (void)controllerDidChangeContent:(NSFetchedResultsController *)controller {
    [self.tableView reloadData];
}


[C] デリゲートを利用しないパターン


NSFetchedResultsController.delegate = nil とするパターン。この場合は UITableView と NSManagedObjectContextとの同期を自前で処理する。


- - - -
通常は [A] を使い、処理件数が多い場合のみ [B] を使うといったハイブリッドなパターンも考えられる。


サンプルプログラム


動作確認するために複数の行を選択・削除できるサンプルプログラムを作ってみた。

[ソース] FetchedResultsControllerSample at 2010-07-25 from xcatsan's iOS-Sample-Code - GitHub



行を複数選択して、右下のボタンを押すと選択された行がアニメーションしながら表から消える。

サンプルコードのベースは、Xcodeの "Navigation-based Application" + "Use Core Data for storage" を使った。モデルの定義と調整、行の複数選択以外は手を入れていない。NSFetchedResultsControllerDelegate の実装メソッドは Xcodeが生成した雛形をそのまま利用した。つまり [A]パターンの動作となる。これだけで最低限の処理ができるので便利だ。


なお試しに NSFetchedResultsControllerDelegate の実装メソッドを controllerDidChangeContent: だけにしてみた([B]パターン)。この場合は [A]パターンと違いアニメーションは起こらず、画面全体が読み直される。


参考情報

Table View Programming Guide for iOS: Inserting and Deleting Rows and Sections
"Batch Insertion, Deletion, and Reloading of Rows and Sections" UITableViewのバッチ操作についての解説。

NSFetchedResultsController のおさらい

2010年7月24日土曜日 | Published in | 0 コメント

このエントリーをはてなブックマークに追加

改めて調べなおした。NSFetchedResultsController はデータ取得と操作(挿入・変更・削除)に分けて考えるとわかりやすい。以下、UITableView および UITableViewController と組み合わせた典型的なパターンについて説明する。


データ取得


UITableView が表示するデータを UITableViewDataSource へ要求する。通常 UITableViewController がこのプロトコルを実装していて NSFetchedResultController から必要なデータを取得し、UITableViewへ返す。NSFetchedResultController は大抵の場合、UITableVIewController 初期化時にフェッチを行っていて、データ取得の要求があった場合は取得済みのデータを返す。

なお NSFetchedResultController の持つ cache はデータそのキャッシュではなく、section と ordering に関するもの。アプリケーションのレベルで管理される。
Where possible, a controller uses a cache to avoid the need to repeat work performed in setting up any sections and ordering the contents. The cache is maintained across launches of your application.

[参照] NSFetchedResultsController Class Reference


データ操作


データの追加や変更、削除は、NSFetchedResultsControllerではなく、NSManagedObjectContext に対して行う(② データ操作)。NSFetchedResultsController は NSManagedObjectContext を監視していて NSManagedObjectContext に変更が入った場合は NSFetchedResultsControllerDelegate へコールバックする(③ コールバック)。

コールバックされたらモデルの変更状況をビューである UITableView へ反映させる(④ 表示更新)。

- - -
Xcode で新規プロジェクトを作成する時に Navigation-based Application を選び、"Use Core Data for storage" にチェックを入れると、データの取得に加え、コールバックメソッドの処理の雛形を生成してくれる。


参考情報


NSFetchedResultsController Class Reference
リファレンス。Overview は簡潔だがわかりやすい。delegate と cache の話がまとめられている。
NSFetchedResultsControllerDelegate
コールバック用のプロトコル

下からせり上がってくる非モーダルなカスタムダイアログを作る (2)二段構え

2010年7月23日金曜日 | Published in | 0 コメント

このエントリーをはてなブックマークに追加

[前回] Cocoaの日々: 下からせり上がってくる非モーダルなカスタムダイアログを作る

前回作成したカスタムダイアログに修正を入れて二段構えにする。

二段構え


二段構えとは、初期表示ではボタンのみ表示し、指示を受けるとラベルがせり上がってくることを指す。前回も取り上げた Pastebot がこのインターフェイスを採用している。

最初はこう。


表で行選択すると選択件数を表示するラベルが出てくる。

前回のコードに手を入れてこれを実現する。

実装


まず Interface Buidler で上部に配置していた Label を下へ隠す。
こうなる。
次に CustomDialogViewController に制御用のメソッドを追加する。このメソッドではラベルのアニメーション制御と共にボタンの有効向制御も行う。
- (void)setEnabled:(BOOL)enabled
{
 if (enabled_ == enabled) {
  return;
 }

 enabled_ = enabled;
 self.button.enabled = enabled;
 
 CGRect frame = self.label.frame;

 if (enabled) {
  frame.origin.y -= frame.size.height;
 } else {
  frame.origin.y += frame.size.height;
 }
 [UIView animateWithDuration:ANIMATION_DURATION
      animations:^{self.label.frame = frame;}];
}
やっていることは簡単で -[UIView animateWithDuration:animations:] を使い、ラベルの Y座標を変更しているだけ。Blocksが使えるようになったのでコードが非常にすっきりしている。


実行結果


最初はこう。

ダイアログを開き

ラベルを開く


ソースコード


GitHubからどうぞ
DialogSample at 2010-07-23b from xcatsan's iOS-Sample-Code - GitHub

人気の投稿(過去 30日間)