Wersja 7.0.0 pakietu Firebase Admin SDK na Javę wprowadza kilka ważnych zmian w interfejsie API. Zmiany w interfejsie API w tej wersji to przede wszystkim dodatki i ulepszenia w zakresie obsługi błędów w przypadku interfejsów Authentication i FCM.
Ogólne zmiany w obsłudze błędów
FirebaseException
klasa bazowa udostępnia teraz kilka nowych atrybutów:
ErrorCode getErrorCode()
: zwraca kod błędu platformy powiązany z wyjątkiem. Każda instancjaFirebaseException
ma gwarancję, że kod błędu platformy nie będzie miał wartości null. Możliwe kody błędów platformy są zdefiniowane jako nowy typ wyliczeniowyErrorCode
.IncomingHttpResponse getHttpResponse()
: zwraca odpowiedź HTTP powiązaną z wyjątkiem. Może mieć wartość null, jeśli wyjątek został spowodowany przez przyczynę inną niż odpowiedź HTTP z backendu.
Podobnie jak wcześniej większość innych typów wyjątków zdefiniowanych w pakiecie SDK (np. FirebaseAuthException
, FirebaseMessagingException
) pochodzi z klasy bazowej FirebaseException
.
Zmiany w obsłudze błędów uwierzytelniania
Wszystkie interfejsy API w klasie FirebaseAuth
mogą zgłaszać instancje klasy FirebaseAuthException
. Interfejsy Async API (np. metody zwracające ApiFuture
) mogą zwracać błędy ExecutionException
, które zawierają FirebaseAuthException
. Kody błędów związane z uwierzytelnianiem są publicznie zdefiniowane w nowym typie wyliczeniowym AuthErrorCode
.
Przed (<= v6.15.0)
try {
FirebaseAuth.getInstance().verifyIdToken(idToken, true);
} catch (FirebaseAuthException ex) {
if (ex.getErrorCode().equals("id-token-revoked")) {
System.err.println("ID token has been revoked");
} else {
System.err.println("ID token is invalid");
}
}
Teraz (>= v7.0.0)
try {
FirebaseAuth.getInstance().verifyIdToken(idToken, true);
} catch (FirebaseAuthException ex) {
if (ex.getAuthErrorCode() == AuthErrorCode.REVOKED_ID_TOKEN) {
System.err.println("ID token has been revoked");
} else {
System.err.println("ID token is invalid");
}
}
Wartość AuthErrorCode
jest dodawana do wartości ErrorCode
odziedziczonej z typu podstawowego FirebaseException
. W razie potrzeby możesz wdrożyć logikę obsługi błędów, która sprawdza oba kody błędów.
FCM zmiany w obsłudze błędów
Wszystkie interfejsy API w klasie FirebaseMessaging
mogą zgłaszać instancje klasy FirebaseMessagingException
. Interfejsy Async API (np. metody zwracające ApiFuture
) mogą zwracać błędy ExecutionException
, które zawierają FirebaseMessagingException
. Kody błędów związane z Authentication są publicznie zdefiniowane w nowym typie wyliczenia MessagingErrorCode
.
Przed (<= v6.15.0)
try {
FirebaseMessaging.getInstance().send(message);
} catch (FirebaseMessagingException ex) {
if (ex.getErrorCode().equals("registration-token-not-registered")) {
System.err.println("Device token has been unregistered");
} else {
System.err.println("Failed to send the notification");
}
}
Teraz (>= v7.0.0)
try {
FirebaseMessaging.getInstance().send(message);
} catch (FirebaseMessagingException ex) {
if (ex.getMessagingErrorCode() == MessagingErrorCode.UNREGISTERED) {
System.err.println("Device token has been unregistered");
} else {
System.err.println("Failed to send the notification");
}
}
Wartość MessagingErrorCode
jest dodatkiem do wartości ErrorCode
odziedziczonej z typu podstawowego FirebaseException
. Możesz wdrożyć logikę obsługi błędów, która w razie potrzeby sprawdza oba kody błędów.
Authentication roszczenia niestandardowe
Wycofana metoda FirebaseAuth.setCustomClaims()
została usunięta. Zamiast tego użyj atrybutu FirebaseAuth.setCustomUserClaims()
.
Przed (<= v6.15.0)
FirebaseAuth.getInstance().setCustomClaims(uid, claims);
Teraz (>= v7.0.0)
FirebaseAuth.getInstance().setCustomUserClaims(uid, claims);
FCM konstruktory powiadomień
Wycofane konstruktory klasy Notification
zostały usunięte. Użyj klasy Notification.Builder
, aby utworzyć nowe instancje.
Przed (<= v6.15.0)
Notification notification = new Notification(title, body, url);
Teraz (>= v7.0.0)
Notification notification = Notification.builder()
.setTitle(title)
.setBody(body)
.setImage(url)
.build();