Premiers pas avec Firebase Data Connect à l'aide de Flutter

Dans ce guide de démarrage rapide, vous allez créer et déployer un petit exemple de base de données, puis y accéder à partir d'une interface utilisateur Flutter.

Prérequis

Pour suivre ce guide de démarrage rapide, vous aurez besoin des éléments suivants :

  • Un environnement avec les outils suivants installés :
  • Un compte Google.

Tutoriel

Tutoriel

1. Créer un projet Firebase

Commencez par créer un projet Firebase dans la console Firebase. Mettez ensuite à niveau le projet vers la formule Blaze.

2. Initialisez votre projet

Créez un répertoire et initialisez un projet Firebase dans celui-ci. Lorsque vous y êtes invité, sélectionnez les options suivantes :

  • Sélectionnez le projet que vous avez créé à l'étape précédente.
  • Ne créez pas de schéma avec Gemini (dans ce tutoriel, vous utiliserez un exemple de schéma prédéfini).
  • Créez une instance Cloud SQL.
  • Créez un modèle Flutter.
mkdir myproj ; cd myproj
firebase login --reauth
firebase init dataconnect

3. Examiner les exemples de définitions GraphQL

Dans Data Connect, vous définissez tous vos schémas et opérations de base de données à l'aide de GraphQL. Lorsque vous avez initialisé votre projet, la CLI Firebase a créé des exemples de définitions pour vous aider à démarrer.

dataconnect/schema/schema.gql (extrait)
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 (extrait)
query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
  }
}

4. Déployer vos schémas et opérations

Chaque fois que vous modifiez vos schémas de base de données, vos requêtes ou vos mutations, vous devez les déployer pour que vos modifications prennent effet sur la base de données.

firebase deploy --only dataconnect

5. Insérer des exemples de données dans la base de données

Ces données d'amorçage vous donneront un aperçu lorsque vous testerez l'application exemple. Notez que, lors de cette étape, vous exécutez un code GraphQL arbitraire, ce qui est autorisé pour les tâches administratives.

firebase dataconnect:execute dataconnect/seed_data.gql

6. Générer un SDK client Dart

Cette commande utilise vos définitions GraphQL pour générer une bibliothèque Dart spécifiquement pour votre base de données. Vous utilisez cette bibliothèque dans votre application cliente pour effectuer toutes les opérations de base de données.

Vous pouvez générer des bibliothèques pour plusieurs plates-formes, y compris Kotlin pour Android, Swift pour iOS et JavaScript pour le Web, en ajoutant des définitions à connector.yaml.

firebase dataconnect:sdk:generate
Extrait du SDK Dart généré automatiquement
class ExampleConnector {
  ListMoviesVariablesBuilder listMovies() {
    return ListMoviesVariablesBuilder(dataConnect);
  }

  // ...
}

7. Configurer une application Flutter

Exécutez ces commandes pour configurer l'application Flutter afin qu'elle utilise votre projet Firebase.

Lorsque vous y êtes invité par la commande flutterfire, sélectionnez le projet Firebase que vous avez créé précédemment, puis choisissez les plates-formes que vous souhaitez cibler.

cd flutter_app
flutter pub add firebase_core firebase_data_connect
flutterfire configure

8. Écrire un exemple de client Flutter

Remplacez le contenu de flutter_app/lib/main.dart par cette application Flutter simple.

Notez que l'application effectue l'accès à la base de données nécessaire à l'aide d'une fonction du SDK généré.

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. Essayer l'appli

Démarrez le serveur de développement pour voir l'application exemple en action.

flutter run

Étapes suivantes

Essayer l'extension Visual Studio Code

Lorsque vous développez avec Data Connect, nous vous recommandons vivement d'utiliser l'extension Visual Studio Code. Même si vous n'utilisez pas Visual Studio Code comme environnement de développement principal, l'extension fournit plusieurs fonctionnalités qui facilitent le développement de schémas et d'opérations :

  • Un serveur de langage GraphQL, qui fournit des suggestions de vérification de la syntaxe et de saisie semi-automatique spécifiques à Data Connect
  • Boutons CodeLens alignés sur votre code qui vous permettent de lire et d'écrire des données à partir de vos fichiers de définition de schéma, et d'exécuter des requêtes et des mutations à partir de vos définitions d'opération.
  • Synchronisez automatiquement vos SDK générés avec vos définitions GraphQL.
  • Configuration simplifiée de l'émulateur local.
  • Déploiement simplifié en production.

Utiliser l'émulateur Data Connect pour le développement local

Bien que ce tutoriel vous ait montré comment déployer des schémas et des opérations Data Connect directement en production, vous ne souhaiterez probablement pas apporter de modifications à votre base de données de production pendant que vous développez activement votre application. À la place, configurez l'émulateur Data Connect et effectuez votre travail de développement sur celui-ci plutôt que sur la production. L'émulateur configure une instance PGlite locale qui se comporte de la même manière qu'une instance Postgres en direct sur Cloud SQL.

Découvrez comment écrire des schémas et des opérations pour votre application

Lorsque vous développez des applications avec Data Connect, la conception de vos schémas et opérations est l'une des premières et des plus importantes tâches de développement que vous effectuerez.

  • Gemini dans la console Firebase est un outil d'IA qui peut générer des schémas Data Connect à partir d'une description en langage naturel de votre application. Cet outil peut vous aider à démarrer très rapidement, surtout si vous n'avez jamais travaillé avec des bases de données relationnelles auparavant.
  • Vous pouvez également écrire des schémas de base de données, des requêtes et des mutations directement à l'aide de GraphQL. Commencez par la page Concevoir des schémas Data Connect, puis passez aux pages suivantes pour découvrir comment écrire des opérations.