Użyj wygenerowanych internetowych pakietów SDK

Firebase Data Connect pakiety SDK klienta umożliwiają wywoływanie zapytań i mutacji po stronie serwera bezpośrednio z aplikacji Firebase. Niestandardowy pakiet SDK klienta generujesz równolegle z projektowaniem schematów, zapytań i mutacji, które wdrażasz w usłudze Data Connect. Następnie zintegruj metody z tego pakietu SDK z logiką klienta.

Jak już wspominaliśmy, warto pamiętać, że Data Connect zapytania i mutacje nie są przesyłane przez kod klienta i wykonywane na serwerze. Zamiast tego po wdrożeniu operacje Data Connect są przechowywane na serwerze, tak jak Cloud Functions. Oznacza to, że musisz wdrożyć odpowiednie zmiany po stronie klienta, aby uniknąć problemów u dotychczasowych użytkowników (np. w starszych wersjach aplikacji).

Dlatego Data Connect udostępnia środowisko programistyczne i narzędzia, które umożliwiają tworzenie prototypów schematów, zapytań i mutacji wdrażanych na serwerze. Podczas tworzenia prototypu automatycznie generuje też pakiety SDK po stronie klienta.

Gdy wprowadzisz aktualizacje usługi i aplikacji klienckich, aktualizacje po stronie serwera i po stronie klienta będą gotowe do wdrożenia.

Jak wygląda proces tworzenia aplikacji klienckiej?

Jeśli postępujesz zgodnie z instrukcjami w sekcji Pierwsze kroki, poznasz ogólny proces tworzenia aplikacji Data Connect. W tym przewodniku znajdziesz bardziej szczegółowe informacje o generowaniu internetowych pakietów SDK na podstawie schematu oraz o pracy z zapytaniami i mutacjami klienta.

Możesz nauczyć się tworzenia aplikacji klienckich, korzystając z repozytorium aplikacji szybkiego startu, i zbudować w pełni funkcjonalną aplikację Data Connect, postępując zgodnie z naszymi ćwiczeniami z programowania dotyczącymi internetu.

Podsumowując, aby używać wygenerowanych pakietów Web SDK w aplikacjach klienckich, musisz wykonać te czynności wstępne:

1. Dodaj Firebase do aplikacji internetowej.

Następnie:

1. Opracuj schemat aplikacji.
2. Zainicjuj kod klienta za pomocą pakietu SDK JavaScript lub bibliotek React albo Angular.
3. W przypadku Reacta i Angulara zainstaluj pakiety Tanstack Query.

4. Skonfiguruj generowanie pakietu SDK:

   • Za pomocą przycisku Dodaj pakiet SDK do aplikacji w rozszerzeniu Data Connect VS Code
   • Aktualizując connector.yaml w przypadku pakietu SDK JavaScript lub React albo Angular.

5. Importuj biblioteki i wygenerowany kod za pomocą pakietu SDK JavaScript lub React albo Angular.

6. Zaimplementuj wywołania zapytań i mutacji za pomocą pakietu SDK JavaScript, Reaguj lub Angular.

7. Przeprowadź test, konfigurując Data Connect emulator za pomocą pakietu SDK JavaScript lub React albo Angular.

Implementowanie kodu klienta za pomocą pakietu SDK Firebase JavaScript

W tej sekcji znajdziesz informacje o tym, jak wdrażać klientów za pomocą pakietu SDK Firebase JavaScript.

Jeśli używasz Reacta lub Angulara, zapoznaj się z alternatywnymi instrukcjami konfiguracji i linkami do dodatkowej dokumentacji na temat generowania pakietów SDK Data Connect dla platform.

Inicjowanie aplikacji

Najpierw zainicjuj aplikację, korzystając z standardowej sekwencji Firebase.

initializeApp({...});

Instalowanie wygenerowanego pakietu JavaScript SDK

Użyj interfejsu wiersza poleceń Firebase, aby skonfigurować w aplikacjach wygenerowane pakiety SDK Data Connect. Polecenie init powinno wykryć wszystkie aplikacje w bieżącym folderze i automatycznie zainstalować wygenerowane pakiety SDK.

