O Google usa tecnologia de IA na tradução de conteúdos para seu idioma de preferência. As traduções com IA podem ter erros.

Usar os SDKs do Flutter gerados

Com os SDKs do cliente do Firebase SQL Connect, é possível chamar consultas e mutações do lado do servidor diretamente de um app do Firebase. Você gera um SDK do cliente personalizado em paralelo ao projetar os esquemas, as consultas e as mutações que implanta no serviço do SQL Connect. Em seguida, integre os métodos desse SDK à lógica do cliente.

Como já mencionamos, é importante observar que as consultas e mutações do SQL Connect não são enviadas pelo código do cliente e executadas no servidor. Em vez disso, quando implantadas, as operações SQL Connect são armazenadas no servidor, como o Cloud Functions. Isso significa que você precisa implantar as mudanças correspondentes no lado do cliente para evitar problemas para os usuários atuais (por exemplo, em versões mais antigas do app).

Por isso, o SQL Connect oferece um ambiente de desenvolvimento e ferramentas que permitem prototipar seus esquemas, consultas e mutações implantados no servidor. Ele também gera SDKs do lado do cliente automaticamente durante a prototipagem.

Depois de iterar as atualizações nos apps de serviço e cliente, as atualizações do lado do servidor e do cliente estarão prontas para implantação.

Qual é o fluxo de trabalho de desenvolvimento do cliente?

Se você seguiu as instruções em Primeiros passos, já conhece o fluxo geral de desenvolvimento do SQL Connect. Neste guia, você vai encontrar informações mais detalhadas sobre como gerar SDKs do Flutter com base no seu esquema e trabalhar com consultas e mutações de clientes.

Em resumo, para usar os SDKs do Flutter gerados nos seus apps clientes, siga estas etapas de pré-requisito:

Adicione o Firebase ao seu app Flutter.
Instale a CLI do flutterfire dart pub global activate flutterfire_cli.
Execute flutterfire configure.

Depois, siga estas instruções:

Desenvolva o esquema do app.
Configure a geração do SDK:
- Com o botão Adicionar SDK ao app na nossa extensão do VS Code do SQL Connect
- Atualizando seu connector.yaml.
Inicialize o código do cliente e importe as bibliotecas.
Implementar chamadas para consultas e mutações.
Configure e use o emulador do SQL Connect e faça iterações.

Gerar o SDK do Flutter

Use a CLI Firebase para configurar os SDKs gerados pelo SQL Connect nos seus apps. O comando init detecta todos os apps na pasta atual e instala os SDKs gerados automaticamente.

firebase init dataconnect:sdk

Atualizar SDKs durante a prototipagem

Se você tiver a extensão do VS Code do SQL Connect instalada, ela sempre manterá os SDKs gerados atualizados.

Se você não usa a extensão do VS Code do SQL Connect, use a CLI do Firebase para manter os SDKs gerados atualizados.

firebase dataconnect:sdk:generate --watch

Gerar SDKs em pipelines de build

Use a CLI do Firebase para gerar SDKs do SQL Connect em processos de build de CI/CD.

firebase dataconnect:sdk:generate

Configurar o código do cliente

Inicializar o app do SQL Connect

Primeiro, inicialize o app usando as instruções de configuração padrão do Firebase.

Em seguida, instale o plug-in SQL Connect:

flutter pub add firebase_data_connect

Inicializar o SDK do Flutter para SQL Connect

Inicialize a instância de SQL Connect usando as informações que você usou para configurar o SQL Connect. Encontre essas informações na página Bancos de dados e armazenamento > SQL Connect do console do Firebase.

Importar bibliotecas

Há dois conjuntos de importações necessários para inicializar o código do cliente: importações gerais do SQL Connect e importações específicas do SDK gerado.

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

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

Usar consultas no lado do cliente

O código gerado já vem com referências de consulta predefinidas. Basta importar e chamar execute neles.

import 'generated/movies.dart';

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

Chamar métodos de consulta do SDK

Veja um exemplo de como usar essas funções de atalho de ação:

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

Campos opcionais

Algumas consultas podem ter campos opcionais. Nesses casos, o SDK do Flutter expõe um método builder, que precisa ser definido separadamente.

Por exemplo, o campo rating é opcional ao chamar createMovie, então é necessário fornecê-lo na função do builder.

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

Receber notificações sobre mudanças

Consulte Receber atualizações em tempo real do SQL Connect.

Processar mudanças em campos de enumeração

