Sử dụng các SDK Flutter đã tạo

SDK ứng dụng khách Firebase Data Connect cho phép bạn gọi các truy vấn và đột biến phía máy chủ trực tiếp từ một ứng dụng Firebase. Bạn tạo một SDK ứng dụng khách tuỳ chỉnh song song khi thiết kế các lược đồ, truy vấn và đột biến mà bạn triển khai cho dịch vụ Data Connect. Sau đó, bạn tích hợp các phương thức từ SDK này vào logic ứng dụng khách.

Như chúng tôi đã đề cập ở nơi khác, điều quan trọng cần lưu ý là Data Connect các truy vấn và đột biến không được mã ứng dụng khách gửi và không thực thi trên máy chủ. Thay vào đó, khi được triển khai, các hoạt động Data Connect sẽ được lưu trữ trên máy chủ như Cloud Functions. Điều này có nghĩa là bạn cần triển khai các thay đổi tương ứng ở phía máy khách để tránh làm gián đoạn người dùng hiện tại (ví dụ: trên các phiên bản ứng dụng cũ hơn).

Đó là lý do Data Connect cung cấp cho bạn một môi trường và công cụ dành cho nhà phát triển, cho phép bạn tạo mẫu các lược đồ, truy vấn và đột biến được triển khai trên máy chủ. Công cụ này cũng tự động tạo SDK phía máy khách trong khi bạn tạo mẫu.

Khi bạn lặp lại các bản cập nhật cho dịch vụ và ứng dụng khách, cả bản cập nhật phía máy chủ và phía ứng dụng khách đều sẵn sàng triển khai.

Quy trình phát triển ứng dụng khách là gì?

Nếu bạn đã làm theo phần Bắt đầu, thì bạn đã được giới thiệu về quy trình phát triển tổng thể cho Data Connect. Trong hướng dẫn này, bạn sẽ tìm thấy thông tin chi tiết hơn về việc tạo SDK Flutter từ giản đồ và làm việc với các truy vấn và đột biến của ứng dụng khách.

Tóm lại, để sử dụng SDK Flutter đã tạo trong ứng dụng khách, bạn sẽ làm theo các bước tiên quyết sau:

Thêm Firebase vào ứng dụng Flutter.
Cài đặt CLI flutterfire dart pub global activate flutterfire_cli.
Chạy flutterfire configure.

Sau đó:

Phát triển lược đồ ứng dụng.
Thiết lập quá trình tạo SDK:
- Bằng nút Add SDK to app (Thêm SDK vào ứng dụng) trong tiện ích Data Connect VS Code
- Bằng cách cập nhật connector.yaml.
Khởi động mã ứng dụng khách và nhập thư viện.
Triển khai các lệnh gọi đến truy vấn và đột biến.
Thiết lập và sử dụng trình mô phỏng Data Connect rồi lặp lại.

Tạo SDK Flutter

Sử dụng Firebase CLI để thiết lập SDK do Data Connect tạo trong ứng dụng. Lệnh init sẽ phát hiện tất cả ứng dụng trong thư mục hiện tại và tự động cài đặt SDK đã tạo.

firebase init dataconnect:sdk

Cập nhật SDK trong khi tạo mẫu

Nếu bạn đã cài đặt tiện ích Data Connect VS Code, thì tiện ích này sẽ luôn cập nhật SDK đã tạo.

Nếu không sử dụng tiện ích Data Connect VS Code, bạn có thể sử dụng Firebase CLI để luôn cập nhật SDK đã tạo.

firebase dataconnect:sdk:generate --watch

Tạo SDK trong quy trình tạo bản dựng

Bạn có thể sử dụng Firebase CLI để tạo Data Connect SDK trong các quy trình tạo bản dựng CI/CD.

firebase dataconnect:sdk:generate

Thiết lập mã ứng dụng khách

Khởi động ứng dụng Data Connect

Trước tiên, hãy khởi động ứng dụng bằng hướng dẫn thiết lập Firebase tiêu chuẩn.

Sau đó, hãy cài đặt trình bổ trợ Data Connect:

flutter pub add firebase_data_connect

Khởi động SDK FlutterData Connect

Khởi động thực thể Data Connect bằng thông tin mà bạn đã dùng để thiết lập Data Connect (tất cả đều có trong thẻ Data Connect của bảng điều khiển Firebase).