firebase init dataconnect:sdk

Połącz aplikację z usługą 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);

Aktualizowanie pakietów SDK podczas tworzenia prototypu

Jeśli masz zainstalowane rozszerzenie Data Connect VS Code, będzie ono zawsze aktualizować wygenerowane pakiety SDK.

Jeśli nie używasz rozszerzenia Data Connect VS Code, możesz użyć interfejsu Firebase CLI, aby aktualizować wygenerowane pakiety SDK.

firebase dataconnect:sdk:generate --watch

Generowanie pakietów SDK w potokach kompilacji

Za pomocą interfejsu wiersza poleceń Firebase możesz generować pakiety SDK Data Connect w procesach kompilacji CI/CD.

firebase dataconnect:sdk:generate

Importowanie bibliotek

Do zainicjowania kodu klienta potrzebne są 2 zestawy importów: ogólne importyData Connect i konkretne, wygenerowane importy pakietu SDK.

Zwróć uwagę na obiekt ConnectorConfig uwzględniony w ogólnych importach.

// 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';

Używanie zapytań z pakietu JavaScript SDK

Wygenerowany kod będzie już zawierać wstępnie zdefiniowane odwołania do zapytań. Wystarczy je zaimportować i wywołać funkcję execute.

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

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

Wywoływanie metod zapytań pakietu SDK

Oto przykład użycia tych funkcji skrótów do działań:

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

Subskrybowanie zmian

