הצגת רשימה של קבצים ב-Cloud Storage ב-Android

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

בפרויקטים שמשתמשים ב-List API נדרשת גרסה 2 של Cloud Storage for Firebase Rules. אם יש לכם פרויקט 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 מכיל שתי פעולות / ברצף.
  • פעולת הרשימה ב-lonelyItem/ לא מחזירה הפניות כי האובייקט lonelyItem/ מסתיים ב-/.

הצגת כל הקבצים

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

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

הדוגמה הבאה היא של listAll.

Kotlin+KTX

val storage = Firebase.storage
val listRef = storage.reference.child("files/uid")

// You'll need to import com.google.firebase.storage.component1 and
// com.google.firebase.storage.component2
listRef.listAll()
    .addOnSuccessListener { (items, prefixes) ->
        for (prefix in prefixes) {
            // All the prefixes under listRef.
            // You may call listAll() recursively on them.
        }

        for (item in items) {
            // All the items under listRef.
        }
    }
    .addOnFailureListener {
        // Uh-oh, an error occurred!
    }

Java

StorageReference listRef = storage.getReference().child("files/uid");

listRef.listAll()
        .addOnSuccessListener(new OnSuccessListener<ListResult>() {
            @Override
            public void onSuccess(ListResult listResult) {
                for (StorageReference prefix : listResult.getPrefixes()) {
                    // All the prefixes under listRef.
                    // You may call listAll() recursively on them.
                }

                for (StorageReference item : listResult.getItems()) {
                    // All the items under listRef.
                }
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Uh-oh, an error occurred!
            }
        });

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

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

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

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

Kotlin+KTX

fun listAllPaginated(pageToken: String?) {
    val storage = Firebase.storage
    val listRef = storage.reference.child("files/uid")

    // Fetch the next page of results, using the pageToken if we have one.
    val listPageTask = if (pageToken != null) {
        listRef.list(100, pageToken)
    } else {
        listRef.list(100)
    }

    // You'll need to import com.google.firebase.storage.component1 and
    // com.google.firebase.storage.component2
    listPageTask
        .addOnSuccessListener { (items, prefixes, pageToken) ->
            // Process page of results
            processResults(items, prefixes)

            // Recurse onto next page
            pageToken?.let {
                listAllPaginated(it)
            }
        }.addOnFailureListener {
            // Uh-oh, an error occurred.
        }
}

Java

public void listAllPaginated(@Nullable String pageToken) {
    FirebaseStorage storage = FirebaseStorage.getInstance();
    StorageReference listRef = storage.getReference().child("files/uid");

    // Fetch the next page of results, using the pageToken if we have one.
    Task<ListResult> listPageTask = pageToken != null
            ? listRef.list(100, pageToken)
            : listRef.list(100);

    listPageTask
            .addOnSuccessListener(new OnSuccessListener<ListResult>() {
                @Override
                public void onSuccess(ListResult listResult) {
                    List<StorageReference> prefixes = listResult.getPrefixes();
                    List<StorageReference> items = listResult.getItems();

                    // Process page of results
                    // ...

                    // Recurse onto next page
                    if (listResult.getPageToken() != null) {
                        listAllPaginated(listResult.getPageToken());
                    }
                }
            }).addOnFailureListener(new OnFailureListener() {
                @Override
                public void onFailure(@NonNull Exception e) {
                    // Uh-oh, an error occurred.
                }
            });
}

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

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.

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