Nhập thư viện

Bạn cần có 2 bộ nhập để khởi động mã ứng dụng khách, bộ nhập chung Data Connect và bộ nhập SDK cụ thể đã tạo.

// general imports
import 'package:firebase_data_connect/firebase_data_connect.dart';

// generated queries and mutations from SDK
import 'generated/movies.dart';

Sử dụng truy vấn ở phía ứng dụng khách

Mã đã tạo sẽ đi kèm với các Tham chiếu truy vấn được xác định trước. Bạn chỉ cần nhập và gọi execute trên các tham chiếu đó.

import 'generated/movies.dart';

await MoviesConnector.instance.listMovies().execute();

Gọi phương thức truy vấn SDK

Dưới đây là ví dụ về cách sử dụng các hàm lối tắt hành động này:

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().the>n(data = showInUI(data)); // == MoviesConnector.instance.listMovies().ref().execute();
}

Trường tuỳ chọn

Một số truy vấn có thể có các trường tuỳ chọn. Trong những trường hợp này, SDK Flutter sẽ hiển thị một phương thức trình tạo và bạn phải thiết lập riêng.

Ví dụ: trường rating là không bắt buộc khi gọi createMovie, vì vậy, bạn cần cung cấp trường này trong hàm trình tạo.

await MoviesConnector.instance.createMovie({ title: 'Empire Strikes Back', releaseYear: 1980, genre: "Sci-Fi"}).rating(5).execute();

Đăng ký nhận thông báo khi có thay đổi

