iOSでSQLiteを使う２(FMDBのFMDatabaseQueueクラスを使ってみる)

FMDBにはスレッド間でSQLiteを使用する際のヘルパークラスが提供されています。そのクラスがFMDatabaseQueueです。 このクラスの用途と、どういったシーンで使用していけば良いのかを考えつつ、サンプルプログラムで試してみます。

因みに、FMDBの基本的な使い方に関しては前回書いた iOSでSQLiteを使う(FMDB) を参照。

マルチスレッドにおけるFMDatabaseインスタンスに関して

FMDBのREADMEにはFMDatabaseのインスタンスをシングルトンにして、マルチスレッド上から唯一のFMDatabaseインスタンスを 取得して使用することは推奨されておらず、一見うまく動いているようでも、いつかはクラッシュしたり、例外が 発生することになるだろうと書かれています。つまり、FMDatabaseクラスはスレッドセーフでは無いということになります。

ちなみに、シングルトンじゃなくてスレッド毎にFMDatabaseインスタンスを生成すれば良いんじゃ？という考え方もあるかもしれない。 確かにそのアプローチもアリかと思いますが、FMDBのトランザクションが読み取り・書き込み排他ロックをデフォルトに してるっぽいので、複数インスタンスを生成してもDBへのアクセスは結局排他されるのであまり意味が無く、余計にメモリ を使用してしまうだけだと思う。（beginTransactionでトランザクションを開始した場合）
beginDeferredTransactionにてトランザクションを開始した場合は、読み取りは共有ロックになるので、 更新中の読み取りが可能になりますが、そもそもSQLiteへのアクセスは自身のアプリケーションからのみであるため そうそう更新中の読み取りを実施したいという要望は無いはず。それより、SQLiteへのアクセスは直列化してアクセスさせ、 処理をシンプルにする方がメリットが大きいのではないでしょうか。

試しにマルチスレッド上で同一のFMDatabaseインスタンスを使ってみる

以下のコードは、DBを検索してその結果を文字列としてUITextView上に表示するという処理を 10個の新たなスレッド上で実行させています。 ちなみに、以下コードのDB検索部分を載せていませんが 前回の記事 と同じものです。

    //結果取得して画面描画を別スレッドで行う
    //スレッドはNSOperationQueueにて生成
    NSOperationQueue *opeQueue = [[NSOperationQueue alloc]init];

    //同期用のオブジェクト（インデックス表示用）
    NSObject *sync = [[NSObject alloc]init];
    static int index = 0;

    //スレッド実行部分のブロック処理
    void (^exec)(void)  = ^(void) {
        int _index = 0;
        @synchronized(sync) {
            index++;
            NSLog(@"新しいスレッド。index : %d.", index);
            _index = index;
        }
        
        //DB検索を実行
        NSArray *result = [db executeQuery2];
        //検索結果の文字列を作成
        NSString *text = [NSString stringWithFormat:@"%d\n", _index];
        for (ExampleRecord *record in result) {
            text = [text stringByAppendingString:
                    [NSString stringWithFormat:@"%d, %@, %@, %f\n",
                        record.columnOfInteger,
                        record.columnOfDate,
                        record.columnOfText,
                        record.columnOfReal]];
        }
        
        //特に意味ないけど、2秒スリープ
        [NSThread sleepForTimeInterval: 2.0];
        //画面に表示。メインスレッド以外からの更新なのでperformSelectorOnMainThreadを使用。
        if ([result count] != 0) {
            [self performSelectorOnMainThread:@selector(updateTextView:) withObject:text waitUntilDone:NO];
        }

    };//end of the block.
    
    //新しいスレッドを生成し実行
    [opeQueue addOperationWithBlock: exec];
    [opeQueue addOperationWithBlock: exec];
    [opeQueue addOperationWithBlock: exec];
    [opeQueue addOperationWithBlock: exec];
    [opeQueue addOperationWithBlock: exec];
    [opeQueue addOperationWithBlock: exec];
    [opeQueue addOperationWithBlock: exec];
    [opeQueue addOperationWithBlock: exec];
    [opeQueue addOperationWithBlock: exec];
    [opeQueue addOperationWithBlock: exec];

