Swift 同時実行性 - Swift SDK

Realm の同時実行に関する警告

アプリに同時実行機能を実装する際は、Realm のスレッド モデルと Swift の同時実行スレッド動作に関するこの警告を考慮してください。

Async/Await API

Atlas App Services アプリまたは同期された Realm の操作を伴う Realm Swift API の多くは、Swift の async/await 構文と互換性があります。 例については、以下をご覧ください。

• Async/Await ログイン

• メール/パスワードユーザーの管理

• ユーザー ID のリンク - Async/Await

• 同期された RealmまたはローカルRealm を開きます

• 別のアクターからの通知を待つ

• Flexible Sync サブスクリプションの管理

• Async/Await サーバーレス関数の呼び出し

• Async/Await クエリ MongoDB

• Async/Await CRUD 操作

Swift async/await API に関連する特定の機能リクエストがある場合は、 Realm 用の MongoDB フィードバック エンジン を確認してください。 Realm Swift SDK チームは、コミュニティ フィードバックと Swift の同時実行性の変化に基づいて、同時実行関連の機能を引き続き開発する予定です。

タスクと TaskGroup

Swift同時実行性は、 Tasks と TaskGroups を管理するための API を提供します。Swift同時実行ドキュメントでは、プログラムの一部として非同期に実行できる作業単位としてタスクを定義しています。タスクを使用すると、非同期作業の単位を具体的に定義できます。TaskGroup を使用すると、親 TaskGroup の下のユニットとして実行するタスクのコレクションを定義できます。

Task と TaskGroup は、スレッドを他の重要な作業に渡したり、他の操作をブロックする可能性のある長時間実行のタスクをキャンセルしたりする機能を提供します。 これらの利点を得るには、 Tasks と TaskGroup を使用して Realm 書込み (write) をバックグラウンドで管理しなければならない場合があります。

ただし、上記のAwait による実行の一時停止で説明されているスレッド定義の制約は、Task コンテキストで適用されます。 タスクにawaitポイントが含まれている場合、後続のコードが別のスレッドで実行または再開され、Realm のスレッド制限に違反する可能性があります。

Realm にアクセスするコードがメイン スレッドでのみ実行されるようにするには、Task コンテキストで実行する関数を@MainActorで注釈を付ける必要があります。 これにより、Tasks を使用する利点の一部が否定され、ユーザー管理などのネットワーク アクティビティのみに Task を使用している場合を除き、Realm を使用するアプリの設計選択は適していない可能性があります。

アクターの分離

アクターの分離により、Realm アクセスは専用のアクターへのアクセスに制限されているという認識が提供されるため、非同期コンテキストで Realm アクセスを安全に管理できるようになります。

ただし、 @MainActor以外の非同期関数での Realm の使用は現在サポートされていません。

Swift 5.6 では、これは多くの場合、一致によって機能します。 awaitの後の実行は、待機しているものが実行されたスレッドで続行されます。 非同期関数でawait Realm()を使用すると、アクター分離された関数を次に呼び出すまで、メインスレッドで実行されるコードは次のコードになります。

Swift 5.7 では、代わりにアクター分離コンテキストを変更するたびにスレッドがスローされます。 代わりに、分離されていない非同期関数は常にバックグラウンド スレッドで実行されます。

await Realm()を使用し、5.6 で動作するコードがある場合、関数を@MainActorとしてマークすると、Swift 5.7 で動作するようになります。 5.6 では、意図せずにどのように実行されたかが関数されます。

同時実行コードに関連するエラー

同時実行コードによる Realm へのアクセスに関連するエラーは、ほとんどの場合、 Realm accessed from incorrect thread.です。これは、このページで説明されているスレッド分離の問題が原因です。

Swift 同時実行機能を使用するコードでスレッド関連の問題を回避するには、次の手順に従います。

• アクター分離された Realm をサポートする Realm Swift SDK のバージョンにアップグレードし、スレッドを手動で管理する代替として使用します。 詳細については、 「 アクターで Realm を使用する - Swift SDK 」を参照してください。

• Realm にアクセスするときは、実行コンテキストを変更しないでください。 メイン スレッドで Realm を開き、UI のデータを提供する場合は、Realm に非同期にアクセスする後続の関数に@MainActorを使用して注釈を付け、常にメイン スレッドで実行されるようにします。 awaitは別のスレッドに変更可能な停止点をマークしています。

• アクター分離 Realm を使用しないアプリは、 writeAsync API を使用して バックグラウンド書込み を実行できます。 これにより、自分で処理するための専用コードを記述しなくても、Realm アクセスをスレッドセーフに管理できます。 これは、書込みプロセスの一部をアウトソースする特別な API であり、非同期コンテキストで実行するために安全です。 アクター分離された Realm に書き込まれない限り、Swift のasync/await構文ではこのメソッドは使用されません。 このメソッドは、コード内で同期的に使用します。 あるいは、非同期 Realm への書き込みを待機するときに、Swift のasync/await構文でasyncWrite API を使用することもできます。

• スレッド関連のクラッシュを回避するために、該当するスレッドに インスタンスを明示的に渡すことができます。 これには、Realm のスレッド モデルを十分に理解する必要と、Swift の同時実行スレッド動作に留意する必要があります。

送信可能タイプ、非送信タイプ、スレッド付きタイプ

Realm Swift SDK パブリック API には、次の 3 つの大きなカテゴリに分類されるタイプが含まれています。

• 送信可能

• 送信不可、およびスレッド定義なし

• スレッドのみ

送信可能ではなく、スレッドが限定されない型をスレッド間で共有できますが、これらは同期する必要があります。

スレッド定義型は、固定されていない限り、分離コンテキストに制限されます。 同期を使用しても、これらのコンテキスト間でそれらを渡すことはできません。