생성된 웹 SDK 사용

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

다른 곳에서 언급했듯이 Data Connect 쿼리와 변형은 클라이언트 코드에서 제출되지 않으며 서버에서 실행됩니다. 대신 배포 시 Data Connect 작업은 Cloud Functions와 같이 서버에 저장됩니다. 즉, 기존 사용자를 손상시키지 않도록(예: 이전 앱 버전) 상응하는 클라이언트 측 변경사항을 배포해야 합니다.

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

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

웹 SDK 생성

대부분의 Firebase 프로젝트와 마찬가지로 Firebase Data Connect 클라이언트 코드 작업은 로컬 프로젝트 디렉터리에서 진행됩니다. Data Connect VS Code 확장 프로그램과 Firebase CLI는 모두 클라이언트 코드를 생성하고 관리하는 데 중요한 로컬 도구입니다.

SDK 생성 옵션은 프로젝트를 초기화할 때 생성된 dataconnect.yaml 파일의 여러 항목에 키가 지정됩니다.

SDK 생성 초기화

connector.yaml에서 outputDir, package, 웹 SDK의 경우 packageJsonDir를 추가합니다. 
generate:
  javascriptSdk:
    outputDir: "../movies-generated"
    package: "@movie-app/movies"
    packageJsonDir: "../../"

outputDir는 생성된 SDK가 출력되어야 하는 위치를 지정합니다.

package은 패키지 이름을 지정합니다.

packageJsonDir은 패키지를 설치할 위치를 지정합니다.

이 경우 firebase@latest를 설치하여 이 피어 종속 항목이 처리되도록 합니다.

node_modules 기준 경로 구성

웹 SDK의 경우 Data Connect가 npm link를 사용하여 SDK를 설치하므로 생성된 SDK는 node_modules 경로와 동일한 수준의 디렉터리 또는 node_modules에 액세스할 수 있는 하위 디렉터리에 출력되어야 합니다.

즉, 생성된 SDK가 제대로 작동하려면 firebase 노드 모듈에 액세스할 수 있어야 합니다.

예를 들어 my-app/에 node_modules가 있는 경우 js-email-generated가 상위 node_modules 폴더에서 가져올 수 있도록 출력 디렉터리는 my-app/js-email-generated여야 합니다.

my-app/
  dataconnect/
    connector/
        connector.yaml
  node_modules/
    firebase/
  js-email-generated/

// connector.yaml
connectorId: "my-connector"
generate:
  javascriptSdk:
    outputDir: "../../js-email-generated"
    package: "@myapp/my-connector"

또는 루트에서 모듈을 호스팅하는 모노레포가 있는 경우 출력 디렉터리를 모노레포의 원하는 폴더에 배치할 수 있습니다.

my-monorepo/
  dataconnect/
    connector/
        connector.yaml
  node_modules/
    firebase/
  my-app/
    js-email-generated/
  package.json

// connector.yaml
connectorId: "my-connector"
generate:
  javascriptSdk:
    outputDir: "../../my-app/js-email-generated" # You can also output to ../../js-email-generated

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

Data Connect VS Code 확장 프로그램 및 Data Connect 에뮬레이터로 대화형 프로토타입을 제작하는 경우 스키마, 쿼리, 변형을 정의하는 .gql 파일을 수정하는 동안 SDK 소스 파일이 자동으로 생성되고 업데이트됩니다. 이 기능은 핫 (재)로드 워크플로에서 유용한 기능이 될 수 있습니다.

다른 시나리오에서는 Firebase CLI의 Data Connect 에뮬레이터를 사용하는 경우 .gql 업데이트 시 시계를 설정하고 SDK 소스가 자동으로 업데이트되도록 할 수 있습니다.

또는 .gql 파일이 변경될 때마다 CLI를 사용하여 SDK를 재생성할 수 있습니다.

firebase dataconnect:sdk:generate --watch

