생성된 웹 SDK 사용

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

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

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

서비스 및 클라이언트 앱에 대한 업데이트를 반복하면 서버 측 업데이트와 클라이언트 측 업데이트가 모두 배포될 준비가 됩니다.

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

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

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

1. 웹 앱에 Firebase를 추가합니다.

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

1. 앱 스키마를 개발합니다.
2. JavaScript SDK 또는 React 또는 Angular 라이브러리로 클라이언트 코드를 초기화합니다.
3. React 및 Angular의 경우 Tanstack Query 패키지를 설치합니다.

4. SDK 생성을 설정합니다.

   • Data Connect VS Code 확장 프로그램의 앱에 SDK 추가 버튼 사용
   • JavaScript SDK 또는 React 또는 Angular의 connector.yaml 업데이트

5. JavaScript SDK 또는 React 또는 Angular로 라이브러리 및 생성된 코드를 가져옵니다.

6. JavaScript SDK 또는 React 또는 Angular로 쿼리 및 변경 호출을 구현합니다.

7. Data Connect 에뮬레이터를 JavaScript SDK 또는 React 또는 Angular로 설정하여 테스트합니다.

Firebase JavaScript SDK로 클라이언트 코드 구현

이 섹션에서는 Firebase JavaScript SDK를 사용하여 클라이언트를 구현하는 방법을 설명합니다.

React 또는 Angular를 사용하는 경우 대체 설정 안내 및 프레임워크용 SDK Data Connect생성에 관한 추가 문서 링크를 참고하세요.

앱 초기화

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

initializeApp({...});

생성된 JavaScript SDK 설치

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

firebase init dataconnect:sdk

앱을 Data Connect 서비스에 연결합니다.

import { connectDataConnectEmulator } from 'firebase/data-connect';
import { connectorConfig } from '@dataconnect/generated';

const dataConnect = getDataConnect(connectorConfig);
// [Optionally] Configure the SDK to use Data Connect local emulator.
connectDataConnectEmulator(dataConnect, 'localhost', 9399);

프로토타입을 만드는 동안 SDK 업데이트

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

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

firebase dataconnect:sdk:generate --watch

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

Firebase CLI를 사용하여 CI/CD 빌드 프로세스에서 Data Connect SDK를 생성할 수 있습니다.

firebase dataconnect:sdk:generate

라이브러리 가져오기

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

일반 가져오기에 포함된 ConnectorConfig 객체를 참고하세요.

// 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 '@dataconnect/generated';

JavaScript SDK의 쿼리 사용

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

import { executeQuery } from 'firebase/data-connect';
import { listMoviesRef } from '@dataconnect/generated';

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

SDK 쿼리 메서드 호출

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

import { listMovies } from '@dataconnect/generated';
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`

열거형 필드 변경사항 처리

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

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

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

하지만 업데이트된 버전의 클라이언트를 출시하기 전에 이전 배포된 클라이언트가 중단될 수 있습니다.

복원력 있는 구현 예

항상 열거형 값에 대한 switch 문에 default 브랜치를 추가하거나 열거형 값과 비교하는 if/else if 블록에 else 브랜치를 추가합니다. 이는 JavaScript/TypeScript 언어에서 적용되지 않지만 새 열거형 값이 추가되는 경우 클라이언트 코드를 견고하게 만드는 방법입니다.

const queryResult = await getOldestMovie();

if (queryResult.data) {
  // we can use a switch statement's "default" case to check for unexpected values
  const oldestMovieAspectRatio = queryResult.data.originalAspectRatio;
  switch (oldestMovieAspectRatio) {
      case AspectRatio.ACADEMY:
      case AspectRatio.WIDESCREEN:
      case AspectRatio.ANAMORPHIC:
        console.log('This movie was filmed in Academy, widescreen or anamorphic aspect ratio!');
        break;
      default:
        // the default case will catch FULLSCREEN, UNAVAILABLE or _UNKNOWN
        // it will also catch unexpected values the SDK isn't aware of, such as CINEMASCOPE
        console.log('This movie was was NOT filmed in Academy, widescreen or anamorphic.');
        break;
  }

  // alternatively, we can check to see if the returned enum value is a known value
  if (!Object.values(AspectRatio).includes(oldestMovieAspectRatio)) {
    console.log(`Unrecognized aspect ratio: ${oldestAspectRatio}`);
  }
} else {
  console.log("no movies found!");
}

JavaScript SDK의 변경 사용

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

import { executeMutation } from 'firebase/data-connect';
import { createMovieRef } from '@dataconnect/generated';

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

Data Connect 에뮬레이터에 연결

선택적으로 connectDataConnectEmulator를 호출한 다음 다음과 같이 Data Connect 인스턴스를 전달하여 에뮬레이터에 연결할 수 있습니다.

import { connectDataConnectEmulator } from 'firebase/data-connect';
import { connectorConfig } from '@dataconnect/generated';

const dataConnect = getDataConnect(connectorConfig);
connectDataConnectEmulator(dataConnect, 'localhost', 9399);`

// Make calls from your app

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

React 및 Angular용 클라이언트 코드 구현

Firebase Data Connect는 Invertase, TanStack Query Firebase의 파트너가 제공하는 라이브러리를 사용하여 React 및 Angular용 후크가 포함된 생성된 SDK를 제공합니다.

이 라이브러리는 애플리케이션에서 Firebase를 사용하여 비동기 작업을 처리하는 데 크게 도움이 되는 후크 세트를 제공합니다.

앱 초기화

