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

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

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

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

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

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

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

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

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

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

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

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

בדוגמה הבאה מוצג listAll.

Kotlin

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

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.

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