生成された iOS SDK を使用する

Firebase Data Connect クライアント SDK を使用すると、Firebase アプリからサーバーサイドのクエリとミューテーションを直接呼び出すことができます。カスタムクライアント SDK は、サービスにデプロイするスキーマ、クエリ、ミューテーションを設計するのと Data Connect並行して生成します。次に、この SDK のメソッドをクライアントロジックに統合します。

他の場所でも説明したように、Data Connect クエリとミューテーションはクライアントコードによって送信され、サーバーで実行されるわけではないことに注意してください。デプロイすると、Data Connect オペレーションは Cloud Functions のようにサーバーに保存されます。つまり、既存のユーザー（古いアプリのバージョンなど）に影響を与えないようにするには、対応するクライアントサイドの変更をデプロイする必要があります。

そのため、Data Connect には、サーバーにデプロイされたスキーマ、クエリ、ミューテーションのプロトタイプを作成できる開発環境とツールが用意されています。また、プロトタイプ作成時にクライアントサイド SDK が自動的に生成されます。

サービスアプリとクライアントアプリの更新を繰り返したら、サーバーサイドとクライアントサイドの両方の更新をデプロイできます。

クライアント開発ワークフローとは

スタートガイドに沿って進めた場合は、スタートガイドに沿って進めた場合は、全体的な開発フローについて説明しました。Data Connectこのガイドでは、スキーマから Swift SDK を生成し、クライアントのクエリとミューテーションを操作する方法について詳しく説明します。

まとめると、生成された Swift SDK をクライアントアプリで使用するには、次の前提条件の手順を行います。

Firebase を iOS アプリに追加します。
生成された SDK を使用するには、Xcode で依存関係として構成します。

Xcode の上部のナビゲーションバーで、[File] > [Add Package Dependencies] > [Add Local] を選択し、生成された Package.swift を含むフォルダを選択します。

その後の操作は次のとおりです。

アプリのスキーマを開発します。
SDK の生成を設定します。
- Data Connect VS Code 拡張機能の [Add SDK to app] ボタンを使用する
- を更新するconnector.yaml
クライアントコードを初期化してライブラリをインポートします。
クエリとミューテーションの呼び出しを実装します。
Data Connect エミュレータを設定して使用し、Data Connectエミュレータと反復処理を行います。

Swift SDK を生成する

Firebase CLI を使用して、アプリに Data Connect で生成された SDK を設定します。 init コマンドは、現在のフォルダ内のすべてのアプリを検出し、生成された SDK を自動的にインストールします。

firebase init dataconnect:sdk

プロトタイプ作成中に SDK を更新する

Data Connect VS Code 拡張機能がインストールされている場合は、生成された SDK が常に最新の状態に保たれます。

Data Connect VS Code 拡張機能を使用しない場合は、Firebase CLI を使用して、生成された SDK を最新の状態に保つことができます。

firebase dataconnect:sdk:generate --watch

ビルドパイプラインで SDK を生成する

Firebase CLI を使用して、CI/CD ビルドプロセスで Data Connect SDK を生成できます。

firebase dataconnect:sdk:generate

Data Connect iOS SDK を初期化する

Data Connect の設定に使用した情報（Firebase コンソールの Data Connect タブで確認できます）を使用して、Data Connect インスタンスを初期化します。

コネクタインスタンスを取得する

コネクタのコードは、 Data Connect エミュレータによって生成されます。connector.yaml で指定されているように、コネクタ名が movies でパッケージが movies の場合は、次の呼び出しでコネクタオブジェクトを取得します。

let connector = DataConnect.moviesConnector

クエリとミューテーションを実装する

コネクタオブジェクトを使用すると、GraphQL ソースコードで定義されているクエリとミューテーションを実行できます。コネクタに次のオペレーションが定義されているとします。

mutation createMovie($title: String!, $releaseYear: Int!, $genre: String!, $rating: Int!) {
  movie_insert(data: {
    title: $title
    releaseYear: $releaseYear
    genre: $genre
    rating: $rating
  })
}

query getMovieByKey($key: Movie_Key!) {
  movie(key: $key) { id title }
}

query listMoviesByGenre($genre: String!) {
  movies(where: {genre: {eq: $genre}}) {
    id
    title
  }
}

