Wersja 7.0.0 pakietu Firebase Admin SDK dla Javy wprowadza kilka ważnych zmian w interfejsie API. Zmiany w interfejsie API w tej wersji to przede wszystkim dodatki i ulepszenia w obsłudze błędów w przypadku Authentication i FCM.
Ogólne zmiany w obsłudze błędów
Klasa bazowa FirebaseException udostępnia teraz kilka nowych atrybutów:
ErrorCode getErrorCode(): zwraca kod błędu platformy powiązany z wyjątkiem. Każda instancjaFirebaseExceptionma niepusty kod błędu platformy. 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 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 FirebaseAuthException. Asynchroniczne interfejsy API (np. metody, które zwracają ApiFuture) mogą zakończyć się niepowodzeniem z błędem ExecutionException, który zawiera FirebaseAuthException. Kody błędów związane z uwierzytelnianiem są publicznie zdefiniowane w nowym typie wyliczeniowym AuthErrorCode.
Przed (<= wersja 6.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 (>= wersja 7.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");
}
}
AuthErrorCode jest dodatkiem do ErrorCode odziedziczonego z podstawowego typu FirebaseException. W razie potrzeby możesz wdrożyć logikę obsługi błędów, która sprawdza oba kody błędów.
FCM zmiana obsługi błędów
Wszystkie interfejsy API w klasie FirebaseMessaging mogą zgłaszać instancje FirebaseMessagingException. Asynchroniczne interfejsy API (np. metody, które zwracają ApiFuture) mogą zakończyć się niepowodzeniem z błędem ExecutionException, który zawiera FirebaseMessagingException. Kody błędów dotyczące Authentication są publicznie zdefiniowane w nowym typie wyliczeniowym MessagingErrorCode.
Przed (<= wersja 6.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 (>= wersja 7.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");
}
}
Właściwość MessagingErrorCode jest dodatkiem do właściwości ErrorCode odziedziczonej z podstawowego typu FirebaseException. W razie potrzeby możesz wdrożyć logikę obsługi błędów, która sprawdza oba kody błędów.
Authentication roszczenie niestandardowe
Wycofana metoda FirebaseAuth.setCustomClaims() została usunięta. Zamiast tego użyj FirebaseAuth.setCustomUserClaims().
Przed (<= wersja 6.15.0)
FirebaseAuth.getInstance().setCustomClaims(uid, claims);
Teraz (>= wersja 7.0.0)
FirebaseAuth.getInstance().setCustomUserClaims(uid, claims);
FCM konstruktor powiadomień
Wycofane konstruktory klasy Notification zostały usunięte. Użyj klasy Notification.Builder, aby utworzyć nowe instancje.
Przed (<= wersja 6.15.0)
Notification notification = new Notification(title, body, url);
Teraz (>= wersja 7.0.0)
Notification notification = Notification.builder()
.setTitle(title)
.setBody(body)
.setImage(url)
.build();