Bạn có thể đăng ký nhận thông báo khi có thay đổi (thông báo này sẽ cập nhật bất cứ lúc nào bạn thực thi một truy vấn).

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`

Xử lý các thay đổi đối với trường liệt kê

Lược đồ của ứng dụng có thể chứa các giá trị liệt kê, mà truy vấn GraphQL có thể truy cập.

Khi thiết kế ứng dụng thay đổi, bạn có thể thêm các giá trị được hỗ trợ cho enum mới. Ví dụ: hãy tưởng tượng rằng sau này trong vòng đời của ứng dụng, bạn quyết định thêm giá trị FULLSCREEN vào enum AspectRatio.

Trong quy trình Data Connect, bạn có thể sử dụng công cụ phát triển cục bộ để cập nhật các truy vấn và SDK.

Tuy nhiên, trước khi bạn phát hành phiên bản cập nhật của ứng dụng khách, các ứng dụng khách cũ đã triển khai có thể bị gián đoạn.

Ví dụ về cách triển khai linh hoạt

SDK đã tạo buộc phải xử lý các giá trị không xác định. Tức là mã ứng dụng khách phải giải gói đối tượng EnumValue thành Known hoặc 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}");
  }
}

Bật tính năng lưu vào bộ nhớ đệm phía máy khách

Data Connect có một tính năng lưu vào bộ nhớ đệm phía máy khách không bắt buộc. Bạn có thể bật tính năng này bằng cách chỉnh sửa tệp connector.yaml. Khi tính năng này được bật, các SDK ứng dụng khách đã tạo sẽ lưu vào bộ nhớ đệm cục bộ các phản hồi truy vấn. Điều này có thể làm giảm số lượng yêu cầu cơ sở dữ liệu mà ứng dụng của bạn thực hiện và cho phép các phần phụ thuộc vào cơ sở dữ liệu của ứng dụng hoạt động khi kết nối mạng bị gián đoạn.

Để bật tính năng lưu vào bộ nhớ đệm phía máy khách, hãy thêm cấu hình lưu vào bộ nhớ đệm của máy khách vào cấu hình trình kết nối:

generate:
  javascriptSdk:
    outputDir: ../dart/
    package: "dataconnect_generated&quot;
    clientCache:
      maxAge: 5s
      storage: memory

Cấu hình này có 2 tham số, cả hai đều không bắt buộc:

maxAge: Tuổi tối đa mà một phản hồi được lưu vào bộ nhớ đệm có thể có trước khi SDK ứng dụng khách tìm nạp các giá trị mới. Ví dụ: "0", "30s", "1h30m".

Giá trị mặc định cho maxAge là 0, có nghĩa là các phản hồi được lưu vào bộ nhớ đệm, nhưng SDK ứng dụng khách sẽ luôn tìm nạp các giá trị mới. Các giá trị được lưu vào bộ nhớ đệm sẽ chỉ được sử dụng khi CACHE_ONLY được chỉ định cho execute() và kết quả ban đầu được trả về từ subscribe().
storage: Bạn có thể định cấu hình SDK ứng dụng khách để lưu vào bộ nhớ đệm các phản hồi trong bộ nhớ persistent hoặc trong memory. Kết quả được lưu vào bộ nhớ đệm trong bộ nhớ persistent sẽ tồn tại trong suốt quá trình khởi động lại ứng dụng. Khi nhắm đến Android hoặc iOS, giá trị mặc định là persistent. Khi nhắm đến trình duyệt web, chỉ hỗ trợ bộ nhớ memory.

Sau khi cập nhật cấu hình lưu vào bộ nhớ đệm của trình kết nối, hãy tạo lại SDK ứng dụng khách và xây dựng lại ứng dụng. Sau khi bạn thực hiện xong, execute() và subscribe() sẽ lưu vào bộ nhớ đệm các phản hồi và sử dụng các giá trị được lưu vào bộ nhớ đệm theo chính sách mà bạn đã định cấu hình. Điều này thường xảy ra tự động mà bạn không cần thực hiện thêm bước nào; tuy nhiên, hãy lưu ý những điều sau:

Hành vi mặc định của execute() như mô tả ở trên: nếu một kết quả được lưu vào bộ nhớ đệm cho một truy vấn và giá trị được lưu vào bộ nhớ đệm không cũ hơn maxAge, thì hãy sử dụng giá trị được lưu vào bộ nhớ đệm. Hành vi mặc định này được gọi là chính sách PREFER_CACHE.

Bạn cũng có thể chỉ định cho từng lệnh gọi execute() để chỉ phân phát các giá trị được lưu vào bộ nhớ đệm (CACHE_ONLY) hoặc để tìm nạp các giá trị mới từ máy chủ một cách vô điều kiện (SERVER_ONLY).
```
await queryRef.execute(fetchPolicy: QueryFetchPolicy.cacheOnly);
```
```
await queryRef.execute(fetchPolicy: QueryFetchPolicy.serverOnly);
```
Khi bạn gọi subscribe(), lệnh này sẽ luôn trả về nội dung được lưu vào bộ nhớ đệm ngay lập tức nếu có, bất kể chế độ cài đặt maxAge. Các lệnh gọi tiếp theo đến execute() sẽ thông báo cho trình nghe theo maxAge đã định cấu hình.

Sử dụng đột biến ở phía ứng dụng khách

Bạn có thể truy cập vào các đột biến theo cách tương tự như truy vấn.

await MoviesConnector.instance.createMovie({ title: 'Empire Strikes Back', releaseYear: 1980, genre: "Sci-Fi" }).rating(5).execute();

Tạo mẫu và kiểm thử ứng dụng Flutter

Thiết bị ứng dụng khách để sử dụng trình mô phỏng cục bộ

Bạn có thể sử dụng trình mô phỏng Data Connect, cho dù từ tiện ích Data Connect VS Code hay từ CLI.

Việc thiết bị ứng dụng để kết nối với trình mô phỏng là giống nhau cho cả hai trường hợp.

import 'package:firebase_data_connect/firebase_data_connect.dart';
import 'generated/movies.dart';

MoviesConnector.instance.dataConnect
          .useDataConnectEmulator('127.0.0.1', 9399);

// Make call<s from your app
Quer>yRefListMoviesData, void ref = MoviesConnector.instance.listMovies.ref();

Để chuyển sang tài nguyên sản xuất, hãy nhận xét các dòng để kết nối với trình mô phỏng.

Kiểu dữ liệu trong SDK Dart

Máy chủ Data Connect đại diện cho các kiểu dữ liệu GraphQL phổ biến. Các kiểu dữ liệu này được biểu thị trong SDK như sau.

Data Connect Kiểu	Dart
Dấu thời gian	firebase_data_connect.Timestamp
Int (32 bit)	int
Ngày	DateTime
mã nhận dạng duy nhất (UUID)	chuỗi
Int64	int
Nổi	double
Boolean	bool
Bất kỳ	firebase_data_connect.AnyValue

Sử dụng các SDK Flutter đã tạo Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.