UIViewController - 状態保存復元パターン

2010年8月5日木曜日 | Published in | 0 コメント

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

状態の保存と復元


他の UIViewController を呼び出したり、ピッカーを表示した時にメモリ不足が発生すると呼び出し元のビューが開放される。元の画面に戻った時に自動的にビューが再作成されるのだが、この時画面遷移前の状態を保存しておく必要のあるケースが多い。例えば、一覧画面で検索を行いその詳細画面を表示するケース。詳細画面から戻った時には直前の検索条件を保っておく必要がある。また UITableViewで編集モードに入っていて別画面で項目の編集を行った後に元の画面へ戻るケース。この場合も編集モードの状態で表示されるのが望ましい。ただ、これらの状態の多くはビューが保持している情報なので、ビューが破棄・再作成されると状態が消えてしまう。直前の状態を保つには、これらの状態を UIViewController 側で保存・復元する必要がある。


イベントの流れ


メモリ不足が発生する前に状態を保存し、再びビューが再作成されたタイミングで状態を復元した。これらをどのタイミング(イベント)でやるべきか。それを考える為に前回示した図を再掲する。

MyViewController の画面が消えた後の didDisappear: で状態を保存し、再びビューが作成された後の viewDidLoad で復元するのが良さそうだ。まとめるとこう:
イベント操作
viewWillDisappear:状態の保存
viewDidLoad状態の復元

実際 Appleが提供する次のサンプルでは次のタイミングで保存と復元を行っていた。
TableSearch

このサンプルでは検索条件の保存と復元を行っている。

[参考情報] Cocoaの日々: UISearchDisplayController 調査

コードを引用してみる。まずは保存から。
- (void)viewDidDisappear:(BOOL)animated
{
    // save the state of the search UI so that it can be
    //  restored if the view is re-created
    self.searchWasActive = [self.searchDisplayController isActive];
    self.savedSearchTerm = [self.searchDisplayController.searchBar text];
    self.savedScopeButtonIndex = [self.searchDisplayController.searchBar
         selectedScopeButtonIndex];
}

次に復元。
- (void)viewDidLoad
{
     :
     :
    // restore search settings if they were saved in didReceiveMemoryWarning.
    if (self.savedSearchTerm)
    {
        [self.searchDisplayController setActive:self.searchWasActive];
        [self.searchDisplayController.searchBar
                setSelectedScopeButtonIndex:self.savedScopeButtonIndex];
        [self.searchDisplayController.searchBar setText:savedSearchTerm];
        
        self.savedSearchTerm = nil;
    }
     :    
     :
}

viewDidDisappear で検索中であることを表すフラグや検索キーワード、スコープなどを保存し、viewDidLoad でそれらを復元している。なお viewDidLoad は一番最初の初期処理でも呼び出されるので、このコードでは self.savedSearchTerm をチェックして必要な時だけ復元を行うようにしている。

他に保存が必要なものとしては UITableView.editing などが考えられる。


動作確認の方法


別の画面を表示している時に iPhoneシミュレータの「メモリ警告をシミュレート」を使うと良い。

[参考] Cocoaの日々: 「メモリ警告をシミュレート」で didReceiveMemoryWarning を擬似的に発生

これを使うとメモリ不足がシミュレートされ、元の画面で didReceiveMemoryWarning、viewDidUnload と呼び出される。その後、元の画面へ戻ると viewDidLoad、viewWillAppear と呼び出される。

UIViewController - ビュー関連のイベントを整理する

2010年8月4日水曜日 | Published in | 0 コメント

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

ざっくりと図にまとめてみた。

UIViewController ビュー関連イベントまとめ


MyViewController と OtherViewController の2つの間で画面遷移を行った時に発生しうるビュー関連のイベントを図にまとめてみた。OtherViewController は -[UINavigationController pushViewController:animated:] で表示されたり、あるいは UIImagePickerController などを仮定している。

