Funktionen verwalten (1. Generation)

Sie können Funktionen mit Firebase-Befehlen oder durch Festlegen von Laufzeitoptionen im Quellcode Ihrer Funktionen bereitstellen, löschen und ändern.

Funktionen bereitstellen

Führen Sie den folgenden Firebase-CLI-Befehl aus, um Funktionen bereitzustellen:

firebase deploy --only functions

Standardmäßig stellt die Firebase-Befehlszeile alle Funktionen in Ihrer Quelle gleichzeitig bereit. Wenn Ihr Projekt mehr als 5 Funktionen enthält, empfehlen wir, das Flag --only mit bestimmten Funktionsnamen zu verwenden, um nur die Funktionen bereitzustellen, die Sie bearbeitet haben. Wenn Sie bestimmte Funktionen auf diese Weise bereitstellen, wird der Bereitstellungsprozess beschleunigt und Sie können Bereitstellungskontingente vermeiden. Beispiel:

firebase deploy --only functions:addMessage,functions:makeUppercase

Wenn Sie eine große Anzahl von Funktionen bereitstellen, kann es sein, dass Sie das Standardkontingent überschreiten und die HTTP-Fehlermeldung 429 oder 500 erhalten. Stellen Sie Funktionen in Gruppen von maximal 10 Funktionen bereit, um dieses Problem zu beheben.

Eine vollständige Liste der verfügbaren Befehle finden Sie in der Firebase-CLI-Referenz.

Standardmäßig sucht die Firebase-Befehlszeile im Ordner functions/ nach dem Quellcode. Alternativ können Sie Funktionen in Codebasen oder mehreren Dateisätzen organisieren.

Funktionen löschen

Sie können zuvor bereitgestellte Funktionen auf folgende Weise löschen:

  • explizit in der Firebase-Befehlszeile mit functions:delete
  • explizit in der Google Cloud Console.
  • implizit, indem Sie die Funktion vor der Bereitstellung aus der Quelle entfernen.

Bei allen Löschvorgängen werden Sie aufgefordert, den Vorgang zu bestätigen, bevor die Funktion aus der Produktion entfernt wird.

Das explizite Löschen von Funktionen in der Firebase-Befehlszeile unterstützt mehrere Argumente sowie Funktionsgruppen und ermöglicht es Ihnen, eine Funktion anzugeben, die in einer bestimmten Region ausgeführt wird. Außerdem können Sie die Bestätigungsaufforderung überschreiben.

  • Löscht alle Funktionen, die dem angegebenen Namen in allen Regionen entsprechen: 

    firebase functions:delete FUNCTION-1_NAME

  • Löscht eine bestimmte Funktion, die in einer nicht standardmäßigen Region ausgeführt wird: 

    firebase functions:delete FUNCTION-1_NAME --region REGION_NAME

  • Löscht mehrere Funktionen: 

    firebase functions:delete FUNCTION-1_NAME FUNCTION-2_NAME

  • Löscht eine angegebene Funktionsgruppe: 

    firebase functions:delete GROUP_NAME

  • Überspringt die Bestätigungsaufforderung: 

    firebase functions:delete FUNCTION-1_NAME --force

Beim impliziten Löschen von Funktionen parst firebase deploy Ihre Quelle und entfernt alle Funktionen aus der Produktion, die aus der Datei entfernt wurden.

Name, Region oder Trigger einer Funktion ändern

Wenn Sie die Regionen oder Trigger für Funktionen umbenennen oder ändern, die Produktions-Traffic verarbeiten, folgen Sie den Schritten in diesem Abschnitt, um zu vermeiden, dass während der Änderung Ereignisse verloren gehen. Bevor Sie diese Schritte ausführen, sollten Sie prüfen, ob Ihre Funktion idempotent ist, da während der Änderung sowohl die neue als auch die alte Version Ihrer Funktion gleichzeitig ausgeführt werden.

Funktion umbenennen

Wenn Sie eine Funktion umbenennen möchten, erstellen Sie eine neue umbenannte Version der Funktion in Ihrer Quelle und führen Sie dann zwei separate Bereitstellungsbefehle aus. Mit dem ersten Befehl wird die neu benannte Funktion bereitgestellt und mit dem zweiten Befehl wird die zuvor bereitgestellte Version entfernt. Wenn Sie beispielsweise eine Node.js-Funktion namens webhook haben, die Sie in webhookNew ändern möchten, überarbeiten Sie den Code so:

// before
const functions = require('firebase-functions/v1');

