從 4.0.0 版開始,Go 的 Firebase Admin SDK 已選擇加入 Go 模組。此外,錯誤處理和語意也有破壞性變更。
安裝異動
為符合模組最佳做法,SDK 的主要版本已附加至套件名稱。這項異動會導致下列套件名稱更新:
- 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
開發人員已在使用模組
使用版本化套件名稱安裝最新版本 SDK。
# 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
匯入 SDK 時,原始碼中必須使用相同的版本化套件名稱。
package helloworld
import (
"firebase.google.com/go/v4"
"firebase.google.com/go/v4/auth"
"firebase.google.com/go/v4/messaging"
)
如要安裝舊版,請使用舊版 (未版本化) 套件名稱,並加上明確的版本限定詞。
# 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
目前未使用模組的開發人員
尚未選擇使用模組的開發人員,可以繼續使用未版本化的套件名稱安裝 SDK。
go get firebase.google.com/go
不過請注意,這會擷取最新版本 SDK (第 4 版以上),其中包含其他破壞性 API 變更。
一般錯誤處理異動
第 4 版 SDK 導入了新的 errorutils 套件,提供處理平台層級錯誤狀況的函式。如果錯誤是由後端服務錯誤造成,您可以呼叫新函式 errorutils.HTTPResponse,存取原始錯誤回應。您可以使用這個套件中的函式,處理 SDK 中任何 API 傳回的錯誤。
Authentication API 異動
- 新增錯誤處理函式,可與
VerifyIDToken和VerifySessionCookieAPI 搭配使用:IsIDTokenInvalid()IsIDTokenExpired()IsSessionCookieInvalid()IsSessionCookieExpired()IsCertificateFetchFailed()
- 已淘汰:
IsProjectNotFound()IsUnknown()IsInsufficientPermission()IsInvalidEmail()
FCM API 異動
- 將
messaging.WebpushFCMOptions類型重新命名為messaging.WebpushFcmOptions。 - 新增:
IsThirdPartyAuthError()IsQuotaExceeded()IsSenderIDMismatch()IsUnregistered()IsUnavailable()
- 已淘汰:
IsInvalidAPNSCredentials()IsMessageRateExceeded()IsMismatchedCredential()IsRegistrationTokenNotRegistered()IsServerUnavailable()IsTooManyTopics()IsUnknown()
IID API 異動
iid 套件中目前可用的所有錯誤處理函式現已淘汰。請改用 errorutils 套件中提供的對應錯誤處理函式。