メモリ不足が発生するとビューの再作成が発生する。viewDidLoad はビューの作成毎に呼ばれる。メモリ不足は必ず発生する事象なので、通常はビューの再作成が発生することを前提として実装する必要がある。実機での経験では UIImagePickerController を使ってカメラ撮影などをする時によくビューの再作成が発生するようだ(元の画面へ戻った時に viewDidLoad が呼ばれる)。


メモリ不足時の動作確認


別の画面を表示している時に iPhoneシミュレータの「メモリ警告をシミュレート」を使うと上の図の状況を作り出せる。

[参考] Cocoaの日々: 「メモリ警告をシミュレート」で didReceiveMemoryWarning を擬似的に発生

これを使うとメモリ不足がシミュレートされ、元の画面で didReceiveMemoryWarning、viewDidUnload と呼び出される。その後、元の画面へ戻ると viewDidLoad、viewWillAppear と呼び出される。


参考情報

iPhoneアプリ開発時のメモリ管理で気をつけること - A Day In The Life
メモリ管理に関する説明。図もあってわかりやすい。参考になった。

遅延実行を Blocksで記述する

2010年8月3日火曜日 | Published in | 0 コメント

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

数秒後に指定した Blocks を実行するメソッドを作ってみた。利用イメージはこんな感じ。

[self performBlock:^(void) {
  self.label.text = @"DONE-4"; }
 afterDelay:4];


performSelector:withObject:afterDelay:


NSObject には数秒後に指定したメッセージを投げるメソッドが用意されている。
NSObject Class Reference - performSelector:withObject:afterDelay:

これを利用して渡された Blocksを実行するメソッドを用意する。今回は NSObject のカテゴリとして実装してみた。

こんな感じ。
@interface NSObject (Extension)
- (void)performBlock:(void (^)(void))block afterDelay:(NSTimeInterval)delay;
@end

- (void)executeBlock__:(void (^)(void))block
{
 block();
 [block release];
}

- (void)performBlock:(void (^)(void))block afterDelay:(NSTimeInterval)delay
{
 [self performSelector:@selector(executeBlock__:)
      withObject:[block copy]
      afterDelay:delay];
}

performBlock:afterDelay: が呼ばれたら、performSelector:withObject:afterDelay: を使い別途用意したメソッド executeBlock__: を遅延実行する。これだけ。


サンプル


ソースコードは GitHub からどうぞ。
PerformSelectorAfterDelay at 2010-08-03 from xcatsan's iOS-Sample-Code - GitHub

UILabelを一つ置いてこれを数秒後とに書き換える。

コードはこんな感じ。
- (void)viewWillAppear:(BOOL)animated {

 [self performBlock:^(void) {self.label.text = @"DONE-1";}
   afterDelay:1];

 [self performBlock:^(void) {self.label.text = @"DONE-2";}
   afterDelay:2];

 [self performBlock:^(void) {self.label.text = @"DONE-3";}
   afterDelay:3];

 [self performBlock:^(void) {self.label.text = @"DONE-4";}
   afterDelay:4];
}
1秒ごとにメッセージを書き換えている。

実行すると1秒毎にメッセージが書き換わる。


補足


Blocks はデフォルトでスタックフレーム上に作られる。また Blocks内でメンバ変数が参照されている場合は self が retain され、なおかつ Blocksオブジェクトでの管理対象となる(self というメンバ変数が用意される。また消滅時に releaseされる)。

performBlock:afterDelay: が呼ばれた時の状態は次の通り。
block オブジェクトに selfというメンバ変数があるのがわかる。また block 自体は 0xbfffd528 といった高アドレスに配置されていることからスタックフレーム上にあることが推測できる。

今回は次のように copy を使い、performSelector:withObject:afterDealy: に渡している。
[self performSelector:@selector(executeBlock__:)
     withObject:[block copy]
     afterDelay:delay];
仮に copy を使わないとどうなるのか。次のようにして、executeBlock__ が呼ばれた時の変数を見てみよう。
[self performSelector:@selector(executeBlock__:)
     withObject:block
     afterDelay:delay];