Możesz subskrybować zmiany (które będą aktualizowane za każdym razem, gdy wykonasz zapytanie).

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`

Obsługa zmian w polach wyliczeniowych

Schemat aplikacji może zawierać wyliczenia, do których można uzyskać dostęp za pomocą zapytań GraphQL.

W miarę zmian w projekcie aplikacji możesz dodawać nowe obsługiwane wartości wyliczeniowe. Załóżmy, że w późniejszym okresie istnienia aplikacji zdecydujesz się dodać wartość FULLSCREEN do wyliczenia AspectRatio.

W przypadku przepływu pracy Data Connect możesz używać lokalnych narzędzi programistycznych do aktualizowania zapytań i pakietów SDK.

Zanim jednak udostępnisz zaktualizowaną wersję klientów, starsi wdrożeni klienci mogą przestać działać.

Przykład odpornej implementacji

Zawsze dodawaj gałąź default do instrukcji switch w przypadku wartości typu wyliczeniowego lub gałąź else do bloku if/else if porównującego z wartościami typu wyliczeniowego. Nie jest to wymuszane przez język JavaScript/TypeScript, ale jest to sposób na zwiększenie niezawodności kodu klienta w przypadku dodania nowych wartości wyliczeniowych.

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!");
}

Używanie mutacji z pakietu JavaScript SDK

Mutacje są dostępne w taki sam sposób jak zapytania.

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

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

Połącz się z emulatorem Data Connect

Opcjonalnie możesz połączyć się z emulatorem, wywołując connectDataConnectEmulator i przekazując instancję Data Connect, jak pokazano poniżej:

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

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

// Make calls from your app

Aby przełączyć się na zasoby produkcyjne, zakomentuj wiersze służące do łączenia się z emulatorem.

Uwaga: wywołanie getDataConnect jest wymagane tylko wtedy, gdy chcesz połączyć się z emulatorem Data Connect. W przeciwnym razie wygenerowany pakiet SDK automatycznie utworzy instancję obiektu DataConnect.

Implementowanie kodu klienta dla platform React i Angular

Firebase Data Connect udostępnia wygenerowany pakiet SDK z funkcjami dla Reacta i Angulara, korzystając z bibliotek dostępnych u naszych partnerów z Invertase, TanStack Query Firebase.

Ta biblioteka zawiera zestaw hooków, które znacznie ułatwiają obsługę zadań asynchronicznych w Firebase w aplikacjach.

Inicjowanie aplikacji

Najpierw, tak jak w przypadku każdej aplikacji internetowej Firebase, zainicjuj aplikację za pomocą standardowej sekwencji Firebase.

initializeApp({...});

Instalowanie pakietów TanStack Query Firebase

zainstalować pakiety TanStack Query w projekcie;

Dodaj reakcję

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

Angular

ng add @angular/fire

Generowanie pakietu SDK React lub Angular

Podobnie jak w przypadku standardowego pakietu SDK do klienta internetowego, o czym pisaliśmy wcześniej, narzędzia Firebase automatycznie generują pakiety SDK na podstawie Twojego schematu i operacji.

Jeśli dopiero co dodano do projektu React lub Angular, ponownie uruchom firebase init dataconnect:sdk, aby ponownie skonfigurować wygenerowane pakiety SDK i uwzględnić dodatkowe powiązania frameworka.

Importowanie bibliotek

Do zainicjowania kodu klienta React lub Angular potrzebne są 4 zestawy importów: ogólne importy Data Connect, ogólne importy TanStack oraz importy specyficzne dla wygenerowanych pakietów SDK w JS i React.

Zwróć uwagę na typ ConnectorConfig uwzględniony w ogólnych importach.

Dodaj reakcję

// 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";

Angular

// 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";

Używanie zapytań i mutacji w kliencie React lub Angular

Po zakończeniu konfiguracji możesz włączyć metody z wygenerowanego pakietu SDK.

W poniższym fragmencie kodu zwróć uwagę na metodę z prefiksem useuseListAllMovies w przypadku Reacta i metodę z prefiksem injectinjectListAllMovies w przypadku Angulara. Obie pochodzą z wygenerowanego pakietu SDK.

Dodaj reakcję

Wszystkie operacje w wygenerowanym pakiecie SDK, zarówno zapytania, jak i mutacje, wywołują powiązania TanStack Query:

• Wysyła zapytania i zwraca hooka TanStack useDataConnectQuery.
• Wywołania mutacji i zwracanie haczyka TanStack useDataConnectMutation

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>
}

Angular

Uwaga: ng add @angular/fire zrobi to za Ciebie automatycznie, ale jeśli chcesz skonfigurować to ustawienie ręcznie, możesz to zrobić za pomocą tego kodu:

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

Używanie zapytań z automatycznym ponownym wczytywaniem w React i Angular

Możesz skonfigurować zapytania tak, aby automatycznie przeładowywały się po zmianie danych.

Dodaj reakcję

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

Angular

// 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>
    }
}

Połącz się z emulatorem Data Connect

Opcjonalnie możesz połączyć się z emulatorem, wywołując funkcję connectDataConnectEmulator, a następnie przekazując do wygenerowanego haka instancję Data Connect, jak w tym przykładzie:

Dodaj reakcję

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

Angular

// 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;
}),

Aby przełączyć się na zasoby produkcyjne, zakomentuj wiersze służące do łączenia się z emulatorem.

Uwaga: wywołanie getDataConnect jest wymagane tylko wtedy, gdy chcesz połączyć się z emulatorem Data Connect. W przeciwnym razie wygenerowany pakiet SDK automatycznie utworzy instancję obiektu DataConnect.

Typy danych w pakiecie SDK

Data Connect serwer reprezentuje typowe typy danych GraphQL. W pakiecie SDK są one reprezentowane w ten sposób:

Typ połączenia danych	TypeScript
Sygnatura czasowa	ciąg znaków
Data	ciąg znaków
UUID	ciąg znaków
Int64	ciąg znaków
Liczba zmiennoprzecinkowa	Liczba
Liczba zmiennoprzecinkowa	Liczba

Aktualizowanie pakietów SDK podczas tworzenia prototypu

Jeśli masz zainstalowane rozszerzenie Data Connect VS Code, będzie ono zawsze aktualizować wygenerowane pakiety SDK.

Jeśli nie używasz rozszerzenia Data Connect VS Code, możesz użyć interfejsu Firebase CLI, aby aktualizować wygenerowane pakiety SDK.

firebase dataconnect:sdk:generate --watch

Generowanie pakietów SDK w potokach kompilacji

Za pomocą interfejsu wiersza poleceń Firebase możesz generować pakiety SDK Data Connect w procesach kompilacji CI/CD.

firebase dataconnect:sdk:generate