上記処理を何度も実行すると以下のような例外が発生します。以下は例外時のイメージですが、 結構何度も実行させてやっと発生した感じです。通常は例外が発生しないでFMDBの各メソッドがエラー返却される パターンが殆どでした。まあ、エラーになることはこれで分かりました。

・デバッガ

・標準出力結果(backtrace)

FMDatabaseQueueを使用して実行してみる

マルチスレッド上からFMDatabaseQueueを使用してDB検索を実行してみます。

    //結果取得して画面描画を別スレッドで行う
    //スレッドはNSOperationQueueにて生成
    NSOperationQueue *opeQueue = [[NSOperationQueue alloc]init];

    //同期用のオブジェクト（インデックス表示用）
    NSObject *sync = [[NSObject alloc]init];
    static int index = 0;

    //スレッドで実行するブロック定義
    void (^exec)(void) = ^(void) {
        int _index=0;
        //各スレッドで表示するインデックスインクリメント
        //ここはログ表示用なのであまり気にしないで下さい。
        @synchronized(sync) {
            index++;
            _index = index;
        }
        NSLog(@"新しいスレッド。index : %d.", _index);        
        
        //SQLを実行。以下のメソッド内でFMDatabaseQueueクラスを使用しています。
        [db executeQuery3:self index:_index];
    };
    
    //スレッド実行
    [opeQueue addOperationWithBlock:exec];
    [opeQueue addOperationWithBlock:exec];
    [opeQueue addOperationWithBlock:exec];
    [opeQueue addOperationWithBlock:exec];
    [opeQueue addOperationWithBlock:exec];
    [opeQueue addOperationWithBlock:exec];
    [opeQueue addOperationWithBlock:exec];
    [opeQueue addOperationWithBlock:exec];
    [opeQueue addOperationWithBlock:exec];
    [opeQueue addOperationWithBlock:exec];

実際にDBアクセス部分(上記のexecuteQuery3というメソッド)のコードは以下になります。 以下コードで、_dbQueueという変数がFMDatabaseQueueのインスタンスです。インスタンス生成部分のコードは 別途示します。

- (void)executeQuery3:(id)delegate index:(int)index {
    if (_dbQueue) {

        //トランザクション無しのパターン
        //_dbQueue変数はFMDatabaseQueueのインスタンスです。生成は別途実施済みです。
        [_dbQueue inDatabase:^(FMDatabase *db) {
            FMResultSet* rs = [db executeQuery:@"select * from example where t like ?", @"%2."];
            
            if ([db hadError]) {
                NSLog(@"Err %d: %@",
                      [db lastErrorCode], [db lastErrorMessage]);
            }

            NSString *text = [NSString stringWithFormat:@"%d\n", index];
            while ([rs next]) {
                text = [text stringByAppendingString:
                        [NSString stringWithFormat:@"%d, %@, %@, %f\n",
                                [rs intForColumnIndex:0],
                                [rs dateForColumnIndex:1],
                                [rs stringForColumnIndex:2],
                                [rs doubleForColumnIndex:3]]];
            }

            //sleep
            [NSThread sleepForTimeInterval:2.0];
            
            //update UI.
            [delegate performSelectorOnMainThread:@selector(updateTextView:) withObject:text waitUntilDone:NO];
        }];
        
        NSLog(@"call finished. index : %d.", index);
    }
}

このコードで何度か実行しましたが、例外やFMDBのクラスからエラーが発生することはありませんでした。 実行すると処理内で２秒スリープしているため２秒間隔で画面が更新されていきます（以下、赤字部分）。

・標準出力の結果