exports.webhook = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

// after
const functions = require('firebase-functions/v1');

exports.webhookNew = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

Führen Sie dann die folgenden Befehle aus, um die neue Funktion bereitzustellen:

# Deploy new function called webhookNew
firebase deploy --only functions:webhookNew

# Wait until deployment is done; now both webhookNew and webhook are running

# Delete webhook
firebase functions:delete webhook

Region oder Regionen einer Funktion ändern

Wenn Sie die angegebenen Regionen für eine Funktion ändern, die Produktions-Traffic verarbeitet, können Sie Ereignisverluste verhindern, indem Sie die folgenden Schritte in der angegebenen Reihenfolge ausführen:

  1. Benennen Sie die Funktion um und ändern Sie die Region oder Regionen nach Bedarf.
  2. Stellen Sie die umbenannte Funktion bereit. Dadurch wird derselbe Code vorübergehend in beiden Regionen ausgeführt.
  3. Löschen Sie die vorherige Funktion.

Wenn Sie beispielsweise eine Funktion namens webhook haben, die derzeit in us-central1 bereitgestellt ist, und Sie sie zu asia-northeast1 migrieren möchten, müssen Sie zuerst Ihren Quellcode ändern, um die Funktion umzubenennen und die Region zu überarbeiten.

// before
const functions = require('firebase-functions/v1');

exports.webhook = functions
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

// after
const functions = require('firebase-functions/v1');

exports.webhookAsia = functions
    .region('asia-northeast1')
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

Führen Sie dann die Bereitstellung aus:

firebase deploy --only functions:webhookAsia

Jetzt werden zwei identische Funktionen ausgeführt: webhook wird in us-central1 und webhookAsia in asia-northeast1 ausgeführt.

Löschen Sie dann webhook:

firebase functions:delete webhook

Jetzt gibt es nur noch eine Funktion – webhookAsia, die in asia-northeast1 ausgeführt wird.

Triggertyp einer Funktion ändern

Wenn Sie Ihre Cloud Functions for Firebase-Bereitstellung im Laufe der Zeit weiterentwickeln, müssen Sie möglicherweise aus verschiedenen Gründen den Triggertyp einer Funktion ändern. Beispielsweise möchten Sie möglicherweise von einem Typ von Firebase Realtime Database- oder Cloud Firestore-Ereignis zu einem anderen Typ wechseln.

Es ist nicht möglich, den Ereignistyp einer Funktion zu ändern, indem Sie nur den Quellcode ändern und firebase deploy ausführen. So ändern Sie den Triggertyp einer Funktion, um Fehler zu vermeiden:

  1. Ändern Sie den Quellcode so, dass er eine neue Funktion mit dem gewünschten Triggertyp enthält.
  2. Stellen Sie die Funktion bereit. Dadurch werden vorübergehend sowohl die alte als auch die neue Funktion ausgeführt.
  3. Löschen Sie die alte Funktion explizit mit der Firebase-Befehlszeile aus der Produktion.

Wenn Sie beispielsweise eine Node.js-Funktion mit dem Namen objectChanged haben, die den Legacy-Ereignistyp onChange hat, und Sie sie in onFinalize ändern möchten, benennen Sie zuerst die Funktion um und bearbeiten Sie sie so, dass sie den Ereignistyp onFinalize hat.

// before
const functions = require('firebase-functions/v1');

exports.objectChanged = functions.storage.object().onChange((object) => {
    return console.log('File name is: ', object.name);
});

// after
const functions = require('firebase-functions/v1');

exports.objectFinalized = functions.storage.object().onFinalize((object) => {
    return console.log('File name is: ', object.name);
});

Führen Sie dann die folgenden Befehle aus, um zuerst die neue Funktion zu erstellen, bevor Sie die alte Funktion löschen:

# Create new function objectFinalized
firebase deploy --only functions:objectFinalized

# Wait until deployment is done; now both objectChanged and objectFinalized are running

# Delete objectChanged
firebase functions:delete objectChanged

Laufzeitoptionen festlegen

Mit Cloud Functions for Firebase können Sie Laufzeitoptionen wie die Node.js-Laufzeitversion und das Zeitlimit pro Funktion, die Arbeitsspeicherzuweisung und die minimale/maximale Anzahl von Funktionsinstanzen auswählen.

