מעבר אל Java Admin SDK גרסה 7

בגרסה 7.0.0 של ה-SDK של Firebase לאדמינים ב-Java יש כמה שינויים חשובים ב-API. השינויים העיקריים ב-API בגרסה הזו הם תוספות ושיפורים בטיפול בשגיאות ב-Authentication וב-FCM.

שינויים כלליים בטיפול בשגיאות

FirebaseException חושפת עכשיו כמה מאפיינים חדשים:

  • ‫ErrorCode getErrorCode(): מחזירה את קוד השגיאה של הפלטפורמה שמשויך לחריגה. כל מופע של FirebaseException יכלול קוד שגיאה של הפלטפורמה שהוא לא null. קודי השגיאה האפשריים של הפלטפורמה מוגדרים כסוג חדש של enum‏ ErrorCode.
  • ‫IncomingHttpResponse getHttpResponse(): מחזירה את תגובת ה-HTTP שמשויכת לחריגה. יכול להיות null אם החריגה נגרמה מסיבה אחרת, ולא מתגובת HTTP של קצה עורפי.

כמו קודם, רוב סוגי החריגות האחרים שמוגדרים ב-SDK (לדוגמה, FirebaseAuthException,‏ FirebaseMessagingException) נגזרים מהמחלקה הבסיסית FirebaseException.

שינויים בטיפול בשגיאות אימות

כל ממשקי ה-API במחלקה FirebaseAuth עשויים להפעיל מופעים של FirebaseAuthException. ממשקי API אסינכרוניים (לדוגמה, שיטות שמחזירות ApiFuture) עלולים להיכשל עם ExecutionException שעוטף FirebaseAuthException. קודי השגיאה הספציפיים לאימות מוגדרים באופן ציבורי בסוג ה-enum החדש 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 מוגדרים באופן ציבורי בסוג ה-enum החדש 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 בנאים של התראות

הוסרו ה-constructors שהוצאו משימוש במחלקה 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();