Bereitstellen von gebündelten Firestore-Inhalten von einem CDN

Viele Anwendungen stellen allen Benutzern beim ersten Laden der Seite den gleichen Inhalt bereit. Beispielsweise kann eine Nachrichten-Site die neuesten Artikel anzeigen oder eine E-Commerce-Site die meistverkauften Artikel anzeigen.

Wenn dieser Inhalt von Cloud Firestore bereitgestellt wird, gibt jeder Nutzer beim Laden der Anwendung eine neue Abfrage für dieselben Ergebnisse aus. Da diese Ergebnisse nicht zwischen den Benutzern zwischengespeichert werden, ist die Anwendung langsamer und teurer als nötig.

Lösung: Bündel

Mit Cloud Firestore-Bundles können Sie mit dem Firebase Admin SDK Datenpakete aus allgemeinen Abfrageergebnissen im Back-End zusammenstellen und diese vorberechneten Blobs in einem CDN zwischenspeichern. Dies ermöglicht Ihren Benutzern eine viel schnellere Erstladeerfahrung und reduziert Ihre Cloud Firestore-Abfragekosten.

In dieser Anleitung verwenden wir Cloud Functions zum Generieren von Bundles und Firebase Hosting zum dynamischen Cachen und Bereitstellen von Bundle-Inhalten. Weitere Informationen über Bündel ist in den zur Verfügung stehenden Führungen .

Erstellen Sie zunächst eine einfache öffentliche HTTP-Funktion, um die 50 neuesten "Geschichten" abzufragen und das Ergebnis als Bundle bereitzustellen.

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

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

Weiter configure Firebase Hosting zu dienen und diese Cloud - Funktion cachen durch Modifizieren firebase.json . Bei dieser Konfiguration stellt das Firebase Hosting CDN den Bundle-Inhalt gemäß den Cache-Einstellungen bereit, die von der Cloud Functions-Funktion festgelegt wurden. Wenn der Cache abläuft, aktualisiert er den Inhalt, indem er die Funktion erneut auslöst.

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

Rufen Sie schließlich in Ihrer Webanwendung den gebündelten Inhalt vom CDN ab und laden Sie ihn 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 Einsparungen

Stellen Sie sich eine Nachrichten-Website vor, die 100.000 Nutzer pro Tag hat und jeder Nutzer beim ersten Laden die gleichen 50 Top-Storys lädt. Ohne Caching würde dies 50 x 100.000 = 5.000.000 Dokumentlesevorgänge pro Tag aus Cloud Firestore ergeben.

Nehmen wir nun an, die Site übernimmt die obige Technik und speichert diese 50 Ergebnisse für bis zu 5 Minuten im Cache. Anstatt also die Abfrageergebnisse für jeden Benutzer zu laden, werden die Ergebnisse genau 12-mal pro Stunde geladen. Unabhängig davon, wie viele Nutzer auf der Site eintreffen, bleibt die Anzahl der Anfragen an Cloud Firestore gleich. Anstelle von 5.000.000 Dokumentlesevorgängen würde diese Seite 12 x 24 x 50 = 14.400 Dokumentlesevorgänge pro Tag verwenden. Die geringen Zusatzkosten für Firebase Hosting und Cloud Functions werden durch die Kosteneinsparungen von Cloud Firestore leicht ausgeglichen.

Während der Entwickler von den Kosteneinsparungen profitiert, ist der größte Nutznießer der Benutzer. Das Laden dieser 50 Dokumente aus dem Firebase Hosting CDN statt direkt aus Cloud Firestore kann leicht 100-200 ms oder mehr der Ladezeit der Seite verkürzen. Studien haben immer wieder gezeigt, dass schnelle Seiten glücklichere Nutzer bedeuten.