Utilizzare gli SDK per iOS generati

Firebase SQL Connect SDK client ti consentono di chiamare le query e le mutazioni lato server direttamente da un'app Firebase. Generi un SDK client personalizzato in parallelo mentre progetti gli schemi, le query e le mutazioni di cui esegui il deployment nel tuo SQL Connect servizio. Poi, integri i metodi di questo SDK nella logica client.

Come abbiamo già detto, è importante notare che SQL Connect query e mutazioni non vengono inviate dal codice client ed eseguite sul server. Quando viene eseguito il deployment, le operazioni SQL Connect vengono archiviate su il server come Cloud Functions. Ciò significa che devi eseguire il deployment delle modifiche lato client corrispondenti per evitare di interrompere gli utenti esistenti (ad esempio, nelle versioni precedenti dell'app).

Per questo motivo, SQL Connect ti fornisce un ambiente di sviluppo e strumenti che ti consentono di creare prototipi di schemi, query e mutazioni di cui è stato eseguito il deployment sul server. Genera anche automaticamente gli SDK lato client durante la creazione del prototipo.

Dopo aver eseguito l'iterazione degli aggiornamenti del servizio e delle app client, gli aggiornamenti lato server e lato client sono pronti per il deployment.

Che cos'è il flusso di lavoro di sviluppo client?

Se hai seguito la guida Inizia, hai scoperto il flusso di sviluppo generale per SQL Connect. In questa guida troverai informazioni più dettagliate sulla generazione di SDK Swift dallo schema e sull'utilizzo di query e mutazioni client.

Per riassumere, per utilizzare gli SDK Swift generati nelle app client, segui questi passaggi preliminari:

  1. Aggiungi Firebase alla tua app iOS.

  2. Per utilizzare l'SDK generato, configurarlo come dipendenza in Xcode.

    Nella barra di navigazione in alto di Xcode, seleziona File > Add Package Dependencies > Add Local (File > Aggiungi dipendenze pacchetto > Aggiungi locale) e scegli la cartella contenente il file Package.swift generato.

Quindi:

  1. Sviluppa lo schema dell'app.

  2. Configura la generazione dell'SDK:

    • Con il pulsante Add SDK to app (Aggiungi SDK all'app) nella nostra estensione SQL Connect VS Code
    • Aggiornando il file your connector.yaml

  3. Inizializza il codice client e importa le librerie.

  4. Implementa le chiamate a query e mutazioni.

  5. Configura e utilizza l'emulatore SQL Connect e esegui l'iterazione.

Genera l'SDK Swift

Utilizza l'interfaccia a riga di comando Firebase per configurare gli SDK generati da SQL Connect nelle tue app. Il comando init dovrebbe rilevare tutte le app nella cartella corrente e installare automaticamente gli SDK generati.

firebase init dataconnect:sdk

Aggiorna gli SDK durante la creazione del prototipo

Se hai installato l'estensione SQL Connect VS Code, gli SDK generati saranno sempre aggiornati.

Se non utilizzi l'estensione SQL Connect VS Code, puoi utilizzare l'interfaccia a riga di comando di Firebase per mantenere aggiornati gli SDK generati.

firebase dataconnect:sdk:generate --watch

Genera SDK nelle pipeline di build

Puoi utilizzare l'interfaccia a riga di comando di Firebase per generare gli SDK SQL Connect nei processi di build CI/CD.

firebase dataconnect:sdk:generate

Inizializza l'SDK iOS SQL Connect

Inizializza l'istanza SQL Connect utilizzando le informazioni che hai utilizzato per configurare SQL Connect (tutte disponibili nella console Firebase SQL Connect tab).

Recupera un'istanza del connettore

Il codice del connettore verrà generato dall' SQL Connect emulatore. Se il nome del connettore è movies e il pacchetto è movies, come specificato in connector.yaml, recupera l'oggetto connettore chiamando:

let connector = DataConnect.moviesConnector

Implementa query e mutazioni

Con l'oggetto connettore, puoi eseguire query e mutazioni come definito nel codice sorgente GraphQL. Supponiamo che il connettore abbia queste operazioni definite:

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

Puoi quindi creare un film nel seguente modo:

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

Per recuperare un film, utilizzerai un riferimento alla query. Tutti i riferimenti alle query sono publisher Observable. A seconda del publisher configurato (vedi connector.yaml), supportano la @Observable macro (iOS 17+) o implementano il ObservableObject protocollo. Il valore predefinito, se non ne viene specificato nessuno, è la macro @Observable supportata su iOS 17+.

In una visualizzazione SwiftUI, puoi associare i risultati della query utilizzando la variabile data pubblicata del riferimento alla query e chiamare il metodo execute() della query per aggiornare i dati. La variabile data corrisponderà alla forma dei dati definita nella definizione della query GQL.

Tutti i risultati recuperati sono conformi al protocollo Decodable. Se hai incluso la chiave primaria dell'oggetto nel recupero GQL, gli oggetti sono anche Identifiable, il che ti consente di utilizzarli negli iteratori. 

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

Le query supportano anche l'esecuzione una tantum. 

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

Gestisci le modifiche ai campi di enumerazione

Lo schema di un'app può contenere enumerazioni, a cui è possibile accedere tramite le query GraphQL.

Man mano che il design di un'app cambia, puoi aggiungere nuovi valori supportati per l'enumerazione. Ad esempio, supponiamo che in un secondo momento nel ciclo di vita dell'applicazione tu decida di aggiungere un valore FULLSCREEN all'enumerazione AspectRatio.

Nel flusso di lavoro SQL Connect, puoi utilizzare gli strumenti di sviluppo locali per aggiornare le query e gli SDK.

Tuttavia, prima di rilasciare una versione aggiornata dei client, i client di cui è stato eseguito il deployment precedente potrebbero non funzionare.

Esempio di implementazione resiliente

L'SDK generato impone la gestione dei valori sconosciuti, poiché le enumerazioni generate contengono un valore _UNKNOWN e Swift applica istruzioni switch esaustive.

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
}

Attiva la memorizzazione nella cache lato client

SQL Connect ha una funzionalità di memorizzazione nella cache lato client facoltativa, che puoi attivare modificando il file connector.yaml. Quando questa funzionalità è attivata, gli SDK client generati memorizzano nella cache localmente le risposte alle query, il che può ridurre il numero di richieste di database effettuate dall'app e consente alle parti dell'app dipendenti dal database di funzionare quando la disponibilità della rete viene interrotta.

Per attivare la memorizzazione nella cache lato client, aggiungi una configurazione della cache client alla configurazione del connettore:

generate:
  swiftSdk:
    outputDir: "../ios"
    package: "FirebaseDataConnectGenerated"
    clientCache:
      maxAge: 5s
      storage: persistent

Questa configurazione ha due parametri, entrambi facoltativi:

  • maxAge: l'età massima di una risposta memorizzata nella cache prima che l'SDK client recuperi i valori aggiornati. Esempi: "0", "30s", "1h30m".

    Il valore predefinito di maxAge è 0, il che significa che le risposte vengono memorizzate nella cache, ma l'SDK client recupererà sempre i valori aggiornati. I valori memorizzati nella cache verranno utilizzati solo quando CACHE_ONLY viene specificato per execute().

  • storage: l'SDK client può essere configurato per memorizzare nella cache le risposte in persistent storage o in memory. I risultati memorizzati nella cache in persistent storage verranno mantenuti dopo i riavvii dell'app. Negli SDK iOS, il valore predefinito è persistent.

Dopo aver aggiornato la configurazione della cache del connettore, rigenera gli SDK client e ricompila l'app. Una volta fatto, execute() memorizzerà nella cache le risposte e utilizzerà i valori memorizzati nella cache in base alla policy configurata. In genere, questa operazione viene eseguita automaticamente, senza ulteriori interventi da parte tua; tuttavia, tieni presente quanto segue:

  • Il comportamento predefinito di execute() è quello descritto sopra: se un risultato viene memorizzato nella cache per una query e il valore memorizzato nella cache non è più vecchio di maxAge, utilizza il valore memorizzato nella cache. Questo comportamento predefinito è chiamato policy PREFER_CACHE.

    Puoi anche specificare le singole chiamate a execute() per pubblicare solo i valori memorizzati nella cache (CACHE_ONLY) o per recuperare in modo incondizionato i valori aggiornati dal server (SERVER_ONLY).

    try await execute(fetchPolicy: .cacheOnly)

    try await execute(fetchPolicy: .serverOnly)

    Crea prototipi e testa l'applicazione iOS

    Strumenta i client per utilizzare un emulatore locale

    Puoi utilizzare l'emulatore SQL Connect, sia dall' estensione SQL Connect VS Code sia dall'interfaccia a riga di comando.

    La strumentazione dell'app per la connessione all'emulatore è la stessa per entrambi gli scenari.

    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

    Tipi di dati negli SDK SQL Connect

    Il server SQL Connect rappresenta i tipi di dati GraphQL comuni e personalizzati. Questi sono rappresentati nell'SDK come segue.

    SQL Connect Tipo Swift
    Stringa Stringa
    Int Int
    In virgola mobile Double
    Booleano Bool
    UUID UUID
    Data FirebaseDataConnect.LocalDate
    Timestamp FirebaseCore.Timestamp
    Int64 Int64
    Qualsiasi FirebaseDataConnect.AnyValue