يتيح لك Cloud Storage for Firebase إدراج محتوى حزمة Cloud Storage. تعرض حِزم تطوير البرامج (SDK) كلّ من العناصر وبادئات العناصر ضمن مرجع Cloud Storage الحالي.
تتطلّب المشاريع التي تستخدم List API استخدام Cloud Storage for Firebase الإصدار 2 من 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
لعرض جميع النتائج لدليل معيّن.
يُنصح باستخدام هذا الخيار مع الدلائل الصغيرة، لأنّه يتم تخزين جميع النتائج مؤقتًا في الذاكرة.
قد لا تُعرِض العملية أيضًا لقطة منتظمة إذا تمت إضافة عناصر أو
إزالتها أثناء العملية.
بالنسبة إلى القائمة الكبيرة، استخدِم طريقة 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! } });
تقسيم نتائج القائمة إلى صفحات
تفرض واجهة برمجة التطبيقات list()
حدًا لعدد النتائج التي تعرِضها. list()
يقدّم مشاهدة صفحة متّسقة ويعرِض معرّف صفحة يتيح التحكّم في
وقت جلب نتائج إضافية.
يُشفِّر المعرّف 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.
قد تشير الأخطاء الأخرى المحتمَلة إلى أنّ المستخدم لا يملك الإذن المناسب. يمكنك الاطّلاع على مزيد من المعلومات عن الأخطاء في مقالة معالجة الأخطاء.