Saiba mais sobre a Web e Firebase

Ao desenvolver um aplicativo da Web usando o Firebase, você pode encontrar conceitos desconhecidos ou áreas em que precisa de mais informações para tomar as decisões corretas para seu projeto. Esta página tem como objetivo responder a essas perguntas ou indicar recursos para saber mais.

Se você tiver dúvidas sobre um tópico não abrangidos nesta página, visite um dos nossos comunidades online . Também atualizaremos esta página com novos tópicos periodicamente, portanto, verifique novamente se adicionamos o tópico sobre o qual você deseja aprender.

SDK versões 8 e 9

O Firebase oferece duas versões do SDK para aplicativos da Web:

  • Versão 8. Esta é a interface JavaScript que Firebase manteve por vários anos e é familiar para os desenvolvedores da Web com aplicativos Firebase existentes. Como o Firebase removerá o suporte para esta versão após um grande ciclo de lançamento, os novos aplicativos devem adotar a versão 9.
  • Versão Modular 9. Este SDK introduz uma abordagem modular que fornece o tamanho SDK e maior eficiência reduzida com ferramentas modernas de construção de JavaScript como Webpack ou Rollup .

A versão 9 integra-se bem com ferramentas de compilação que removem o código que não está sendo usado em seu aplicativo, um processo conhecido como "agitação de árvore". Os aplicativos criados com esse SDK se beneficiam de dimensões de tamanho bastante reduzidas. A versão 8, embora disponível como módulo, não possui uma estrutura estritamente modular e não oferece o mesmo grau de redução de tamanho.

Embora a maioria do SDK da versão 9 siga os mesmos padrões da versão 8, a organização do código é diferente. Geralmente, a versão 8 é orientada para um namespace e padrão de serviço, enquanto a versão 9 é orientada para funções discretas. Por exemplo, versão 8 do dot-encadeamento, tais como firebaseApp.auth() , é substituída na versão 9 por um único getAuth() a função que leva firebaseApp e retorna uma instância de autenticação.

Isso significa que os aplicativos Web criados com a versão 8 ou anterior exigem refatoração para aproveitar a abordagem modular da versão 9. O Firebase fornece bibliotecas compatíveis para facilitar essa transição; veja o guia de atualização para obter mais detalhes.

O que é suportado?

Embora a versão 8 e a versão 9 tenham estilos de código diferentes, elas oferecem suporte muito semelhante para recursos e opções do Firebase. Como descreveremos em detalhes neste guia, ambas as versões do SDK são compatíveis com as variantes JavaScript e Node.js, além de várias opções para adicionar/instalar os SDKs.

Adicione SDKs com 8.0 (com namespace) 9.0 (Modular)
npm
  • Para JavaScript
  • Para Node.js
  • Para JavaScript
  • Para Node.js
CDN (Rede de Entrega de Conteúdo)
  • Para JavaScript
  • Para JavaScript
URLs de hospedagem
  • Para JavaScript
  • Para Node.js

Para mais informações, consulte Maneiras de adicionar os SDKs da Web para seu aplicativo e Firebase Web SDK variantes mais tarde nesta página.

Versão 9 para novos aplicativos

Se você está começando em uma nova integração com o Firebase, você pode optar para a versão 9 SDK quando você adicionar e inicializar o SDK .

Como você desenvolver seu aplicativo, tenha em mente que o seu código será organizado principalmente em torno de funções. Na versão 9, os serviços são passados ​​como o primeiro argumento e a função usa os detalhes do serviço para fazer o resto. Por exemplo:

import { getAuth, onAuthStateChanged } from "firebase/auth";

const auth = getAuth(firebaseApp);
onAuthStateChanged(auth, user => {
  // Check for user status
});

Para mais exemplos e detalhes, consulte os guias para cada área de produto, bem como a documentação de referência versão 9 .

Maneiras de adicionar os SDKs da Web ao seu aplicativo