次のようにムービーを作成できます。

let mutationResult = try await connector.createMovieMutation.execute(
  title: "Empire Strikes Back",
  releaseYear: 1980,
  genre: "Sci-Fi",
  rating: 5)

print("Movie ID: \(mutationResult.data.movie_insert.id)")

ムービーを取得するには、クエリ参照を使用します。すべてのクエリ参照は Observable パブリッシャーです。構成されたパブリッシャー（connector.yaml)を参照）に応じて、@Observableマクロ（iOS 17 以降）をサポートするか、ObservableObjectプロトコルを実装します。指定しない場合のデフォルトは、iOS 17 以降でサポートされている @Observable マクロです。

SwiftUI ビューでは、クエリ参照の公開された data 変数を使用してクエリ結果をバインドし、クエリの execute() メソッドを呼び出してデータを更新できます。data 変数は、GQL クエリ定義で定義されたデータの形状と一致します。

取得した結果はすべて Decodable プロトコルに準拠しています。GQL フェッチにオブジェクトの主キーを含めた場合、オブジェクトは Identifiable でもあるため、イテレータで使用できます。

struct ListMovieView: View {
    @StateObject private var queryRef = connector.listMoviesByGenreQuery.ref(genre: "Sci-Fi")
    var body: some View {
        VStack {
            Button {
                Task {
                    do {
                        try await refresh()
                    } catch {
                        print("Failed to refresh: \(error)")
                    }
                }
            } label: {
                Text("Refresh")
            }
                // use the query results in a view
            ForEach(queryRef.data?.movies ?? [], id: \.self.id) { movie in
                    Text(movie.title)
                }
            }
    }
    @MainActor
    func refresh() async throws {
        _ = try await queryRef.execute()
    }
}

クエリは 1 回限りの実行もサポートしています。

let resultData = try await DataConnect.moviesConnector.listMoviesByGenreQuery.execute(genre: "Sci-Fi")

列挙フィールドの変更を処理する

アプリのスキーマには、列挙型を含めることができます。これは、GraphQL クエリでアクセスできます。

アプリのデザインが変更されると、列挙型でサポートされる新しい値を追加できます。たとえば、アプリケーションのライフサイクルの後半で、AspectRatio 列挙型に FULLSCREEN 値を追加するとします。

Data Connect ワークフローでは、ローカル開発ツールを使用してクエリと SDK を更新できます。

ただし、クライアントの更新バージョンをリリースする前に、デプロイ済みの古いクライアントが破損する可能性があります。

復元力のある実装例

生成された列挙型には _UNKNOWN 値が含まれており、Swift では網羅的な switch ステートメントが強制されるため、生成された SDK では不明な値の処理が強制されます。

do {
    let result = try await DataConnect.moviesConnector.listMovies.execute()
    if let data = result.data {
        for movie in data.movies {
            switch movie.aspectratio {
                case .ACADEMY: print("academy")
                case .WIDESCREEN: print("widescreen")
                case .ANAMORPHIC: print("anamorphic")
                case ._UNKNOWN(let unknownAspect): print(unknownAspect)
            }
        }
    }
} catch {
    // handle error
}

iOS アプリのプロトタイプを作成してテストする

ローカルエミュレータを使用するようにクライアントをインストルメントする

Data Connect エミュレータは、 Data Connect VS Code 拡張機能または CLI から使用できます。

エミュレータに接続するようにアプリをインストルメントする方法は、どちらのシナリオでも同じです。

let connector = DataConnect.moviesConnector
// Connect to the emulator on "127.0.0.1:9399"
connector.useEmulator()

// (alternatively) if you're running your emulator on non-default port:
connector.useEmulator(port: 9999)

// Make calls from your app

Data Connect SDK のデータ型

Data Connect サーバーは、一般的な GraphQL データ型とカスタム GraphQL データ型を表します。これらは SDK で次のように表されます。

Data Connect 型	Swift
文字列	文字列
Int	Int
浮動小数点数	Double
ブール値	Bool
UUID	UUID
日付	FirebaseDataConnect.LocalDate
タイムスタンプ	FirebaseCore.Timestamp
Int64	Int64
すべて	FirebaseDataConnect.AnyValue