통합 및 프로덕션 출시용 SDK 생성

CI 테스트를 위해 제출할 프로젝트 소스를 준비하는 등의 시나리오에서는 Firebase CLI를 호출하여 일괄 업데이트할 수 있습니다.

이러한 경우에는 firebase dataconnect:sdk:generate를 사용합니다.

클라이언트 코드 설정

Data Connect 앱 초기화

먼저 표준 Firebase 시퀀스를 사용하여 앱을 초기화합니다.

initializeApp({...});

Data Connect 웹 SDK 초기화

데이터 연결을 설정하는 데 사용한 정보를 사용하여 Data Connect 인스턴스를 초기화합니다 (모두 Firebase 콘솔의 데이터 연결 탭에서 확인 가능).

ConnectorConfig 객체

SDK에는 커넥터 구성 객체가 필요합니다.

이 객체는 dataconnect.yaml의 serviceId 및 location와 connector.yaml의 connectorId에서 자동으로 생성됩니다.

라이브러리 가져오기

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

// general imports
import { ConnectorConfig, DataConnect, getDataConnect, QueryRef, MutationRef, QueryPromise, MutationPromise } from 'firebase/data-connect';

// generated queries and mutations from SDK
import { listMovies, ListMoviesResponse, createMovie, connectorConfig } from '@myorg/myconnector';

웹 클라이언트 프로토타입 제작 및 테스트

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

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

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

import { connectDataConnectEmulator } from 'firebase/data-connect';
import { connectorConfig } from '@myorg/myconnector'; // Replace with your package name
const dataConnect = getDataConnect(connectorConfig);

connectDataConnectEmulator(dataConnect, 'localhost', 9399);`

// Make calls from your app

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

인스턴스 가져오기

getDataConnect를 호출하는 것은 Data Connect 에뮬레이터에 연결하려는 경우에만 필요합니다. 그렇지 않으면 생성된 SDK가 DataConnect 객체의 인스턴스를 자동으로 생성합니다.

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

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

import { executeQuery } from 'firebase/data-connect';
import { listMoviesRef } from '@movie-app/movies';

const ref = listMoviesRef();
const { data } = await executeQuery(ref);
console.log(data.movies);

SDK 쿼리 메서드 호출

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

import { listMovies } from '@movie-app/movies';
function onBtnClick() {
// This will call the generated JS from the CLI and then make an HTTP request out // to the server.
listMovies().then(data => showInUI(data)); // == executeQuery(listMoviesRef);
}

변경사항 구독

변경사항을 구독할 수 있으며, 이 경우 쿼리를 실행할 때마다 업데이트됩니다.

const listRef = listAllMoviesRef();

// subscribe will immediately invoke the query if no execute was called on it previously.
subscribe(listRef, ({ data }) => {
 updateUIWithMovies(data.movies);
});

await createMovie({ title: 'Empire Strikes Back', releaseYear: 1980, genre: "Sci-Fi", rating: 5 });\
await listMovies(); // will update the subscription above`

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

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

import { executeMutation } from 'firebase/data-connect';
import { createMovieRef } from '@movie-app/movies';

const { data } = await executeMutation(createMovieRef({ movie: 'Empire Strikes Back' }));

웹 SDK의 데이터 유형

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

데이터 연결 유형 TypeScript
타임스탬프 문자열
날짜 문자열
UUID : 범용 고유 식별자 문자열
Int64 문자열
Double 숫자
부동 소수점 수 숫자

프레임워크 고려사항

Angular

코드를 생성할 때 Angular CLI는 종속 항목 최적화 코드로 인해 새 변경사항을 선택하지 않습니다. 이 문제를 해결하려면 angular.json를 수정해야 합니다.

  "projects": {
      "myproject": {
         "architect": {
                 "serve:": {
                            "prebundle": {
                                         "exclude": ["@movie-app/movies"]
                              }
                   }
            }
     }
  }