O Firebase fornece bibliotecas JavaScript para a maioria dos produtos Firebase, incluindo Configuração remota, FCM e muito mais. A forma como você adiciona SDKs do Firebase ao seu aplicativo da Web depende de quais ferramentas você está usando com seu aplicativo (como um empacotador de módulos) ou se seu aplicativo é executado em um ambiente sem navegador, como Node.js.

Você pode adicionar qualquer um dos bibliotecas disponíveis para seu aplicativo através de um dos métodos suportados:

  • npm (para empacotadores de módulos e Node.js)
  • CDN (rede de entrega de conteúdo)

Para obter instruções de instalação detalhadas, consulte Adicionar Firebase ao seu JavaScript App . O restante desta seção contém informações para ajudá-lo a escolher entre as opções disponíveis.

npm

O download do pacote npm do Firebase (que inclui pacotes de navegador e Node.js) fornece uma cópia local do SDK do Firebase, que pode ser necessária para aplicativos que não são de navegador, como aplicativos Node.js, React Native ou Electron. O download inclui pacotes Node.js e React Native como opção para alguns pacotes. Os pacotes Node.js são necessários para a etapa de renderização do lado do servidor (SSR) das estruturas SSR.

Usando npm com um módulo bundler como Webpack ou Rollup oferece opções de otimização para "árvore-shake" código não utilizado e aplicar polyfills alvo, o que pode reduzir significativamente a pegada tamanho do seu aplicativo. A implementação desses recursos pode adicionar alguma complexidade à sua configuração e cadeia de construção, mas várias ferramentas CLI principais podem ajudar a mitigar isso. Essas ferramentas incluem Angular , Reagir , Vue , Avançar , e outros.

Resumindo:

  • Fornece otimização valiosa do tamanho do aplicativo
  • Ferramentas robustas estão disponíveis para gerenciar módulos
  • Obrigatório para SSR com Node.js

CDN (rede de entrega de conteúdo)

Adicionar bibliotecas armazenadas na CDN do Firebase é um método simples de configuração do SDK que pode ser familiar para muitos desenvolvedores. Usando o CDN para adicionar os SDKs, você não precisará de uma ferramenta de compilação, e sua cadeia de compilação tende a ser mais simples e fácil de trabalhar em comparação com os empacotadores de módulos. Se você não estiver especialmente preocupado com o tamanho instalado do seu aplicativo e não tiver requisitos especiais, como transpilar do TypeScript, o CDN pode ser uma boa escolha.

Resumindo:

  • Familiar e simples
  • Apropriado quando o tamanho do aplicativo não é uma grande preocupação
  • Apropriado quando seu site não usa ferramentas de construção.

Variantes do SDK da Web do Firebase

Atualmente, o Firebase oferece duas variantes do SDK da Web:

  • Um pacote JavaScript compatível com todos os recursos do Firebase para uso no navegador.
  • Um pacote Node.js do lado do cliente que oferece suporte a muitos recursos do Firebase, mas não a todos. Veja a lista de ambientes suportados .

Essas duas variantes do SDK são projetadas para ajudar a criar aplicativos Web ou aplicativos cliente para acesso do usuário final, como em um desktop Node.js ou aplicativo IoT. Se o seu objetivo é a criação de acesso administrativo a partir de ambientes privilegiados (como servidores) usar o Firebase administração SDK em seu lugar.

Detecção de ambiente com bundlers e frameworks

Quando você instala o Firebase Web SDK usando npm, as versões JavaScript e Node.js são instaladas. O pacote fornece detecção detalhada do ambiente para habilitar os pacotes certos para seu aplicativo.

Se o seu código usa Node.js require declarações, o SDK encontra o pacote específico do Node. Caso contrário, as configurações do seu bundler deve ser calculada corretamente para detectar o campo ponto de entrada para a direita em sua package.json arquivo (por exemplo, main , browser , ou module ). Se ocorrerem erros de tempo de execução com o SDK, verifique se o bundler está configurado para priorizar o tipo correto de bundle para seu ambiente.

