Gebündelte Firestore-Inhalte aus einem CDN bereitstellen

Viele Anwendungen liefern beim ersten Laden der Seite allen Nutzern dieselben Inhalte. Eine Nachrichtenseite zeigt beispielsweise die neuesten Meldungen oder eine E‑Commerce-Website die meistverkauften Artikel.

Wenn diese Inhalte aus Cloud Firestore bereitgestellt werden, führt jeder Nutzer beim Laden der Anwendung eine neue Abfrage für dieselben Ergebnisse aus. Da diese Ergebnisse nicht zwischen Nutzern im Cache gespeichert werden, ist die Anwendung langsamer und teurer als nötig.

Lösung: Bundles

Cloud Firestore Bundles ermöglichen es Ihnen, mithilfe des Firebase Admin SDK Daten-Bundles aus häufigen Abfrage ergebnissen im Back-End zusammenzustellen und diese vorab berechneten Blobs aus einem CDN bereitzustellen. So wird die erste Ladezeit für Ihre Nutzer deutlich verkürzt und die Kosten für Cloud Firestore Abfragen sinken.

In dieser Anleitung verwenden wir Cloud Functions, um Bundles zu generieren, und Firebase Hosting, um Bundle-Inhalte dynamisch im Cache zu speichern und bereitzustellen. Weitere Informationen zu Bundles finden Sie in den Anleitungen.

Erstellen Sie zuerst eine einfache öffentliche HTTP-Funktion, um die 50 neuesten „Stories“ abzufragen und das Ergebnis als Bundle bereitzustellen.

exports.createBundle = functions.https.onRequest(async (request, response) => {
  // Query the 50 latest stories
  const latestStories = await db.collection('stories')
    .orderBy('timestamp', 'desc')
    .limit(50)
    .get();

  // Build the bundle from the query results
  const bundleBuffer = db.bundle('latest-stories')
    .add('latest-stories-query', latestStories)
    .build();

  // Cache the response for up to 5 minutes;
  // see https://firebase.google.com/docs/hosting/manage-cache
  response.set('Cache-Control', 'public, max-age=300, s-maxage=600');

  response.end(bundleBuffer);
});
      

package com.example;

import com.google.auth.oauth2.GoogleCredentials;
import com.google.cloud.firestore.Firestore;
import com.google.cloud.firestore.FirestoreBundle;
import com.google.cloud.firestore.Query.Direction;
import com.google.cloud.firestore.QuerySnapshot;
import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import com.google.firebase.FirebaseApp;
import com.google.firebase.FirebaseOptions;
import com.google.firebase.cloud.FirestoreClient;
import java.io.BufferedWriter;
import java.io.IOException;

public class ExampleFunction implements HttpFunction {

  public static FirebaseApp initializeFirebase() throws IOException {
    if (FirebaseApp.getApps().isEmpty()) {
      FirebaseOptions options = FirebaseOptions.builder()
          .setCredentials(GoogleCredentials.getApplicationDefault())
          .setProjectId("YOUR-PROJECT-ID")
          .build();

      FirebaseApp.initializeApp(options);
    }

    return FirebaseApp.getInstance();
  }

  @Override
  public void service(HttpRequest request, HttpResponse response) throws Exception {
    // Get a Firestore instance
    FirebaseApp app = initializeFirebase();
    Firestore db = FirestoreClient.getFirestore(app);

    // Query the 50 latest stories
    QuerySnapshot latestStories = db.collection("stories")
        .orderBy("timestamp", Direction.DESCENDING)
        .limit(50)
        .get()
        .get();

    // Build the bundle from the query results
    FirestoreBundle bundle = db.bundleBuilder("latest-stores")
        .add("latest-stories-query", latestStories)
        .build();

    // Cache the response for up to 5 minutes
    // see https://firebase.google.com/docs/hosting/manage-cache
    response.appendHeader("Cache-Control", "public, max-age=300, s-maxage=600");

    // Write the bundle to the HTTP response
    BufferedWriter writer = response.getWriter();
    writer.write(new String(bundle.toByteBuffer().array()));
  }
}
      

Konfigurieren Sie als Nächstes Firebase Hosting, um diese Cloud Function bereitzustellen und im Cache zu speichern. Dazu müssen Sie firebase.json ändern. Mit dieser Konfiguration stellt das Firebase Hosting CDN die Bundle-Inhalte gemäß den Cache-Einstellungen bereit, die von der Cloud Function festgelegt wurden. Wenn der Cache abläuft, werden die Inhalte aktualisiert, indem die Funktion noch einmal ausgelöst wird.

firebase.json
{
  "hosting": {
    // ...
    "rewrites": [{
      "source": "/createBundle",
      "function": "createBundle"
    }]
  },
  // ...
}

Rufen Sie schließlich in Ihrer Webanwendung die Bundle-Inhalte aus dem CDN ab und laden Sie sie in das Firestore SDK.

// If you are using module bundlers.
import firebase from "firebase/app";
import "firebase/firestore";
import "firebase/firestore/bundle" // This line enables bundle loading as a side effect.

async function fetchFromBundle() {
  // Fetch the bundle from Firebase Hosting, if the CDN cache is hit the 'X-Cache'
  // response header will be set to 'HIT'
  const resp = await fetch('/createBundle');

  // Load the bundle contents into the Firestore SDK
  await db.loadBundle(resp.body);

  // Query the results from the cache
  // Note: omitting "source: cache" will query the Firestore backend.
  
  const query = await db.namedQuery('latest-stories-query');
  const storiesSnap = await query.get({ source: 'cache' });

  // Use the results
  // ...
}

Geschätzte Einsparung

Nehmen wir an,eine Nachrichtenseite hat 100.000 Nutzer pro Tag und jeder Nutzer lädt beim ersten Laden der Seite dieselben 50 Top-Meldungen. Ohne Caching würden dadurch 50 × 100.000 = 5.000.000 Dokumentlesevorgänge pro Tag aus Cloud Firestore entstehen.

Nehmen wir nun an, die Website verwendet die oben beschriebene Methode und speichert diese 50 Ergebnisse bis zu 5 Minuten lang im Cache. Anstatt die Abfrageergebnisse für jeden Nutzer zu laden, werden die Ergebnisse also nur 12 Mal pro Stunde geladen. Unabhängig davon, wie viele Nutzer die Website besuchen, bleibt die Anzahl der Abfragen an Cloud Firestore gleich. Anstelle von 5.000.000 Dokumentlesevorgängen würden auf dieser Seite 12 × 24 × 50 = 14.400 Dokumentlesevorgänge pro Tag anfallen. Die geringen zusätzlichen Kosten für Firebase Hosting und Cloud Functions werden durch die Cloud Firestore Kosteneinsparungen mehr als ausgeglichen.

Zwar profitiert der Entwickler von den Kosteneinsparungen, aber der größte Vorteil ergibt sich für den Nutzer. Wenn diese 50 Dokumente aus dem Firebase Hosting CDN und nicht aus Cloud Firestore direkt geladen werden, kann die Ladezeit der Seite um 100 bis 200 ms oder mehr verkürzt werden. Studien haben wiederholt gezeigt, dass schnelle Seiten zu zufriedeneren Nutzern führen.