Als Best Practice sollten diese Optionen (mit Ausnahme der Node.js-Version) für ein Konfigurationsobjekt im Funktionscode festgelegt werden. Dieses RuntimeOptions-Objekt ist die „Source of Truth“ für die Laufzeitoptionen Ihrer Funktion und überschreibt Optionen, die mit einer anderen Methode festgelegt wurden (z. B. mit der Google Cloud-Konsole oder gcloud CLI).

Wenn Sie in Ihrem Entwicklungs-Workflow Laufzeitoptionen manuell über die Google Cloud-Konsole oder gcloud CLI festlegen und nicht möchten, dass diese Werte bei jeder Bereitstellung überschrieben werden, setzen Sie die Option preserveExternalChanges auf true. Wenn diese Option auf true gesetzt ist, führt Firebase die in Ihrem Code festgelegten Laufzeitoptionen mit den Einstellungen der aktuell bereitgestellten Version Ihrer Funktion mit der folgenden Priorität zusammen:

  1. Option ist im Funktionscode festgelegt: Externe Änderungen überschreiben.
  2. Die Option ist im Funktionscode auf RESET_VALUE festgelegt: Externe Änderungen werden mit dem Standardwert überschrieben.
  3. Die Option ist nicht im Funktionscode, aber in der aktuell bereitgestellten Funktion festgelegt: Die in der bereitgestellten Funktion angegebene Option wird verwendet.

Die Verwendung der Option preserveExternalChanges: true wird für die meisten Szenarien nicht empfohlen, da Ihr Code dann nicht mehr die vollständige „Source of Truth“ für Laufzeitoptionen für Ihre Funktionen ist. Wenn Sie sie verwenden, rufen Sie die Google Cloud-Konsole auf oder verwenden Sie die gcloud CLI, um die vollständige Konfiguration einer Funktion aufzurufen.

Node.js-Version festlegen

Das Firebase SDK für Cloud Functions ermöglicht die Auswahl einer Node.js-Laufzeit. Sie können alle Funktionen in einem Projekt ausschließlich in der Laufzeitumgebung ausführen, die einer der folgenden unterstützten Node.js-Versionen entspricht:

  • Node.js 22
  • Node.js 20
  • Node.js 18 (eingestellt)

Wichtige Informationen zum laufenden Support für diese Node.js-Versionen finden Sie im Supportzeitplan.

So legen Sie die Node.js-Version fest:

Sie können die Version im Feld engines in der Datei package.json festlegen, die während der Initialisierung in Ihrem functions/-Verzeichnis erstellt wurde. Wenn Sie beispielsweise nur Version 20 verwenden möchten, bearbeiten Sie diese Zeile in package.json:

  "engines": {"node": "22"}

Wenn Sie den Yarn-Paketmanager verwenden oder andere spezifische Anforderungen für das Feld engines haben, können Sie die Laufzeit für das Firebase SDK für Cloud Functions stattdessen in firebase.json festlegen:

  {
    "functions": {
      "runtime": "nodejs22"
    }
  }

Die Befehlszeile verwendet den in firebase.json festgelegten Wert vor allen Werten oder Bereichen, die Sie separat in package.json festlegen.

Node.js-Laufzeit aktualisieren

So aktualisieren Sie Ihre Node.js-Laufzeit:

  1. Achten Sie darauf, dass für Ihr Projekt das Blaze-Preismodell gilt.
  2. Sie benötigen die Firebase-Befehlszeile ab Version 11.18.0.
  3. Ändern Sie den Wert engines in der Datei package.json, die während der Initialisierung in Ihrem Verzeichnis functions/ erstellt wurde. Wenn Sie beispielsweise ein Upgrade von Version 16 auf Version 18 durchführen, sollte der Eintrag so aussehen: "engines": {"node": "18"}
  4. Optional können Sie Ihre Änderungen mit dem Firebase Local Emulator Suite testen.
  5. Stellen Sie alle Funktionen noch einmal bereit.

Node.js-Modulsystem auswählen

Das Standardmodulsystem in Node.js ist CommonJS (CJS). Aktuelle Node.js-Versionen unterstützen jedoch auch ECMAScript-Module (ESM). Cloud Functions unterstützt beides.

Standardmäßig verwenden Ihre Funktionen CommonJS. Das bedeutet, dass Importe und Exporte so aussehen:

const functions = require("firebase-functions/v1");

exports.helloWorld = functions.https.onRequest(async (req, res) => res.send("Hello from Firebase!"));

Wenn Sie stattdessen ESM verwenden möchten, legen Sie das Feld "type": "module" in der Datei package.json fest:

  {
   ...
   "type": "module",
   ...
  }