Saiba mais sobre o objeto de configuração do Firebase

Para inicializar o Firebase no seu aplicativo, você precisa fornecer a configuração do projeto do Firebase do seu aplicativo. Você pode obter o seu objeto de configuração Firebase a qualquer momento.

  • Nós não recomendamos editar manualmente o objeto de configuração, especialmente os seguintes necessários "opções Firebase": apiKey , projectId e appID . Se você inicializar seu aplicativo com valores inválidos ou ausentes para essas "opções do Firebase" obrigatórias, os usuários do seu aplicativo poderão enfrentar problemas sérios.

  • Se você ativou o Google Analytics em seu projeto Firebase, o seu objeto de configuração contém o campo measurementId . Saiba mais sobre este campo nas Analytics página Introdução .

Aqui está o formato de um objeto de configuração com todos os serviços habilitados (esses valores são preenchidos automaticamente):

// For Firebase JavaScript SDK v7.20.0 and later, `measurementId` is an optional field
var firebaseConfig = {
  apiKey: "API_KEY",
  authDomain: "PROJECT_ID.firebaseapp.com",
  databaseURL: "https://PROJECT_ID.firebaseio.com",
  projectId: "PROJECT_ID",
  storageBucket: "PROJECT_ID.appspot.com",
  messagingSenderId: "SENDER_ID",
  appId: "APP_ID",
  measurementId: "G-MEASUREMENT_ID",
};

Bibliotecas disponíveis

Opções de configuração adicionais

Atrasar o carregamento de SDKs do Firebase (da CDN)

Você pode atrasar a inclusão dos SDKs do Firebase até que a página inteira seja carregada. Se você estiver usando a versão 9 scripts de CDN com <script type="module"> , este é o comportamento padrão. Se você estiver usando scripts CDN da versão 8 como um módulo, conclua estas etapas para adiar o carregamento:

  1. Adicionar um defer bandeira para cada script tag para o Firebase SDKs, então adiar a inicialização do Firebase usando um segundo script, por exemplo:

    <script defer src="https://www.gstatic.com/firebasejs/8.10.0/firebase-app.js"></script>

<script defer src="https://www.gstatic.com/firebasejs/8.10.0/firebase-auth.js"></script>
<script defer src="https://www.gstatic.com/firebasejs/8.10.0/firebase-firestore.js"></script>

// ...

<script defer src="./init-firebase.js"></script>

  2. Criar um init-firebase.js arquivo, em seguida, incluir o seguinte no arquivo:

    // TODO: Replace the following with your app's Firebase project configuration
var firebaseConfig = {
  // ...
};

// Initialize Firebase
firebase.initializeApp(firebaseConfig);

Use vários projetos do Firebase em um único aplicativo

Na maioria dos casos, você só precisa inicializar o Firebase em um único aplicativo padrão. Você pode acessar o Firebase desse aplicativo de duas maneiras equivalentes:

Web versão 9

import { initializeApp } from "firebase/app";
import { getStorage } from "firebase/storage";
import { getFirestore } from "firebase/firestore";

// Initialize Firebase with a "default" Firebase project
const defaultProject = initializeApp(firebaseConfig);

console.log(defaultProject.name);  // "[DEFAULT]"

// Option 1: Access Firebase services via the defaultProject variable
let defaultStorage = getStorage(defaultProject);
let defaultFirestore = getFirestore(defaultProject);

// Option 2: Access Firebase services using shorthand notation
defaultStorage = getStorage();
defaultFirestore = getFirestore();
app_default_init_options.js

Web versão 8

// Initialize Firebase with a "default" Firebase project
const defaultProject = firebase.initializeApp(firebaseConfig);

console.log(defaultProject.name);  // "[DEFAULT]"

