הצגת רשימת קבצים באמצעות Cloud Storage ב-Flutter

‫Cloud Storage for Firebase מאפשר לכם להציג את התוכן של הקטגוריה שלכם ב-Cloud Storage. ערכות ה-SDK מחזירות גם את הפריטים וגם את הקידומות של האובייקטים בהפניה הנוכחית ל-Cloud Storage.

פרויקטים שמשתמשים ב-List API צריכים את Cloud Storage for Firebase Rules גרסה 2. אם יש לכם פרויקט Firebase קיים, פועלים לפי השלבים שמפורטים במדריך לכללי אבטחה.

‫list() משתמש ב-Google Cloud Storage List API. ב-Cloud Storage for Firebase, אנחנו משתמשים ב-/ כתו מפריד, שמאפשר לנו לחקות סמנטיקה של מערכת קבצים. כדי לאפשר מעבר יעיל בין קטגוריות גדולות והיררכיות של Cloud Storage,‏ List API מחזיר קידומות ופריטים בנפרד. לדוגמה, אם מעלים קובץ אחד /images/uid/file1,

  • ‫root.child('images').listAll() יחזיר את /images/uid כקידומת.
  • ‫root.child('images/uid').listAll() תחזיר את הקובץ כפריט.

ה-SDK של Cloud Storage for Firebase לא מחזיר נתיבי אובייקטים שמכילים שני תווי / רצופים או מסתיימים ב-/. לדוגמה, נניח שיש לכם קטגוריה עם האובייקטים הבאים:

  • correctPrefix/happyItem
  • wrongPrefix//sadItem
  • lonelyItem/

פעולות הרשימה על פריטים בדלי הזה יניבו את התוצאות הבאות:

  • פעולת הרשימה ברמת הבסיס מחזירה את ההפניות אל correctPrefix,‏ wrongPrefix ו-lonelyItem בתור prefixes.
  • פעולת הרשימה ב-correctPrefix/ מחזירה את ההפניות אל correctPrefix/happyItem בתור items.
  • פעולת הרשימה ב-wrongPrefix/ לא מחזירה הפניות כי wrongPrefix//sadItem מכיל שני /s רצופים.
  • פעולת הרשימה ב-lonelyItem/ לא מחזירה הפניות כי האובייקט lonelyItem/ מסתיים ב-/.

הצגת רשימה של כל הקבצים

אפשר להשתמש ב-listAll כדי לאחזר את כל התוצאות של ספרייה. השיטה הזו מתאימה במיוחד לספריות קטנות, כי כל התוצאות נשמרות בזיכרון. בנוסף, יכול להיות שהפעולה לא תחזיר תמונת מצב עקבית אם אובייקטים יתווספו או יוסרו במהלך התהליך.

אם הרשימה גדולה, כדאי להשתמש בשיטה list() עם חלוקה לדפים, כי listAll() שומרת את כל התוצאות בזיכרון.

בדוגמה הבאה אפשר לראות איך משתמשים ב-listAll.

final storageRef = FirebaseStorage.instance.ref().child("files/uid");
final listResult = await storageRef.listAll();
for (var prefix in listResult.prefixes) {
  // The prefixes under storageRef.
  // You can call listAll() recursively on them.
}
for (var item in listResult.items) {
  // The items under storageRef.
}

חלוקת תוצאות הרשימה לדפים

ב-API‏ list() יש מגבלה על מספר התוצאות שהוא מחזיר. list() מספקת צפייה עקבית בדף וחושפת pageToken שמאפשר שליטה על המועד לאחזור תוצאות נוספות.

הפרמטר pageToken מקודד את הנתיב והגרסה של הפריט האחרון שהוחזר בתוצאה הקודמת. בבקשה הבאה באמצעות pageToken, מוצגים פריטים שמופיעים אחרי pageToken.

בדוגמה הבאה מוצג אופן חלוקת התוצאה לדפים:

Stream<ListResult> listAllPaginated(Reference storageRef) async* {
  String? pageToken;
  do {
    final listResult = await storageRef.list(ListOptions(
      maxResults: 100,
      pageToken: pageToken,
    ));
    yield listResult;
    pageToken = listResult.nextPageToken;
  } while (pageToken != null);
}

טיפול בשגיאות

הכללים list() ו-listAll() ייכשלו אם לא שדרגתם את כללי האבטחה לגרסה 2. אם מופיעה השגיאה הבאה, צריך לשדרג את כללי האבטחה:

Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.

שגיאות אפשריות אחרות עשויות להצביע על כך שלמשתמש אין את ההרשאה הנכונה. מידע נוסף על שגיאות זמין בדף טיפול בשגיאות.