self が無い。これは Blocksがレキシカルスコープを抜けて開放されてしまった為。performSelector:withObject:afterDelay: は非同期実行を行うため,呼び出し後に結果を待つこと無く次の処理へ進む。すると performBlock:afterDelay: を呼び出した側の viewWillAppear: へ制御が戻り、このメソッドも最後まで実行されて終了する。この時 Blocksがスコープを外れるために開放される。その結果、executeBlock__ が呼ばれた時には self が利用できなくなっている(実際には block自体も開放されているので使えない。今回は単純なサンプルなのでたまたまスタックフレームに残っていた blockが参照できたものと思われる)。

このままでは Blocks内で self が使えない。この場合には Blocksをスタックフレームからヒープへ移動させれば良い。その為に Block_copy() が用意されおり、Cocoaを使う場合には copy が利用できる。copyを使った場合の executeBlock__ 内での状態は次の通り。

self が存在する。また blockのアドレスも以前よりも低アドレスに配置されていることがわかる(なのでスタックフレームに配置されているものではないと推測できる)。


参考情報

Blocks Programming Topics: Introduction
Appleによる Blocksの解説
Programming with C Blocks on Apple Devices
丁寧に書かれていて非常に役に立った。Blocksが関数ポインタを利用していることがわかるとスタックとヒープを意識しなければならないことが理解できる。
C/Objective-C + Blocks でクロージャ - TrashSUITE
こちらも参考になった。

-[UITableViewCell setEditing:animated:] は表示の度に呼び出される

2010年8月2日月曜日 | Published in | 0 コメント

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

UITableViewCell Class Reference

-[UITableViewCell setEditing:animated:] が呼び出されるタイミングは次の3つ。

1. 明示的にメソッドを呼び出した時
[cell setEditing:YES animated:YES]

2. セルが載っている UITableView で setEditing:animated: が呼ばれた時
[self.tableView setEiditing:YES animated:YES]

3. 隠れていたセルが表示される時

- - - -
3. が曲者。てっきり 1, 2のケースだけだと思い込んでセル上の編集モードに入った時の初期化コードを書いておいたら、意図せず毎回初期化されてハマってしまった。UITableView でスクロールなどした時に隠れていたセルが表示されるタイミングで setEditingの値に関係なく必ず呼び出される。通常 UITableViewCell は再利用されるので、編集モードを正しく保つために毎回呼び出しているのだと思われる。

UISearchDisplayController 利用時の注意点[2]

| Published in | 0 コメント

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

以前、UISearchDisplayController を使う場合の注意点を書いた。その補足。

Cocoaの日々: UISearchDisplayController で用意される UITableView を扱う上での注意点


self.tableView


検索実行中は UITableViewController の self.tableView が UITableView から UISearchResultsTableView に変わる。この為、self.tableView を使う場合はどちらのビューなのかを意識する必要がある。例えば、-[UITableView indexPathForCell:] を使って UITableViewCell から NSIndexPath を取得する場合など。この場合、UISearchResultsTableView に載っている UITableViewCell を UITableViewの方へ渡しても正しい結果が得られない。

[例]
UITableCell* cell = ...   // UISearchResultsTableView上の UITableViewCell
NSIndexPath* indexPath = [self.tableView indexPathForCell:cell];
該当する UITableViewCell が self.tableViewには無いため indexPath は nil となる。


UITableView と UISearchResultsTableView の使い分け


この問題を回避する為に self.tableView を使わずに検索状態によって UITableView と UISearchResultsTableView を使い分ける必要がある。こんな感じ。
[例]
UITableView* tableView = nil;
if (self.searchDisplayController.active) {
 tableView = self.searchDisplayController.searchResultsTableView;
} else {
 tableView = self.tableView;
}
検索中の時は activeプロパティが有効になる。また、UISearchResultsTableView は UISearchDisplayController から取得できる。