// Option 1: Access Firebase services via the defaultProject variable
let defaultStorage = defaultProject.storage();
let defaultFirestore = defaultProject.firestore();

// Option 2: Access Firebase services using shorthand notation
defaultStorage = firebase.storage();
defaultFirestore = firebase.firestore();
firebaseapp.js

Às vezes, porém, você precisa acessar vários projetos do Firebase ao mesmo tempo. Por exemplo, você pode querer ler dados do banco de dados de um projeto do Firebase, mas armazenar arquivos em um projeto diferente do Firebase. Ou você pode querer autenticar um projeto enquanto mantém um segundo projeto não autenticado.

O SDK do Firebase JavaScript permite inicializar e usar vários projetos do Firebase em um único aplicativo ao mesmo tempo, com cada projeto usando suas próprias informações de configuração do Firebase.

Web versão 9

import { initializeApp, getApp } from "firebase/app";
import { getStorage } from "firebase/storage";
import { getFirestore } from "firebase/firestore";

// Initialize Firebase with a default Firebase project
initializeApp(firebaseConfig);

// Initialize Firebase with a second Firebase project
const otherProject = initializeApp(otherProjectFirebaseConfig, "other");

console.log(getApp().name);  // "[DEFAULT]"
console.log(otherProject.name);    // "otherProject"

// Use the shorthand notation to access the default project's Firebase services
const defaultStorage = getStorage();
const defaultFirestore = getFirestore();

// Use the otherProject variable to access the second project's Firebase services
const otherStorage = getStorage(otherProject);
const otherFirestore = getFirestore(otherProject);
app_multi_project_init_options.js

Web versão 8

// Initialize Firebase with a default Firebase project
firebase.initializeApp(firebaseConfig);

// Initialize Firebase with a second Firebase project
const otherProject = firebase.initializeApp(otherProjectFirebaseConfig, "other");

console.log(firebase.app().name);  // "[DEFAULT]"
console.log(otherProject.name);    // "otherProject"

// Use the shorthand notation to access the default project's Firebase services
const defaultStorage = firebase.storage();
const defaultFirestore = firebase.firestore();

// Use the otherProject variable to access the second project's Firebase services
const otherStorage = otherProject.storage();
const otherFirestore = otherProject.firestore();
firebaseapp.js

Execute um servidor web local para desenvolvimento

Se você estiver criando um aplicativo da Web, algumas partes do SDK de JavaScript do Firebase exigem que você veicule seu aplicativo da Web a partir de um servidor em vez do sistema de arquivos local. Você pode usar o Firebase CLI para executar um servidor local.

Se você já configurou o Firebase Hosting para seu aplicativo, talvez já tenha concluído várias das etapas abaixo.

Para veicular seu aplicativo da Web, você usará a Firebase CLI, uma ferramenta de linha de comando.

  1. Visite a documentação Firebase CLI para aprender a instalar o CLI ou atualização para sua versão mais recente .

  2. Inicialize seu projeto do Firebase. Execute o seguinte comando na raiz do diretório do seu aplicativo local:

    firebase init

  3. Inicie o servidor local para o desenvolvimento. Execute o seguinte comando na raiz do diretório do seu aplicativo local:

    firebase serve

Recursos de código aberto para SDKs JavaScript do Firebase

O Firebase oferece suporte ao desenvolvimento de código aberto e incentivamos contribuições e comentários da comunidade.

SDKs JavaScript do Firebase

A maioria dos Firebase JavaScript SDKs são desenvolvidos como bibliotecas de código aberto no nosso público repositório Firebase GitHub .

Amostras de início rápido

O Firebase mantém uma coleção de exemplos de início rápido para a maioria das APIs do Firebase na Web. Encontrar estes quickstarts no nosso público repositório quickstart Firebase GitHub . Você pode usar esses guias de início rápido como código de exemplo para usar os SDKs do Firebase.