فهرست فایل‌ها با فضای ذخیره‌سازی ابری در اندروید

Cloud Storage for Firebase به شما امکان می دهد محتویات سطل Cloud Storage خود را فهرست کنید. SDK ها هم موارد و هم پیشوندهای اشیاء را تحت مرجع Cloud Storage فعلی برمی گردانند.

پروژه‌هایی که از List API استفاده می‌کنند، به Cloud Storage for Firebase نسخه 2 نیاز دارند. اگر پروژه Firebase موجود دارید، مراحل راهنمای قوانین امنیتی را دنبال کنید.

list() از Google Cloud Storage List API استفاده می کند. در Cloud Storage for Firebase ، ما از / به عنوان یک جداکننده استفاده می‌کنیم که به ما امکان می‌دهد مفاهیم سیستم فایل را شبیه‌سازی کنیم. فهرست API برای پیمایش موثر سطل‌های Cloud Storage سلسله مراتبی و بزرگ، پیشوندها و موارد را جداگانه برمی‌گرداند. برای مثال، اگر یک فایل /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 شامل دو / s متوالی است.
• عملیات لیست در lonelyItem/ هیچ مرجعی را بر نمی گرداند زیرا شی lonelyItem/ با / ختم می شود.

لیست همه فایل ها

می توانید از listAll برای واکشی همه نتایج برای یک فهرست استفاده کنید. این به بهترین وجه برای دایرکتوری های کوچک استفاده می شود زیرا همه نتایج در حافظه بافر هستند. اگر اشیا در طول فرآیند اضافه یا حذف شوند، ممکن است این عملیات یک عکس فوری ثابت را برگرداند.

برای یک لیست بزرگ، از متد list() صفحه بندی شده استفاده کنید، زیرا listAll() تمام نتایج را در حافظه بافر می کند.

مثال زیر listAll نشان می دهد.

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

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

صفحه بندی نتایج لیست

list() API محدودیتی برای تعداد نتایجی که برمی گرداند قرار می دهد. list() یک نمای صفحه ثابت ارائه می دهد و یک pageToken را نشان می دهد که امکان کنترل زمان واکشی نتایج اضافی را فراهم می کند.

pageToken مسیر و نسخه آخرین موردی که در نتیجه قبلی برگردانده شده را رمزگذاری می کند. در یک درخواست بعدی با استفاده از pageToken، مواردی که بعد از pageToken قرار می گیرند نشان داده می شوند.

مثال زیر صفحه بندی یک نتیجه را نشان می دهد:

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

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

رسیدگی به خطاها

اگر قوانین امنیتی را به نسخه 2 ارتقا نداده باشید list() و listAll() با شکست مواجه می شوند. اگر این خطا را مشاهده کردید، قوانین امنیتی خود را ارتقا دهید:

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

سایر خطاهای احتمالی ممکن است نشان دهد که کاربر مجوز درستی ندارد. اطلاعات بیشتر در مورد خطاها را می توانید در Handle Errors بیابید.