2012-05-08 06:52:00.515 FMDBTest[15557:f803] ViewDidLoad was finished.
2012-05-08 06:52:00.569 FMDBTest[15557:12e03] 新しいスレッド。index : 1.
2012-05-08 06:52:00.570 FMDBTest[15557:12f03] 新しいスレッド。index : 2.
2012-05-08 06:52:00.570 FMDBTest[15557:11103] 新しいスレッド。index : 3.
2012-05-08 06:52:00.571 FMDBTest[15557:13003] 新しいスレッド。index : 4.
2012-05-08 06:52:00.576 FMDBTest[15557:13203] 新しいスレッド。index : 5.
2012-05-08 06:52:00.580 FMDBTest[15557:13c03] 新しいスレッド。index : 6.
2012-05-08 06:52:00.588 FMDBTest[15557:14403] 新しいスレッド。index : 8.
2012-05-08 06:52:00.596 FMDBTest[15557:1450b] 新しいスレッド。index : 10.
2012-05-08 06:52:00.587 FMDBTest[15557:14203] 新しいスレッド。index : 7.
2012-05-08 06:52:00.595 FMDBTest[15557:14303] 新しいスレッド。index : 9.
2012-05-08 06:52:02.585 FMDBTest[15557:12e03] call finished. index : 1.
2012-05-08 06:52:04.588 FMDBTest[15557:12f03] call finished. index : 2.
2012-05-08 06:52:06.590 FMDBTest[15557:11103] call finished. index : 3.
2012-05-08 06:52:08.591 FMDBTest[15557:13003] call finished. index : 4.
2012-05-08 06:52:10.593 FMDBTest[15557:13203] call finished. index : 5.
2012-05-08 06:52:12.594 FMDBTest[15557:13c03] call finished. index : 6.
2012-05-08 06:52:14.596 FMDBTest[15557:14403] call finished. index : 8.
2012-05-08 06:52:16.598 FMDBTest[15557:1450b] call finished. index : 10.
2012-05-08 06:52:18.600 FMDBTest[15557:14203] call finished. index : 7.
2012-05-08 06:52:20.602 FMDBTest[15557:14303] call finished. index : 9.

・シュミレーター画面

上のコードをちょっと解説します。

・FMDatabaseQueueの生成部分
上記のサンプルコードには表れていませんが、FMDatabaseQueueのインスタンス生成はFMDatabaseの生成時と同じでDBパスを引数に指定します。

        _dbQueue = [FMDatabaseQueue databaseQueueWithPath:dbPath];

・FMDatabaseQueueへの処理依頼
処理はブロックで記載する必要があります。ここでいきなりブロックとは？となるかもしれませんが、、 すみません、ここではブロックの解説はしません。 FMDatabaseQueueは主に以下の２つのメソッドを提供しています。

• - (void)inDatabase:(void (^)(FMDatabase *db))block
• - (void)inTransaction:(void (^)(FMDatabase *db, BOOL *rollback))block;

トランザクションを必要としない場合(inDatabase)とする場合(inTransaction)です。 トランザクションを必要とする場合はロールバック有無を表す引数が存在します。 ちなみにこのrollbackの変数はC言語のポインタ型なので、値を設定する際は実体に設定する必要がありますので、 注意して下さい。

以下にFMDBのREADMEに載っているサンプルコードを示します。実体に値を設定するには *(アスタリスク)が必要です。＃C/C++をご存知のかたは特に注意する必要もないですが

    [queue inTransaction:^(FMDatabase *db, BOOL *rollback) {
                [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:1]];
                [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:2]];
                [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:3]];

                if (whoopsSomethingWrongHappened) {
                    //
                    //↓ここです。実体に設定するには*が必要です。
                    *rollback = YES;
                      return;
                }
                // etc…
                [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:4]];
    }];

FMDatabaseQueueクラスの機能

FMDatabaseQueue.mのソースを見れば分かりますが、このクラスは次の機能を提供します。

・直列ディスパッチキューを生成
Grand Central Dispatch(GCD)の直列ディスパッチキューを生成します。この直列キューはタスクを同時には 1つしか実行しないので、キューに登録した処理は必ず同期処理されます。つまり、FMDatabaseQueueは全てのSQLite へのアクセスを完全同期していることになります。

・同期型で実行
直列ディスパッチキューからの実行は同期型(dispatch_sync)で実行しているので、呼び出し元スレッドは ブロックされるので注意する必要があります。私はこの部分を勘違いしており、ブロックで指定したタスクは FMDBのQueue側で非同期に実行してくれるものだと勘違いしていました。つまり、重そうなSQLをFMDatabaseQueue にまかせれば後は勝手に非同期でやってくれる訳では無いということです。スレッドは自分で作成する必要があります。

---