Inizia a utilizzare Firebase Data Connect con Flutter

In questa guida rapida, creerai e implementerai un piccolo database di esempio e vi accederai da un frontend Flutter.

Prerequisiti

Per completare questa guida rapida, avrai bisogno di:

Tutorial

Tutorial

1. Crea un nuovo progetto Firebase

Inizia creando un nuovo progetto Firebase nella console Firebase. Poi, esegui l'upgrade del progetto al piano Blaze.

2. Inizializza il progetto

Crea una nuova directory e inizializza un progetto Firebase al suo interno. Quando richiesto, scegli le seguenti opzioni:

  • Scegli il progetto che hai creato nel passaggio precedente.
  • Non creare uno schema con Gemini (in questo tutorial utilizzerai uno schema di esempio predefinito).
  • Crea una nuova istanza Cloud SQL.
  • Crea un modello Flutter.
mkdir myproj ; cd myproj
firebase login --reauth
firebase init dataconnect

3. Esamina le definizioni GraphQL di esempio

In Data Connect, definisci tutti gli schemi e le operazioni del database utilizzando GraphQL. Quando hai inizializzato il progetto, la CLI Firebase ha creato alcune definizioni di esempio per iniziare.

dataconnect/schema/schema.gql (estratto)
type Movie @table {
  title: String!
  imageUrl: String!
  genre: String
}

type MovieMetadata @table {
  movie: Movie! @unique
  rating: Float
  releaseYear: Int
  description: String
}
dataconnect/example/queries.gql (estratto)
query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
  }
}

4. Esegui il deployment di schemi e operazioni

Ogni volta che apporti modifiche agli schemi, alle query o alle mutazioni del database, devi eseguirne il deployment affinché le modifiche abbiano effetto sul database.

firebase deploy --only dataconnect

5. Inserisci dati di esempio nel database

Questi dati iniziali ti daranno qualcosa da esaminare quando testi l'app di esempio. Tieni presente che in questo passaggio esegui GraphQL arbitrario, consentito per le attività amministrative.

firebase dataconnect:execute dataconnect/seed_data.gql

6. Genera un SDK client Dart

Questo comando utilizza le definizioni GraphQL per generare una libreria Dart specifica per il tuo database. Utilizzi questa libreria nell'app client per eseguire tutte le operazioni del database.

Puoi generare librerie per più piattaforme, tra cui Kotlin per Android, Swift per iOS e JavaScript per il web, aggiungendo definizioni a connector.yaml.

firebase dataconnect:sdk:generate
SDK Dart generato automaticamente (estratto)
class ExampleConnector {
  ListMoviesVariablesBuilder listMovies() {
    return ListMoviesVariablesBuilder(dataConnect);
  }

  // ...
}

7. Configurare un'app Flutter

Esegui questi comandi per configurare l'app Flutter in modo che utilizzi il tuo progetto Firebase.

Quando richiesto dal comando flutterfire, seleziona il progetto Firebase che hai creato in precedenza e scegli le piattaforme di destinazione.

cd flutter_app
flutter pub add firebase_core firebase_data_connect
flutterfire configure

8. Scrivi un client Flutter di esempio

Sostituisci i contenuti di flutter_app/lib/main.dart con questa semplice app Flutter.

Tieni presente che l'app completa l'accesso al database necessario utilizzando una funzione dell'SDK generato.

import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_data_connect/firebase_data_connect.dart';
import 'package:flutter/material.dart';
import 'package:flutter_app/dataconnect_generated/generated.dart';
import 'package:flutter_app/firebase_options.dart';

class MyApp extends StatelessWidget {
  late final Future<QueryResult<ListMoviesData, void>>
  _movieListFuture;

  MyApp({super.key}) {
    _movieListFuture = ExampleConnector.instance
        .listMovies()
        .execute();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: FutureBuilder(
        future: _movieListFuture,
        builder: (context, snapshot) {
          if (snapshot.connectionState == ConnectionState.done) {
            return ListView.builder(
              scrollDirection: Axis.vertical,
              itemBuilder: (context, index) => Card(
                child: Text(
                  snapshot.data?.data.movies[index].title ?? "",
                ),
              ),
              itemCount: snapshot.data?.data.movies.length ?? 0,
            );
          }
          return const CircularProgressIndicator();
        },
      ),
    );
  }
}

Future<void> main() async {
  await Firebase.initializeApp(
    options: DefaultFirebaseOptions.currentPlatform,
  );
  runApp(MyApp());
}

9. Prova l'app

Avvia il server di sviluppo per vedere l'app di esempio in azione.

flutter run

Passaggi successivi

Prova l'estensione Visual Studio Code

Quando sviluppi con Data Connect, ti consigliamo vivamente di utilizzare l'estensione Visual Studio Code. Anche se non utilizzi Visual Studio Code come ambiente di sviluppo principale, l'estensione fornisce diverse funzionalità che rendono più comodo lo sviluppo di schemi e operazioni:

  • Un server di linguaggio GraphQL che fornisce il controllo della sintassi e suggerimenti di completamento automatico specifici per Data Connect
  • Pulsanti CodeLens in linea con il codice che ti consentono di leggere e scrivere dati dai file di definizione dello schema ed eseguire query e mutazioni dalle definizioni delle operazioni.
  • Mantieni sincronizzati automaticamente gli SDK generati con le definizioni GraphQL.
  • Configurazione semplificata dell'emulatore locale.
  • Deployment semplificato in produzione.

Utilizza l'emulatore Data Connect per lo sviluppo locale

Anche se questo tutorial ti ha mostrato come eseguire il deployment di schemi e operazioni Data Connect direttamente in produzione, probabilmente non vorrai apportare modifiche al database di produzione mentre sviluppi attivamente la tua app. Configura invece l'emulatore Data Connect e svolgi il lavoro di sviluppo su questo emulatore anziché sulla produzione. L'emulatore configura un'istanza PGlite locale che si comporta in modo simile a un'istanza Postgres live su CloudSQL.

Scopri come scrivere schemi e operazioni per la tua app

Quando sviluppi app con Data Connect, la progettazione degli schemi e delle operazioni è una delle prime e più importanti attività di sviluppo che completerai.

  • Gemini nella console Firebase è uno strumento di AI che può generare schemi Data Connect da una descrizione in linguaggio naturale della tua app. Questo strumento può aiutarti a iniziare molto rapidamente, soprattutto se non hai mai lavorato con database relazionali.
  • In alternativa, puoi scrivere schemi di database, query e mutazioni direttamente utilizzando GraphQL. Inizia dalla pagina Schemi Data Connect di progettazione e continua con le pagine successive per scoprire come scrivere le operazioni.