Realm オブジェクトモデル - SwiftUI

項目一覧

概念: オブジェクトモデルと関係

オブジェクトモデルを UI にバインドする
SwiftUI ビューのデータの変換
新しいオブジェクトの定義
プロジェクションを定義する

Atlas Device SDK は非推奨です。詳細については、の廃止ページを参照してください。

概念: オブジェクトモデルと関係

SwiftUI のモデリングデータは、Swift SDK の同じオブジェクトモデルと関係の概念上で構築されます。 Realm Swift SDK データモデリングの概念が詳しくない場合は、「 Realm オブジェクトモデルの定義 - Swift SDK 」を参照してください。

オブジェクトモデルを UI にバインドする

モデルビューモデル（MVVM）設計パターンでは、ビューコードからモデルを抽象化するビューモデルの作成が推奨されます。 Realm を使用してそれを確実に実行できますが、Swift SDK は、SwiftUI ビューでデータを直接操作しやすくするツールを提供します。これらのツールには、次のようなものが含まれます。

基礎となる観察可能なオブジェクトへのバインディングを作成するプロパティラッパー
特定のビューで使用するために基礎となるモデルオブジェクトをプロジェクションおよび変換するクラス

SwiftUI ビューのデータの変換

Realm Swift SDK は、データのサブセットを変換して操作するためのプロジェクションと呼ばれる特殊なタイプのオブジェクトを提供します。ビューモデルのようなプロジェクションを考えてみましょう。これを使用すると、元のオブジェクトのプロパティをさまざまな方法で渡したり変換したりできます。

パス経由: プロジェクションのプロパティは、元のオブジェクトと同じ名前とタイプです。
名前の変更: プロジェクションのプロパティは元のオブジェクトと同じタイプですが、名前が異なります。
キーパスの解決: これを使用して、プロジェクションされたオブジェクトの特定のプロパティにアクセスします。
コレクションマッピング: 一部のコレクションタイプをプリミティブ値のコレクションにマッピングできます。
除外: プロジェクションモデルで定義されていない、元の Realm オブジェクトのすべてのプロパティ。これらのプロパティを変更しても、プロジェクションを観察するときに変更通知はtriggerされません。

プロジェクションを使用すると、Realm のライブオブジェクトのすべてのメリットが得られます。

クラスプロジェクションされたオブジェクトのライブアップデート
変更を観察できます
書込みトランザクション (write transaction) でプロパティに直接変更を適用できます

新しいオブジェクトの定義

オブジェクトクラスまたは埋め込みオブジェクトクラスから派生することで、Realm オブジェクトを定義できます。クラスの名前はRealm内のテーブル名になり、クラスのプロパティはデータベースに永続します。そのため、永続化されたオブジェクトの操作は、通常の Swift オブジェクトの操作と同様に簡単になります。

Realm SwiftUI ドキュメントでは、架空のアプリ DogoDB のモデルを使用しています。このアプリは、犬のいる従業員の会社ディレクトリです。これにより、従業員は犬に関するいくつかの詳細を他の従業員と共有できます。

データモデルには、その人の犬のオブジェクトとの対多の関係を持つ人のオブジェクトが含まれています。また、特別な Realm Swift SDK データ型（ PersistableEnum ）を使用して、個人のビジネスユニットに関する情報を保存します。

class Person: Object, ObjectKeyIdentifiable {
    @Persisted(primaryKey: true) var _id: ObjectId
    @Persisted var firstName = ""
    @Persisted var lastName = ""
    @Persisted var personId = ""
    @Persisted var company = "MongoDB"
    @Persisted var businessUnit = BusinessUnitEnum.engineering
    @Persisted var profileImageUrl: URL?
    @Persisted var dogs: List<Dog>
}
enum BusinessUnitEnum: String, PersistableEnum, CaseIterable {
    case customerEngineering = "Customer Engineering"
    case educationCommunityAndDocs = "Education, Community and Docs"
    case engineering = "Engineering"
    case financeAndOperations = "Finance and Operations"
    case humanResourcesAndRescruiting = "Human Resources and Recruiting"
    case management = "Management"
    case marketing = "Marketing"
    case product = "Product"
    case sales = "Sales"
}
class Dog: Object, ObjectKeyIdentifiable {
    @Persisted(primaryKey: true) var _id: UUID
    @Persisted var name = ""
    @Persisted var breed = ""
    @Persisted var weight = 0
    @Persisted var favoriteToy = ""
    @Persisted var profileImageUrl: URL?
    @Persisted var dateLastUpdated = Date()
    @Persisted(originProperty: "dogs") var person: LinkingObjects<Person>
    var firstLetter: String {
        guard let char = name.first else {
            return ""
        }
        return String(char)
    }
}

Tip

以下も参照してください。

Realm オブジェクトモデルの定義の詳細については、次を参照してください。

プロジェクションを定義する

この架空の DogoDB アプリにはユーザープロファイルビューがあります。このビューにはその人に関する一部の詳細が表示されますが、 Personモデルのプロパティがすべて必要なわけではありません。必要な詳細のみを含むプロジェクションを作成できます。また、 lastNameプロパティを変更して、姓の最初の接続文字列のみを使用することもできます。

class Profile: Projection<Person> {
    @Projected(\Person.firstName) var firstName // Passthrough from original object
    @Projected(\Person.lastName.localizedCapitalized.first) var lastNameInitial // Access and transform the original property
    @Projected(\Person.personId) var personId
    @Projected(\Person.businessUnit) var businessUnit
    @Projected(\Person.profileImageUrl) var profileImageUrl
    @Projected(\Person.dogs) var dogs
}

このプロジェクションは、元のPersonオブジェクトの代わりに、プロファイルビューで使用できます。

クラスプロジェクションは SwiftUI プロパティラッパーで動作します。

Tip

以下も参照してください。

SwiftUIアプリケーションでクラスプロジェクションを使用する完全な例については、「プロジェクション例アプリ」を参照してください。

戻る

モデルデータ

オブジェクトモデルの変更