В версии 7.0.0 Firebase Admin SDK для Java представлен ряд важных изменений в API. В первую очередь, изменения API в этом выпуске касаются дополнений и улучшений в обработке ошибок Authentication и FCM .
Общие изменения в обработке ошибок
Базовый класс FirebaseException
теперь предоставляет несколько новых атрибутов:
-
ErrorCode getErrorCode()
: возвращает код ошибки платформы, связанный с исключением. Каждый экземплярFirebaseException
гарантированно имеет ненулевой код ошибки платформы. Возможные коды ошибок платформы определены как новый тип перечисленияErrorCode
. -
IncomingHttpResponse getHttpResponse()
: возвращает HTTP-ответ, связанный с исключением. Может быть null, если исключение было вызвано не HTTP-ответом бэкенда.
Как и прежде, большинство других типов исключений, определенных в SDK (например, FirebaseAuthException
, FirebaseMessagingException
), являются производными от базового класса FirebaseException
.
Изменения в обработке ошибок аутентификации
Все API класса FirebaseAuth
могут генерировать исключения FirebaseAuthException
. Асинхронные API (например, методы, возвращающие ApiFuture
) могут завершаться с ошибкой ExecutionException
, которая оборачивает FirebaseAuthException
. Коды ошибок, специфичные для Auth, публично определены в новом перечисляемом типе AuthErrorCode
.
До (<= 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");
}
}
Сейчас (>= 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");
}
}
AuthErrorCode
является дополнением к ErrorCode
унаследованному от базового типа FirebaseException
. При необходимости можно реализовать логику обработки ошибок, которая будет проверять оба кода.
Изменения в обработке ошибок FCM
Все API класса FirebaseMessaging
могут генерировать исключения FirebaseMessagingException
. Асинхронные API (например, методы, возвращающие ApiFuture
) могут завершаться с ошибкой ExecutionException
, которая оборачивает FirebaseMessagingException
. Коды ошибок, специфичные для Authentication , публично определены в новом перечисляемом типе MessagingErrorCode
.
До (<= 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");
}
}
Сейчас (>= 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");
}
}
MessagingErrorCode
является дополнением к ErrorCode
унаследованному от базового типа FirebaseException
. При необходимости можно реализовать логику обработки ошибок, которая будет проверять оба кода ошибок.
Пользовательские утверждения Authentication
Устаревший метод FirebaseAuth.setCustomClaims()
удалён. Вместо него используйте FirebaseAuth.setCustomUserClaims()
.
До (<= v6.15.0)
FirebaseAuth.getInstance().setCustomClaims(uid, claims);
Сейчас (>= v7.0.0)
FirebaseAuth.getInstance().setCustomUserClaims(uid, claims);
Конструкторы уведомлений FCM
Устаревшие конструкторы класса Notification
удалены. Для создания новых экземпляров используйте класс Notification.Builder
.
До (<= v6.15.0)
Notification notification = new Notification(title, body, url);
Сейчас (>= v7.0.0)
Notification notification = Notification.builder()
.setTitle(title)
.setBody(body)
.setImage(url)
.build();