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