Verwenden Sie nach dem Festlegen die ESM-Syntax import und export:

import functions from "firebase-functions/v1";

export const helloWorld = functions.https.onRequest(async (req, res) => res.send("Hello from Firebase!"));

Beide Modulsysteme werden vollständig unterstützt. Sie können die Option auswählen, die am besten zu Ihrem Projekt passt. Weitere Informationen finden Sie in der Node.js-Dokumentation zu Modulen.

Skalierungsverhalten steuern

Standardmäßig skaliert Cloud Functions for Firebase die Anzahl der ausgeführten Instanzen basierend auf der Anzahl der eingehenden Anfragen. Bei geringem Traffic kann die Anzahl der Instanzen auf null herunterskaliert werden. Wenn Ihre Anwendung jedoch eine geringere Latenz erfordert und Sie die Anzahl von Kaltstarts begrenzen möchten, können Sie dieses Standardverhalten ändern. Dazu geben Sie eine Mindestanzahl von Containerinstanzen an, die einsatzbereit sind und Anfragen bedienen können.

Ebenso können Sie eine maximale Anzahl festlegen, um die Skalierung von Instanzen als Reaktion auf eingehende Anfragen zu begrenzen. Verwenden Sie diese Einstellung, um Ihre Kosten zu kontrollieren oder die Anzahl der Verbindungen zu einem unterstützenden Dienst zu begrenzen, z. B. zu einer Datenbank.

Anzahl der Kaltstarts reduzieren

Wenn Sie die Mindestanzahl von Instanzen für eine Funktion im Quellcode festlegen möchten, verwenden Sie die Methode runWith. Diese Methode akzeptiert ein JSON-Objekt, das der Schnittstelle RuntimeOptions entspricht, die den Wert für minInstances definiert. Mit dieser Funktion werden beispielsweise mindestens 5 Instanzen festgelegt, die einsatzbereit bleiben:

exports.getAutocompleteResponse = functions
    .runWith({
      // Keep 5 instances warm for this latency-critical function
      minInstances: 5,
    })
    .https.onCall((data, context) => {
      // Autocomplete a user's search term
    });

Hier sind einige Punkte, die Sie beim Festlegen eines Werts für minInstances beachten sollten:

  • Wenn Cloud Functions for Firebase Ihre Anwendung über die Einstellung minInstances hinaus skaliert, wird für jede Instanz über diesem Schwellenwert ein Kaltstart ausgeführt.
  • Kaltstarts haben die schwerwiegendsten Auswirkungen auf Anwendungen mit unregelmäßigem Traffic. Wenn Ihre Anwendung unregelmäßigen Traffic hat und Sie einen minInstances-Wert festlegen, der hoch genug ist, dass Kaltstarts bei jedem Traffic-Anstieg reduziert werden, wird die Latenz erheblich reduziert. Bei Anwendungen mit konstantem Traffic ist es unwahrscheinlich, dass Kaltstarts die Leistung stark beeinträchtigen.

  • Das Festlegen einer Mindestanzahl von Instanzen kann für Produktionsumgebungen sinnvoll sein, sollte aber in Testumgebungen in der Regel vermieden werden. Wenn Sie in Ihrem Testprojekt auf null herunterskalieren, aber dennoch Kaltstarts in Ihrem Produktionsprojekt reduzieren möchten, können Sie minInstances basierend auf der Umgebungsvariable FIREBASE_CONFIG festlegen:

    // Get Firebase project id from `FIREBASE_CONFIG` environment variable
const envProjectId = JSON.parse(process.env.FIREBASE_CONFIG).projectId;

exports.renderProfilePage = functions
    .runWith({
      // Keep 5 instances warm for this latency-critical function
      // in production only. Default to 0 for test projects.
      minInstances: envProjectId === "my-production-project" ? 5 : 0,
    })
    .https.onRequest((req, res) => {
      // render some html
    });

Maximale Anzahl von Instanzen für eine Funktion begrenzen

Verwenden Sie die Methode runWith, um die maximale Anzahl von Instanzen im Quellcode der Funktion festzulegen. Diese Methode akzeptiert ein JSON-Objekt, das der Schnittstelle RuntimeOptions entspricht, die Werte für maxInstances definiert. Diese Funktion legt beispielsweise ein Limit von 100 Instanzen fest, um eine hypothetische Legacy-Datenbank nicht zu überlasten:

exports.mirrorOrdersToLegacyDatabase = functions
    .runWith({
      // Legacy database only supports 100 simultaneous connections
      maxInstances: 100,
    })
    .firestore.document("orders/{orderId}")
    .onWrite((change, context) => {
      // Connect to legacy database
    });

Wenn eine HTTP-Funktion auf das Limit von maxInstances hochskaliert wird, werden neue Anfragen 30 Sekunden lang in die Warteschlange gestellt und dann mit dem Antwortcode 429 Too Many Requests abgelehnt, wenn bis dahin keine Instanz verfügbar ist.

Weitere Informationen zu Best Practices für die Verwendung der Einstellungen für die maximale Anzahl von Instanzen finden Sie in diesen Best Practices für die Verwendung von maxInstances.

Dienstkonto festlegen

Das Standarddienstkonto für Funktionen der 1. Generation, PROJECT_ID@appspot.gserviceaccount.com (mit dem Namen App Engine-Standarddienstkonto), verfügt über eine Vielzahl von Berechtigungen, mit denen Sie mit anderen Firebase- und Google Cloud-Diensten interagieren können.

Möglicherweise möchten Sie das Standarddienstkonto überschreiben und eine Funktion auf die genau benötigten Ressourcen beschränken. Dazu können Sie ein benutzerdefiniertes Dienstkonto erstellen und es mit der Methode .runWith() der entsprechenden Funktion zuweisen. Diese Methode verwendet ein Objekt mit Konfigurationsoptionen, einschließlich der Property serviceAccount.

const functions = require("firebase-functions/v1");

exports.helloWorld = functions
    .runWith({
        // This function doesn't access other Firebase project resources, so it uses a limited service account.
        serviceAccount:
            "my-limited-access-sa@", // or prefer the full form: "my-limited-access-sa@my-project.iam.gserviceaccount.com"
    })
    .https.onRequest((request, response) => {
        response.send("Hello from Firebase!");
    });

Zeitlimit und Arbeitsspeicherzuweisung festlegen

In einigen Fällen gelten für Ihre Funktionen möglicherweise besondere Anforderungen für einen langen Zeitlimitwert oder eine große Speicherzuweisung. Sie können diese Werte entweder in der Google Cloud Console oder im Quellcode der Funktion (nur Firebase) festlegen.

Wenn Sie die Arbeitsspeicherzuweisung und das Zeitlimit im Quellcode von Funktionen festlegen möchten, verwenden Sie den Parameter runWith, der im Firebase SDK für Cloud Functions 2.0.0 eingeführt wurde. Diese Laufzeitoption akzeptiert ein JSON-Objekt, das der Schnittstelle RuntimeOptions entspricht, die Werte für timeoutSeconds und memory definiert. Diese Speicherfunktion verwendet beispielsweise 1 GB Arbeitsspeicher und läuft nach 300 Sekunden ab:

exports.convertLargeFile = functions
    .runWith({
      // Ensure the function has enough memory and time
      // to process large files
      timeoutSeconds: 300,
      memory: "1GB",
    })
    .storage.object()
    .onFinalize((object) => {
      // Do some complicated things that take a lot of memory and time
    });

Der Höchstwert für timeoutSeconds beträgt 540 oder 9 Minuten. Die Größe des Arbeitsspeichers, der einer Funktion zugewiesen wird, entspricht der CPU, die der Funktion zugewiesen ist, wie in dieser Liste der gültigen Werte für memory beschrieben:

  • 128MB – 200 MHz
  • 256MB – 400 MHz
  • 512MB — 800 MHz
  • 1GB – 1,4 GHz
  • 2GB – 2,4 GHz
  • 4GB – 4,8 GHz
  • 8GB – 4,8 GHz

So legen Sie die Arbeitsspeicherzuweisung und das Zeitlimit in der Google Cloud Console fest:

  1. Wählen Sie in der Google Cloud-Konsole im Menü auf der linken Seite Cloud Functions aus.
  2. Wählen Sie eine Funktion aus, indem Sie in der Funktionsliste auf ihren Namen klicken.
  3. Klicken Sie im Menü oben auf das Symbol Bearbeiten.
  4. Wählen Sie im Drop-down-Menü Zugewiesener Speicher eine Arbeitsspeicherzuweisung aus.
  5. Klicken Sie auf Mehr, um die erweiterten Optionen aufzurufen, und geben Sie im Textfeld Zeitlimit eine Anzahl von Sekunden ein.
  6. Klicken Sie auf Speichern, um die Funktion zu aktualisieren.