O esquema de um app pode conter enumerações, que podem ser acessadas pelas consultas do GraphQL.

À medida que o design de um app muda, é possível adicionar novos valores compatíveis com o tipo enumerado. Por exemplo, imagine que, mais adiante no ciclo de vida do aplicativo, você decida adicionar um valor FULLSCREEN ao tipo enumerado AspectRatio.

No fluxo de trabalho SQL Connect, é possível usar ferramentas para desenvolvedores locais para atualizar as consultas e os SDKs.

No entanto, antes de lançar uma versão atualizada dos clientes, os clientes implantados mais antigos podem falhar.

Exemplo de implementação resiliente

O SDK gerado força o processamento de valores desconhecidos. Ou seja, o código do cliente precisa desencapsular o objeto EnumValue em Known ou 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}');
  }
}

Ativar o armazenamento em cache do lado do cliente

O SQL Connect tem um recurso opcional de armazenamento em cache do lado do cliente, que pode ser ativado editando o arquivo connector.yaml. Quando esse recurso está ativado, os SDKs de cliente gerados armazenam em cache localmente as respostas de consulta, o que pode reduzir o número de solicitações de banco de dados que seu app faz e permite que as partes do app que dependem do banco de dados funcionem quando a disponibilidade da rede é interrompida.

Para ativar o armazenamento em cache do lado do cliente, adicione uma configuração de armazenamento em cache do cliente à configuração do conector:

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

Essa configuração tem dois parâmetros, ambos opcionais:

maxAge: a idade máxima que uma resposta em cache pode ter antes que o SDK do cliente busque novos valores. Exemplos: "0", "30s", "1h30m".

O valor padrão de maxAge é 0, o que significa que as respostas são armazenadas em cache, mas o SDK do cliente sempre busca valores novos. Os valores armazenados em cache só serão usados quando CACHE_ONLY for especificado como execute() e o resultado inicial for retornado de subscribe().
storage: o SDK do cliente pode ser configurado para armazenar respostas em cache no armazenamento persistent ou em memory. Os resultados armazenados em cache no armazenamento persistent vão persistir nas reinicializações do app. Ao segmentar o Android ou o iOS, o padrão é persistent. Ao segmentar navegadores da Web, apenas o armazenamento memory é compatível.

Depois de atualizar a configuração de armazenamento em cache do conector, gere novamente os SDKs do cliente e recrie o app. Depois disso, execute() e subscribe() vão armazenar em cache as respostas e usar os valores armazenados de acordo com a política configurada. Isso geralmente acontece de forma automática, sem que você precise fazer nada. No entanto, observe o seguinte:

O comportamento padrão de execute() é o descrito acima: se um resultado for armazenado em cache para uma consulta e o valor armazenado em cache não for mais antigo que maxAge, use o valor armazenado em cache. Esse comportamento padrão é chamado de política PREFER_CACHE.

Também é possível especificar para invocações individuais de execute() que apenas valores em cache sejam disponibilizados (CACHE_ONLY) ou que valores novos sejam buscados incondicionalmente no servidor (SERVER_ONLY).
```
await queryRef.execute(fetchPolicy: QueryFetchPolicy.cacheOnly);
```
```
await queryRef.execute(fetchPolicy: QueryFetchPolicy.serverOnly);
```
Quando você chama subscribe(), ele sempre retorna imediatamente o conteúdo armazenado em cache, se houver, independente da configuração de maxAge. As chamadas subsequentes para execute() vão notificar os listeners de acordo com o maxAge configurado.

Usar mutações no lado do cliente

As mutações são acessíveis da mesma forma que as consultas.

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

Criar protótipos e testar apps do Flutter

Instrumentar clientes para usar um emulador local

É possível usar o emulador SQL Connect, seja na extensão do VS Code do SQL Connect ou na CLI.

A instrumentação do app para se conectar ao emulador é a mesma nos dois cenários.

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

Para mudar para os recursos de produção, comente as linhas de conexão com o emulador.

Tipos de dados no SDK do Dart

O servidor SQL Connect representa tipos de dados comuns do GraphQL. Eles são representados no SDK da seguinte maneira.

Tipo SQL Connect	Dart
Carimbo de data/hora	firebase_data_connect.Timestamp
Int (32 bits)	int
Data	DateTime
UUID	string
Int64	int
Ponto flutuante	double
Booleano	bool
Qualquer	firebase_data_connect.AnyValue

Usar os SDKs do Flutter gerados Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.