생성된 Flutter SDK 사용

Firebase Data Connect 클라이언트 SDK를 사용하면 Firebase 앱에서 서버 측 쿼리 및 변형을 직접 호출할 수 있습니다. Data Connect 서비스에 배포할 스키마, 쿼리, 변형을 설계할 때 맞춤 클라이언트 SDK를 동시에 생성합니다. 그런 다음 이 SDK의 메서드를 클라이언트 로직에 통합합니다.

다른 곳에서 언급했듯이 Data Connect 쿼리와 변이는 클라이언트 코드에 의해 제출되고 서버에서 실행되지 않습니다. 대신 배포되면 Data Connect 작업이 Cloud Functions와 같이 서버에 저장됩니다. 즉, 기존 사용자 (예: 이전 앱 버전)가 중단되지 않도록 해당하는 클라이언트 측 변경사항을 배포해야 합니다.

따라서 Data Connect는 서버에 배포된 스키마, 쿼리, 변형을 프로토타입으로 만들 수 있는 개발자 환경과 도구를 제공합니다. 프로토타입을 만드는 동안 클라이언트 측 SDK도 자동으로 생성됩니다.

서비스 및 클라이언트 앱에 대한 업데이트를 반복하면 서버 측 및 클라이언트 측 업데이트를 모두 배포할 수 있습니다.

클라이언트 개발 워크플로란 무엇인가요?

시작하기를 따른 경우 Data Connect의 전반적인 개발 흐름을 살펴봤을 것입니다. 이 가이드에서는 스키마에서 Flutter SDK를 생성하고 클라이언트 쿼리 및 변형을 사용하는 방법에 관한 자세한 정보를 확인할 수 있습니다.

요약하자면 클라이언트 앱에서 생성된 Flutter SDK를 사용하려면 다음 필수 단계를 따르세요.

  1. Flutter 앱에 Firebase를 추가합니다.
  2. flutterfire CLI dart pub global activate flutterfire_cli를 설치합니다.
  3. flutterfire configure를 실행합니다.

그런 다음 아래를 실행합니다.

  1. 앱 스키마를 개발합니다.
  2. SDK 생성을 설정합니다.

  3. 클라이언트 코드를 초기화하고 라이브러리를 가져옵니다.

  4. 쿼리 호출 구현변형

  5. Data Connect 에뮬레이터를 설정하고 사용하여 반복합니다.

Flutter SDK 생성

Firebase CLI를 사용하여 앱에서 Data Connect 생성 SDK를 설정합니다. init 명령어를 사용하면 현재 폴더의 모든 앱이 감지되고 생성된 SDK가 자동으로 설치됩니다.

firebase init dataconnect:sdk

프로토타입 제작 중에 SDK 업데이트

Data Connect VS Code 확장 프로그램이 설치되어 있으면 생성된 SDK가 항상 최신 상태로 유지됩니다.

Data Connect VS Code 확장 프로그램을 사용하지 않는 경우 Firebase CLI를 사용하여 생성된 SDK를 최신 상태로 유지할 수 있습니다.

firebase dataconnect:sdk:generate --watch

빌드 파이프라인에서 SDK 생성

Firebase CLI를 사용하여 CI/CD 빌드 프로세스에서 데이터 커넥트 SDK를 생성할 수 있습니다.

firebase dataconnect:sdk:generate

클라이언트 코드 설정

Data Connect 앱 초기화

먼저 표준 Firebase 설정 안내를 사용하여 앱을 초기화합니다.

그런 다음 Data Connect 플러그인을 설치합니다.

flutter pub add firebase_data_connect

Data Connect Flutter SDK 초기화

Firebase 콘솔의 Data Connect 탭에서 확인할 수 있는 Data Connect 설정에 사용한 정보를 사용하여 Data Connect 인스턴스를 초기화합니다.

라이브러리 가져오기

클라이언트 코드를 초기화하는 데 필요한 가져오기에는 일반 Data Connect 가져오기와 생성된 특정 SDK 가져오기의 두 가지가 있습니다.

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

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

클라이언트 측에서 쿼리 사용

생성된 코드에는 사전 정의된 쿼리 참조가 이미 포함되어 있습니다. execute를 가져와서 호출하기만 하면 됩니다.

import 'generated/movies.dart';

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

SDK 쿼리 메서드 호출

다음은 이러한 작업 바로가기 함수를 사용하는 예입니다.

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();
}

선택사항 입력란

일부 쿼리에는 선택적 필드가 있을 수 있습니다. 이 경우 Flutter SDK는 빌더 메서드를 노출하며 별도로 설정해야 합니다.

예를 들어 createMovie를 호출할 때 rating 필드는 선택사항이므로 빌더 함수에서 제공해야 합니다.

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

변경사항 구독

변경사항을 구독하여 쿼리를 실행할 때마다 업데이트할 수 있습니다.

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`

열거형 필드 변경사항 처리

앱의 스키마는 GraphQL 쿼리에서 액세스할 수 있는 열거형을 포함할 수 있습니다.

앱의 디자인이 변경되면 지원되는 새 enum 값을 추가할 수 있습니다. 예를 들어 애플리케이션의 수명 주기 후반에 AspectRatio enum에 FULLSCREEN 값을 추가하기로 결정했다고 가정해 보겠습니다.

Data Connect 워크플로에서는 로컬 개발 도구를 사용하여 쿼리와 SDK를 업데이트할 수 있습니다.

하지만 업데이트된 클라이언트 버전을 출시하기 전에 배포된 이전 클라이언트가 작동하지 않을 수 있습니다.

복원력 있는 구현 예

생성된 SDK는 알 수 없는 값의 처리를 강제합니다. 즉, 클라이언트 코드는 EnumValue 객체를 Known 또는 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}");
  }
}

클라이언트 측에서 변형 사용

변형은 쿼리와 동일한 방식으로 액세스할 수 있습니다.

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

Flutter 앱 프로토타입 제작 및 테스트

로컬 에뮬레이터를 사용하도록 클라이언트 계측

Data Connect VS Code 확장 프로그램에서든 CLI에서든 Data Connect 에뮬레이터를 사용할 수 있습니다.

에뮬레이터에 연결하도록 앱을 계측하는 것은 두 시나리오 모두 동일합니다.

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();

프로덕션 리소스로 전환하려면 에뮬레이터에 연결하는 줄을 주석 처리합니다.

Dart SDK의 데이터 유형

Data Connect 서버는 일반적인 GraphQL 데이터 유형을 나타냅니다. 이는 SDK에서 다음과 같이 표현됩니다.

데이터 연결 유형 Dart
타임스탬프 firebase_data_connect.Timestamp
Int (32비트) int
날짜 DateTime
UUID 문자열
Int64 int
부동 소수점 수 double
불리언 부울
모두 firebase_data_connect.AnyValue