参考情報


UISearchDisplayController Class Reference

CoreData - 最大値をもつ NSManagedObject を取得するコード見本

| Published in | 0 コメント

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

以前、最大値の求め方について書いた。

Cocoaの日々: Core Data - 最大値を取得する

では、その最大値を持つ NSManagedObject を取得するにはどうしたら良いのか?


コード例


こんな感じ。
- (NSManagedObject*)lastTimeStampObject
{
    NSManagedObjectContext* moc = self.managedObjectContext;
    NSFetchRequest* request = [[[NSFetchRequest alloc] init] autorelease];

    NSEntityDescription* entity = [NSEntityDescription entityForName:@"Event"
                                              inManagedObjectContext:moc];
    [request setEntity:entity]; 

    NSSortDescriptor* sort = [NSSortDescriptor sortDescriptorWithKey:@"timeStamp"
                                                           ascending:NO];
    [request setSortDescriptors:[NSArray arrayWithObject:sort]];
    [request setFetchLimit:1];

    NSError* error = nil;
    NSArray* results = [moc executeFetchRequest:request error:&error];
    
    if ([results count] > 0) {
        return [results objectAtIndex:0];
    } else {
        return nil;
    }
}

timeStamp の降順で検索をかけ、1番目の要素を返している。
出力されているSQLは次の通り。
CoreData: sql: SELECT 0, t0.Z_PK, t0.Z_OPT, t0.ZTIMESTAMP
 FROM ZEVENT t0 ORDER BY t0.ZTIMESTAMP DESC LIMIT 1

-[NSFetchRequest setFetchLimit:1] を指定により SQLでも 'LIMIT 1'が付与されている。この為結果は1もしくは0(まったくレコードが無い)のどちらかになる。



サンプル


Xcodeで生成される CoreDataサンプルコードに手を加えてみた。


左下のボタンを押すと最大値を持つ NSManagedObject の descriptionがデバッグコンソールへ出力される。

ソースコード


GitHub からどうぞ
LargestManagedObject at 2010-08-02 from xcatsan's iOS-Sample-Code - GitHub

CoreData - 集計関数

2010年8月1日日曜日 | Published in | 1 コメント

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

集計指示子


以前、最大値を求めるコードを紹介した。
Cocoaの日々: Core Data - 最大値を取得する

この時は -[NSExpression expressionForFunction:argument:] の第一引数に @"max:" を渡していた。
NSExpression *expression =
 [NSExpression expressionForFunction:@"max:"
   arguments:[NSArray arrayWithObject:keyPathExpression]];
ここを sum: にすると合計になるし count: だと個数を求めることができる。Objective-C コードは長いものになるが、実際に発行されている SQL はたった一行になる。以下、max:, sum:, count: を指定した場合の実例。
CoreData: sql: SELECT max( t0.ZTREATEDDATE) FROM ZKARTE t0 WHERE  t0.ZCUSTOMER = ? 
CoreData: sql: SELECT COUNT( t0.ZTREATEDDATE) FROM ZKARTE t0 WHERE  t0.ZCUSTOMER = ?
CoreData: sql: SELECT total( t0.ZFEE) FROM ZKARTE t0 WHERE  t0.ZCUSTOMER = ? 


関数


あらかじめ利用可能な関数が定義されている。定義は下記のリファレンスで確認できる。
NSExpression Class Reference - expressionForFunction:argument

以下に引用する。
average:
sum:
count:
min:
max:
median:
mode:
stddev:
add:to:
from:subtract:
multiply:by:
divide:by:
modulus:by:
sqrt:
log:
ln:
raise:toPower:
exp:
ceiling:
abs:
trunc:
random
random:
now
floor:
uppercase:
lowercase:
bitwiseAnd:with:
bitwiseOr:with:
bitwiseXor:with:
leftshift:by:
rightshift:by:
onesComplement:
noindex:

標準的な集計関数の他、random や now といったユニークなものまで用意されている。

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