Cloud Storage for Firebase به شما امکان میدهد محتویات سطل Cloud Storage خود را فهرست کنید. SDKها هم آیتمها و هم پیشوندهای اشیاء را تحت مرجع فعلی Cloud Storage برمیگردانند.
پروژههایی که از List API استفاده میکنند، Cloud Storage for Firebase نیاز دارند. اگر پروژه Firebase موجود دارید، مراحل موجود در راهنمای قوانین امنیتی را دنبال کنید.
list() از API فهرست Google Cloud Storage استفاده میکند. در Cloud Storage for Firebase ، ما از / به عنوان جداکننده استفاده میکنیم که به ما امکان میدهد معانی سیستم فایل را شبیهسازی کنیم. برای پیمایش کارآمد در سطلهای بزرگ و سلسله مراتبی Cloud Storage ، 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
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! } });
نتایج لیست را صفحه بندی کنید
list() 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() با شکست مواجه میشوند. اگر این خطا را مشاهده کردید، قوانین امنیتی خود را ارتقا دهید:
Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.
سایر خطاهای احتمالی ممکن است نشان دهنده عدم دسترسی کاربر باشد. اطلاعات بیشتر در مورد خطاها را میتوانید در بخش «مدیریت خطاها» بیابید.