Zum Go Admin SDK Version 4 migrieren

Ab Version 4.0.0 wurde die Firebase Admin SDK für Go auf Go-Module umgestellt. Außerdem gibt es funktionsgefährdende Änderungen bei der Fehlerbehandlung und der Semantik.

Änderungen an der Installation

Gemäß den Best Practices für Module wurde die Hauptversion des SDK an den Paketnamen angehängt. Diese Änderung führt zu den folgenden Aktualisierungen der Paketnamen:

  • firebase.google.com/go → firebase.google.com/go/v4
  • firebase.google.com/go/auth → firebase.google.com/go/v4/auth
  • firebase.google.com/go/db → firebase.google.com/go/v4/db
  • firebase.google.com/go/iid → firebase.google.com/go/v4/iid
  • firebase.google.com/go/messaging → firebase.google.com/go/v4/messaging

Entwickler, die bereits Module verwenden

Verwenden Sie den versionierten Paketnamen, um die aktuelle Version des SDK zu installieren.

# Install the latest version:
go install firebase.google.com/go/v4@latest

# Or install a specific version:
go install firebase.google.com/go/v4@v4.23.0

Beim Importieren des SDK muss im Quellcode derselbe versionierte Paketname verwendet werden.

package helloworld

import (
        "firebase.google.com/go/v4"
        "firebase.google.com/go/v4/auth"
        "firebase.google.com/go/v4/messaging"
)

Wenn Sie eine frühere Version installieren möchten, verwenden Sie den alten (nicht versionierten) Paketnamen mit einem expliziten Versionskennzeichner.

# Notice the @v3 suffix.
# This instructs Go tools to fetch the latest v3.x release of the SDK.
go get firebase.google.com/go@v3

Entwickler, die derzeit keine Module verwenden

Entwickler, die sich noch nicht für Module entschieden haben, können das SDK weiterhin mit dem nicht versionierten Paketnamen installieren.

go get firebase.google.com/go

Beachten Sie jedoch, dass dadurch die aktuelle Version des SDK (v4 oder höher) abgerufen wird, die andere funktionsgefährdende API-Änderungen enthält.

Allgemeine Änderungen bei der Fehlerbehandlung

Mit dem v4 SDK wird ein neues errorutils-Paket eingeführt, das Funktionen zur Behandlung von Fehlern auf Plattformebene bietet. Wenn ein Fehler durch einen Backend-Dienstfehler verursacht wurde, können Sie die ursprüngliche Fehlerantwort durch Aufrufen der neuen Funktion errorutils.HTTPResponse abrufen. Sie können die Funktionen in diesem Paket mit Fehlern verwenden, die von einer beliebigen API im SDK zurückgegeben werden.

Authentication API-Änderungen

  • Es wurden neue Fehlerbehandlungsfunktionen hinzugefügt, die in Verbindung mit den APIs VerifyIDToken und VerifySessionCookie verwendet werden können:
    • IsIDTokenInvalid()
    • IsIDTokenExpired()
    • IsSessionCookieInvalid()
    • IsSessionCookieExpired()
    • IsCertificateFetchFailed()
  • Eingestellt:
    • IsProjectNotFound()
    • IsUnknown()
    • IsInsufficientPermission()
    • IsInvalidEmail()

FCM API-Änderungen

  • Der Typ messaging.WebpushFCMOptions wurde in messaging.WebpushFcmOptions umbenannt.
  • Hinzugefügt:
    • IsThirdPartyAuthError()
    • IsQuotaExceeded()
    • IsSenderIDMismatch()
    • IsUnregistered()
    • IsUnavailable()
  • Eingestellt:
    • IsInvalidAPNSCredentials()
    • IsMessageRateExceeded()
    • IsMismatchedCredential()
    • IsRegistrationTokenNotRegistered()
    • IsServerUnavailable()
    • IsTooManyTopics()
    • IsUnknown()

Änderungen an der IID API

Alle derzeit im Paket iid verfügbaren Funktionen zur Fehlerbehandlung sind jetzt veraltet. Verwenden Sie stattdessen die entsprechenden Funktionen zur Fehlerbehandlung im Paket errorutils.