먼저 모든 Firebase 웹 앱과 마찬가지로 표준 Firebase 시퀀스를 사용하여 앱을 초기화합니다.

initializeApp({...});

TanStack Query Firebase 패키지 설치

프로젝트에 TanStack Query용 패키지를 설치합니다.

npm i --save @tanstack/react-query @tanstack-query-firebase/react
npm i --save firebase@latest # Note: React has a peer dependency on ^11.3.0

ng add @angular/fire

React 또는 Angular SDK 생성

앞서 설명한 표준 웹 SDK와 마찬가지로 Firebase 도구는 스키마 및 작업을 기반으로 SDK의 자동 생성을 처리합니다.

프로젝트에 React 또는 Angular를 추가한 경우 firebase init dataconnect:sdk를 다시 실행하여 추가 프레임워크 결합을 포함하도록 생성된 SDK를 다시 구성합니다.

라이브러리 가져오기

React 또는 Angular 클라이언트 코드를 초기화하는 데 필요한 가져오기에는 네 가지 세트가 있습니다. 일반 Data Connect 가져오기, 일반 TanStack 가져오기, JS 및 React 생성 SDK의 특정 가져오기입니다.

일반 가져오기에 포함된 ConnectorConfig 유형을 참고하세요.

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

// TanStack Query-related functions
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";

// generated queries and mutations from SDK
import { ListMoviesResponse, connectorConfig } from '@dataconnect/generated';

// generated React hooks from SDK
import { useListAllMovies, useCreateMovie } from "@dataconnect/generated/react";

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

// TanStack Query-related functions
import { provideTanStackQuery, QueryClient } from "@tanstack/angular-query-experimental";

// generated queries and mutations from SDK
import { ListMoviesResponse, connectorConfig } from '@dataconnect/generated';

// generated React hooks from SDK
import { injectListAllMovies, injectCreateMovie } from "@dataconnect/generated/angular";

React 또는 Angular 클라이언트에서 쿼리 및 변경 사용

설정이 완료되면 생성된 SDK의 메서드를 통합할 수 있습니다.

다음 스니펫에서 생성된 SDK의 React용 use-접두사 메서드 useListAllMovies와 Angular용 inject-접두사 메서드 injectListAllMovies를 확인하세요.

import { useListAllMovies } from '@dataconnect/generated/react';

function MyComponent() {
  const { isLoading, data, error } = useListAllMovies();
  if(isLoading) {
    return <div>Loading...</div>
  }
  if(error) {
    return <div> An Error Occurred: {error} </div>
  }
}

// App.tsx
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
import MyComponent from './my-component';

function App() {
  const queryClient = new QueryClient();
  return <QueryClientProvider client={queryClient}>
    <MyComponent />
  </QueryClientProvider>
}

import { injectAllMovies, connectorConfig } from '@dataconnect/generated/angular';
import { provideDataConnect, getDataConnect } from '@angular/fire/data-connect';
import { provideTanStackQuery, QueryClient } from "@tanstack/angular-query-experimental";
const queryClient = new QueryClient();
...
providers: [
  ...
  provideTanStackQuery(queryClient),
  provideDataConnect(() => {
    const dc = getDataConnect(connectorConfig);
    return dc;
  })
]

React 및 Angular로 자동 새로고침 쿼리 사용

데이터가 변경될 때 자동으로 새로고침되도록 쿼리를 구성할 수 있습니다.

export class MovieListComponent {
  movies = useListAllMovies();
}

export class AddPostComponent {
  const mutation = useCreateMovie({ invalidate: [listAllMoviesRef()] });
  addMovie() {
    // The following will automatically cause Tanstack to reload its listAllMovies query
    mutation.mutate({ title: 'The Matrix });
  }
}

// class
export class MovieListComponent {
  movies = injectListAllMovies();
}

// template
@if (movies.isPending()) {
    Loading...
}
@if (movies.error()) {
    An error has occurred: {{  movies.error() }}
}
@if (movies.data(); as data) {
    @for (movie of data.movies; track movie.id) {
    <mat-card appearance="outlined">
        <mat-card-content>{{movie.description}}</mat-card-content>
    </mat-card>
    } @empty {
        <h2>No items!</h2>
    }
}

Data Connect 에뮬레이터에 연결

선택적으로 connectDataConnectEmulator를 호출한 다음 다음과 같이 생성된 후크에 Data Connect 인스턴스를 전달하여 에뮬레이터에 연결할 수 있습니다.

import { getDataConnect, connectDataConnectEmulator } from 'firebase/data-connect';
import { connectorConfig } from '@dataconnect/generated';
import { useListAllMovies } from '@dataconnect/generated/react';

const dc = getDataConnect(connectorConfig);
connectDataConnectEmulator(dc, 'localhost', 9399);

class AppComponent() {
  ...
  const { isLoading, data, error } = useListAllMovies(dc);
  ...
}

// app.config.ts
import { provideDataConnect } from '@angular/fire/data-connect';
import { getDataConnect, connectDataConnectEmulator } from 'firebase/data-connect';
provideDataConnect(() => {
  const dc = getDataConnect(connectorConfig);
  connectDataConnectEmulator(dc, 'localhost', 9399);
  return dc;
}),

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

SDK의 데이터 유형

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

프로토타입을 만드는 동안 SDK 업데이트

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

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

firebase dataconnect:sdk:generate --watch

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

Firebase CLI를 사용하여 CI/CD 빌드 프로세스에서 Data Connect SDK를 생성할 수 있습니다.

firebase dataconnect:sdk:generate