تتيح لك خدمة Cloud Storage for Firebase عرض محتويات حاوية Cloud Storage. تعرض حِزم تطوير البرامج (SDK) كلاً من العناصر وبادئات الكائنات ضِمن مرجع Cloud Storage الحالي.
تتطلّب المشاريع التي تستخدم List API الإصدار 2 من قواعد الأمان في Cloud Storage for Firebase. إذا كان لديك مشروع حالي على 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/happyItemwrongPrefix//sadItemlonelyItem/
ستؤدي عمليات القائمة على العناصر في هذه الحاوية إلى النتائج التالية:
- تعرض عملية القائمة في الجذر مراجع
correctPrefixوwrongPrefixوlonelyItemكـprefixes. - تعرض عملية القائمة في
correctPrefix/مراجعcorrectPrefix/happyItemكـitems. - لا تعرض عملية القائمة في
wrongPrefix/أي مراجع لأنّwrongPrefix//sadItemتحتوي على شرطتَين متتاليتَين/ - لا تعرض عملية القائمة في
lonelyItem/أي مراجع لأنّ الكائنlonelyItem/ينتهي بشرطة/.
عرض جميع الملفات
يمكنك استخدام listAll لجلب جميع نتائج دليل معيّن.
يُنصح باستخدام هذه الطريقة مع الأدلة الصغيرة لأنّه يتم تخزين جميع النتائج مؤقتًا في الذاكرة.
قد لا تعرض العملية أيضًا لقطة متّسقة إذا تمت إضافة كائنات أو إزالتها أثناء العملية.
بالنسبة إلى القوائم الكبيرة، استخدِم طريقة 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() عرضًا ثابتًا للصفحة وتعرض 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() إذا لم تتم ترقية قواعد الأمان إلى الإصدار 2. يمكنك ترقية قواعد الأمان إذا ظهر لك هذا الخطأ:
Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.
قد تشير الأخطاء المحتمَلة الأخرى إلى أنّ المستخدم لا يملك الإذن المناسب. يمكنك الاطّلاع على مزيد من المعلومات حول الأخطاء في مقالة التعامل مع الأخطاء.