Firebase Data Connect SDK klien memungkinkan Anda memanggil kueri dan mutasi sisi server langsung dari aplikasi Firebase. Anda membuat SDK klien kustom secara paralel saat mendesain skema, kueri, dan mutasi yang Anda deploy ke Data Connect layanan. Kemudian, Anda mengintegrasikan metode dari SDK ini ke dalam logika klien.
Seperti yang telah kami sebutkan di tempat lain, penting untuk diperhatikan bahwa Data Connect kueri dan mutasi tidak dikirimkan oleh kode klien dan dieksekusi di server. Sebagai gantinya, saat di-deploy, Data Connect operasi disimpan di server seperti Cloud Functions. Artinya, Anda harus men-deploy perubahan sisi klien yang sesuai untuk menghindari gangguan pada pengguna yang ada (misalnya, pada versi aplikasi yang lebih lama).
Itulah sebabnya Data Connect menyediakan lingkungan dan alat developer yang memungkinkan Anda membuat prototipe skema, kueri, dan mutasi yang di-deploy server. Data Connect juga otomatis membuat SDK sisi klien, saat Anda membuat prototipe.
Setelah Anda melakukan iterasi pembaruan pada aplikasi layanan dan klien, pembaruan sisi server dan klien siap di-deploy.
Membuat Flutter SDK
Gunakan Firebase CLI untuk menyiapkan SDK yang dibuat Data Connect di aplikasi Anda.
Perintah init akan mendeteksi semua aplikasi di folder saat ini dan menginstal SDK yang dibuat secara otomatis.
firebase init dataconnect:sdk
Memperbarui SDK saat membuat prototipe
Jika Anda telah menginstal ekstensi Data Connect VS Code, ekstensi tersebut akan selalu memperbarui SDK yang dibuat.
Jika tidak menggunakan ekstensi Data Connect VS Code, Anda dapat menggunakan Firebase CLI untuk memperbarui SDK yang dibuat.
firebase dataconnect:sdk:generate --watchMembuat SDK dalam pipeline build
Anda dapat menggunakan Firebase CLI untuk membuat Data Connect SDK dalam proses build CI/CD.
firebase dataconnect:sdk:generateMenyiapkan kode klien
Menginisialisasi aplikasi Data Connect
Pertama, inisialisasi aplikasi Anda menggunakan petunjuk penyiapan Firebase standar.
Kemudian, instal plugin Data Connect:
flutter pub add firebase_data_connectMenginisialisasi Data Connect Flutter SDK
Inisialisasi instance Data Connect menggunakan informasi yang Anda gunakan untuk menyiapkan Data Connect (semuanya tersedia di tab Data Connect Firebase console ).
Mengimpor library
Ada dua kumpulan impor yang diperlukan untuk menginisialisasi kode klien Anda, impor umum Data Connect dan impor SDK spesifik yang dibuat.
// general imports
import 'package:firebase_data_connect/firebase_data_connect.dart';
// generated queries and mutations from SDK
import 'generated/movies.dart';
Menggunakan kueri di sisi klien
Kode yang dibuat akan dilengkapi dengan Query Ref yang telah ditentukan. Anda hanya perlu mengimpor dan memanggil execute di dalamnya.
import 'generated/movies.dart';
await MoviesConnector.instance.listMovies().execute();
Memanggil metode kueri SDK
Berikut adalah contoh penggunaan fungsi pintasan tindakan ini:
import 'generated/movies.dart';
function onBtnClick() {
// This will call the generated Dart from the CLI and then make an HTTP request to the server.
MoviesConnector.instance.listMovies().execute().then(data => showInUI(data)); // == MoviesConnector.instance.listMovies().ref().execute();
}
Kolom opsional
Beberapa kueri mungkin memiliki kolom opsional. Dalam kasus ini, Flutter SDK akan mengekspos metode builder, dan harus ditetapkan secara terpisah.
Misalnya, kolom rating bersifat opsional saat memanggil createMovie, sehingga Anda harus menyediakannya dalam fungsi builder.
await MoviesConnector.instance.createMovie({ title: 'Empire Strikes Back', releaseYear: 1980, genre: "Sci-Fi"}).rating(5).execute();
Berlangganan perubahan
Anda dapat berlangganan perubahan (yang akan diperbarui setiap kali Anda menjalankan kueri).
QueryRef<ListMoviesData, void> listRef = MoviesConnector.instance.listMovies().ref();
// subscribe will immediately invoke the query if no execute was called on it previously.
listRef.subscribe().listen((data) {
updateUIWithMovies(data.movies);
});
await MoviesConnector.instance.createMovie({ title: 'Empire Strikes Back', releaseYear: 1980, genre: "Sci-Fi" }).rating(5).execute();
await listRef.execute(); // will update the subscription above`
Menangani perubahan pada kolom enumerasi
Skema aplikasi dapat berisi enumerasi, yang dapat diakses oleh kueri GraphQL Anda.
Saat desain aplikasi berubah, Anda dapat menambahkan nilai yang didukung enum baru. Misalnya, bayangkan bahwa nanti dalam siklus proses aplikasi, Anda memutuskan untuk menambahkan nilai FULLSCREEN ke enum AspectRatio.
Dalam alur kerja Data Connect, Anda dapat menggunakan alat pengembangan lokal untuk memperbarui kueri dan SDK.
Namun, sebelum Anda merilis versi klien yang diperbarui, klien yang di-deploy sebelumnya mungkin akan rusak.
Contoh penerapan yang tangguh
SDK yang dibuat akan memaksa penanganan nilai yang tidak diketahui. Artinya, kode klien harus meng-unwrap objek EnumValue menjadi Known atau Unknown.
final result = await MoviesConnector.instance.listMovies().execute();
if (result.data != null && result.data!.isNotEmpty) {
handleEnumValue(result.data![0].aspectratio);
}
void handleEnumValue(EnumValue<AspectRatio> aspectValue) {
if (aspectValue.value != null) {
switch(aspectValue.value!) {
case AspectRatio.ACADEMY:
print("This movie is in Academy aspect");
break;
case AspectRatio.WIDESCREEN:
print("This movie is in Widescreen aspect");
break;
case AspectRatio.ANAMORPHIC:
print("This movie is in Anamorphic aspect");
break;
case AspectRatio.IMAX:
print("This movie is in IMAX aspect");
}
} else {
print("Unknown aspect ratio detected: ${aspectValue.stringValue}");
}
}
Menggunakan mutasi di sisi klien
Mutasi dapat diakses dengan cara yang sama seperti kueri.
await MoviesConnector.instance.createMovie({ title: 'Empire Strikes Back', releaseYear: 1980, genre: "Sci-Fi" }).rating(5).execute();
Membuat prototipe dan menguji aplikasi Flutter
Menginstrumentasi klien untuk menggunakan emulator lokal
Anda dapat menggunakan emulator Data Connect, baik dari ekstensi Data Connect VS Code maupun dari CLI.
Menginstrumentasi aplikasi untuk terhubung ke emulator sama untuk kedua skenario.
import 'package:firebase_data_connect/firebase_data_connect.dart';
import 'generated/movies.dart';
MoviesConnector.instance.dataConnect
.useDataConnectEmulator('127.0.0.1', 9399);
// Make calls from your app
QueryRef<ListMoviesData, void> ref = MoviesConnector.instance.listMovies.ref();
Untuk beralih ke resource produksi, beri komentar pada baris untuk terhubung ke emulator.
Jenis data di Dart SDK
Server Data Connect mewakili jenis data GraphQL umum. Jenis data ini direpresentasikan dalam SDK sebagai berikut.
| Data Connect Jenis | Dart |
|---|---|
| Stempel waktu | firebase_data_connect.Timestamp |
| Int (32-bit) | int |
| Tanggal | DateTime |
| UUID | string |
| Int64 | int |
| Float | double |
| Boolean | bool |
| Semua | firebase_data_connect.AnyValue |