В этом кратком руководстве вы создадите и развернете небольшую тестовую базу данных и получите к ней доступ через интерфейс Flutter.
Предварительные требования
Для выполнения этого краткого руководства вам потребуется следующее:
- Среда с установленными следующими инструментами:
- Node.js с менеджером пакетов на ваш выбор. В этом руководстве предполагается использование
npm. - Интерфейс командной строки Firebase :
npm i -g firebase-tools@latest - Инструмент командной строки Flutter .
- Интерфейс командной строки FlutterFile
dart pub global activate flutterfire_cli
- Node.js с менеджером пакетов на ваш выбор. В этом руководстве предполагается использование
- Аккаунт Google.
Учебное пособие
| Учебное пособие | |
|---|---|
1. Инициализируйте свой проект.Создайте новую директорию и инициализируйте в ней проект Firebase. При появлении запроса выберите следующие параметры:
|
|
2. Ознакомьтесь с примерами определений GraphQL.В SQL Connect вы определяете все схемы и операции базы данных с помощью GraphQL. При инициализации проекта Firebase CLI создал несколько примеров определений, чтобы помочь вам начать работу. | dataconnect/schema/schema.gql (отрывок)type Movie @table { title: String! imageUrl: String! genre: String } type MovieMetadata @table { movie: Movie! @unique rating: Float releaseYear: Int description: String } query ListMovies @auth(level: PUBLIC) { movies { id title imageUrl genre } } |
3. Разверните свои схемы и операции.При внесении любых изменений в схемы базы данных, запросы или мутации необходимо выполнить их развертывание, чтобы изменения вступили в силу в базе данных. | |
4. Заполните базу данных тестовыми данными.Эти исходные данные послужат вам ориентиром при тестировании тестового приложения. Обратите внимание, что на этом этапе вы выполняете произвольные запросы GraphQL, что разрешено для административных задач. | |
5. Создайте SDK клиента Dart.Эта команда использует ваши определения GraphQL для генерации библиотеки Dart, специально предназначенной для вашей базы данных. Вы используете эту библиотеку в своем клиентском приложении для выполнения всех операций с базой данных. Вы можете создавать библиотеки для различных платформ, включая Kotlin для Android, Swift для iOS и JavaScript для веб-приложений, добавив определения в | class ExampleConnector { ListMoviesVariablesBuilder listMovies() { return ListMoviesVariablesBuilder(dataConnect); } // ... } |
6. Создайте приложение Flutter.Выполните эти команды, чтобы настроить приложение Flutter для использования вашего проекта Firebase. При появлении запроса от команды |
|
7. Напишите пример клиента Flutter. Замените содержимое файла Обратите внимание, что приложение выполняет необходимый доступ к базе данных, используя функцию из сгенерированного SDK. | 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()); } |
8. Попробуйте приложениеЗапустите сервер разработки, чтобы увидеть пример приложения в действии. | |
Следующие шаги
Попробуйте расширение SQL Connect для VS Code.
При разработке с использованием SQL Connect мы настоятельно рекомендуем использовать расширение SQL Connect для VS Code . Даже если вы не используете Visual Studio Code в качестве основной среды разработки, расширение предоставляет ряд функций, которые делают разработку схем и операций более удобной:
- Языковой сервер GraphQL, обеспечивающий проверку синтаксиса и подсказки автозаполнения, специфичные для SQL Connect
- Кнопки CodeLens, встроенные в ваш код, позволяют читать и записывать данные из файлов определения схемы, а также выполнять запросы и мутации на основе определений операций.
- Автоматически синхронизируйте сгенерированные SDK с определениями GraphQL.
- Упрощенная настройка локального эмулятора.
- Упрощенное развертывание в производственной среде.
Используйте эмулятор SQL Connect для локальной разработки.
Хотя в этом руководстве показано, как развертывать схемы и операции SQL Connect непосредственно в продакшене, вам, вероятно, не захочется вносить изменения в базу данных продакшена во время активной разработки приложения. Вместо этого настройте эмулятор SQL Connect и выполняйте разработку на его основе, а не в продакшене. Эмулятор создает локальный экземпляр PGlite, который ведет себя аналогично работающему экземпляру Postgres в CloudSQL.
Узнайте, как писать схемы и операции для вашего приложения.
При разработке приложений с использованием SQL Connect проектирование схем и операций является одной из первых и наиболее важных задач разработки.
- Gemini в консоли Firebase — это инструмент на основе искусственного интеллекта, который может генерировать схемы SQL Connect на основе описания вашего приложения на естественном языке. Этот инструмент позволит вам очень быстро начать работу, особенно если вы никогда раньше не работали с реляционными базами данных.
- В качестве альтернативы вы можете создавать схемы баз данных, запросы и мутации непосредственно с помощью GraphQL. Начните со страницы «Создание схем SQL Connect и перейдите к следующим страницам, чтобы узнать, как писать операции.