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

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

לפרויקטים שמשתמשים ב-List API נדרש Cloud Storage ל-Firebase כללים גרסה 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() יחזיר את הקובץ כפריט.

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

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

פעולות הרשימה על פריטים בקטגוריה הזו יספקו את התוצאות הבאות:

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

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

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

ברשימה גדולה, מומלץ להשתמש בשיטה 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, פריטים אחרי שמוצג אסימון הדף.

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

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.

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