Utiliser les SDK iOS générés

Les SDK client Firebase Data Connect vous permettent d'appeler vos requêtes et mutations côté serveur directement depuis une application Firebase. Vous générez un SDK client personnalisé en parallèle de la conception des schémas, des requêtes et des mutations que vous déployez sur votre service Firebase Data Connect.Data Connect Ensuite, vous intégrez les méthodes de ce SDK dans votre logique client.

Comme nous l'avons mentionné ailleurs, il est important de noter que les requêtes et les mutations Data Connect ne sont pas envoyées par le code client et ne sont pas exécutées sur le serveur. En revanche, une fois déployées, les opérations Data Connect sont stockées sur le serveur, comme Cloud Functions. Cela signifie que vous devez déployer les modifications côté client correspondantes pour éviter de perturber les utilisateurs existants (par exemple, sur les anciennes versions de l'application).

C'est pourquoi Data Connect vous fournit un environnement de développement et des outils qui vous permettent de prototyper vos schémas, requêtes et mutations déployés sur le serveur. Il génère également automatiquement des SDK côté client pendant que vous créez votre prototype.

Une fois que vous avez effectué des mises à jour itératives de vos applications de service et client, les mises à jour côté serveur et côté client sont prêtes à être déployées.

Qu'est-ce que le workflow de développement client ?

Si vous avez suivi la section Premiers pas, vous avez découvert le flux de développement global pour Data Connect. Dans ce guide, vous trouverez des informations plus détaillées sur la génération de SDK Swift à partir de votre schéma, ainsi que sur l'utilisation des requêtes et mutations client.

Vous pouvez apprendre à développer des clients avec un dépôt d'application de démarrage rapide et créer une application Data Connect complète en suivant notre atelier de programmation pour iOS.

En résumé, pour utiliser les SDK Swift générés dans vos applications clientes, vous devez suivre les étapes préalables suivantes :

1. Ajoutez Firebase à votre application iOS.

2. Pour utiliser le SDK généré, configurez-le comme dépendance dans Xcode.

   Dans la barre de navigation supérieure d'Xcode, sélectionnez File > Add Package Dependencies > Add Local (Fichier > Ajouter des dépendances de package > Ajouter localement), puis choisissez le dossier contenant le fichier Package.swift généré.

Puis :

1. Développez le schéma de votre application.

2. Configurez la génération du SDK :

   • Avec le bouton Ajouter le SDK à l'application de notre extension VS Code Data Connect
   • En mettant à jour votre connector.yaml

3. Initialisez votre code client et importez les bibliothèques.

4. Implémentez les appels aux requêtes et aux mutations.

5. Configurez et utilisez l'émulateur Data Connect, puis itérez.

Générer votre SDK Swift

Comme pour la plupart des projets Firebase, le code client Firebase Data Connect est développé dans un répertoire de projet local. L'extension VS Code Data Connect et la CLI Firebase sont des outils locaux importants pour générer et gérer le code client.

Les options de génération du SDK sont associées à plusieurs entrées du fichier dataconnect.yaml généré lors de l'initialisation de votre projet.

Initialiser la génération du SDK

Dans votre connector.yaml, ajoutez vos outputDir, package et (pour le SDK Web) packageJsonDir.

connectorId: "movies"
generate:
  swiftSdk:
    outputDir: "../movies-generated"
    package: "Movies"

outputDir indique l'emplacement où le SDK généré doit être placé. Si aucun répertoire n'est spécifié, le dossier du connecteur est utilisé comme répertoire de sortie par défaut.

package spécifie le nom du package qui sera généré. Le générateur crée un dossier portant le nom du package, contenant Package.swift et le code généré.

observablePublisher (facultatif) spécifie l'éditeur Observable à utiliser dans les références de requête. Les valeurs possibles sont observableMacro (iOS 17 et versions ultérieures) et observableObject (versions antérieures à iOS 17). Si aucune valeur n'est spécifiée, la valeur par défaut est observableMacro.

Remarque : Vous pouvez fournir un chemin d'accès absolu au répertoire de sortie si votre projet est configuré dans une structure de répertoire distincte.

