רשימת קבצים עם Cloud Storage באנדרואיד

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

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

correctPrefix/happyItem
wrongPrefix//sadItem
lonelyItem/

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

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

רשום את כל הקבצים

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

עבור רשימה גדולה, השתמש בשיטת ה-pagened 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!
    }StorageActivity.kt

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!
            }
        });StorageActivity.java

עמוד בתוצאות של רשימה

ה-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.
        }
}StorageActivity.kt

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.
                }
            });
}StorageActivity.java

לטפל בשגיאות

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.

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