Mettre à jour les SDK lors du prototypage

Si vous créez des prototypes de manière interactive avec l'extension VS Code Data Connect et son émulateur Data Connect, les fichiers sources du SDK sont automatiquement générés et mis à jour lorsque vous modifiez les fichiers .gql définissant les schémas, les requêtes et les mutations. Cette fonctionnalité peut être utile dans les workflows de rechargement à chaud.

Dans d'autres scénarios, si vous utilisez l'émulateur Data Connect à partir de l'interface de ligne de commande Firebase, vous pouvez définir une surveillance des mises à jour .gql et faire en sorte que les sources du SDK soient également mises à jour automatiquement.

Vous pouvez également utiliser l'interface de ligne de commande pour régénérer les SDK chaque fois que des fichiers .gql sont modifiés :

firebase dataconnect:sdk:generate --watch

Générez des SDK pour l'intégration et pour les versions de production.

Dans certains cas, par exemple lorsque vous préparez des sources de projet à envoyer pour des tests CI, vous pouvez appeler l'interface de ligne de commande Firebase pour une mise à jour par lot.

Dans ce cas, utilisez firebase dataconnect:sdk:generate.

Initialiser le SDK iOS Data Connect

Initialisez votre instance Data Connect à l'aide des informations que vous avez utilisées pour configurer Data Connect (toutes disponibles dans l'onglet "Data Connect" de la console Firebase).

Obtenir une instance de connecteur

Le code de votre connecteur sera généré par l'émulateur Data Connect. Si le nom de votre connecteur est movies et que le package est movies, comme spécifié dans connector.yaml, récupérez l'objet du connecteur en appelant :

let connector = DataConnect.moviesConnector

Implémenter des requêtes et des mutations

L'objet de connecteur vous permet d'exécuter des requêtes et des mutations telles qu'elles sont définies dans le code source GraphQL. Supposons que votre connecteur comporte les opérations suivantes :

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
  }
}

Vous pouvez ensuite créer un film comme suit :

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)")

Pour récupérer un film, vous devez utiliser une référence de requête. Toutes les références de requête sont des éditeurs observables. Selon l'éditeur configuré (voir connector.yaml)), il est compatible avec la macro @Observable (iOS 17 et versions ultérieures) ou implémente le protocole ObservableObject. Si aucune valeur n'est spécifiée, la valeur par défaut est la macro @Observable compatible avec iOS 17 et versions ultérieures.

Dans une vue SwiftUI, vous pouvez lier les résultats de la requête à l'aide de la variable data publiée de la référence de requête et appeler la méthode execute() de la requête pour mettre à jour les données. La variable data correspondra à la forme des données définies dans votre définition de requête GQL.

Tous les résultats récupérés sont conformes au protocole Decodable. Si vous avez inclus la clé primaire de l'objet dans votre récupération GQL, les objets sont également Identifiable, ce qui vous permet de les utiliser dans des itérateurs.

Remarque : Le @StateObject n'est pas mis à jour en temps réel. Elle n'est pas non plus nécessaire lorsque vous utilisez une macro @Observable en tant qu'éditeur.

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()
    }
}

Les requêtes sont également compatibles avec l'exécution unique.

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

Prototyper et tester votre application iOS

Instrumenter les clients pour qu'ils utilisent un émulateur local

Vous pouvez utiliser l'émulateur Data Connect, que ce soit à partir de l'extension VS Code Data Connect ou de la CLI.

L'instrumentation de l'application pour se connecter à l'émulateur est la même dans les deux scénarios.

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

Types de données dans les SDK Data Connect

Le serveur Data Connect représente les types de données GraphQL courants et personnalisés. Elles sont représentées dans le SDK comme suit.

Type de connexion de données	Swift
Chaîne	Chaîne
Int	Int
Float	Double
Booléen	Bool
UUID	UUID
Date	FirebaseDataConnect.LocalDate
Horodatage	FirebaseCore.Timestamp
Int64	Int64
Tous	FirebaseDataConnect.AnyValue