يتيح لك Cloud Storage for Firebase إدراج محتويات مجموعة Cloud Storage الخاصة بك. تقوم مجموعات SDK بإرجاع كل من العناصر وبادئات الكائنات ضمن مرجع Cloud Storage الحالي.
تتطلب المشروعات التي تستخدم List API الإصدار 2 من Cloud Storage for Firebase Rules. إذا كان لديك مشروع Firebase حالي، فاتبع الخطوات الواردة في دليل قواعد الأمان .
يستخدم list()
واجهة برمجة تطبيقات Google Cloud Storage List . في Cloud Storage for Firebase، نستخدم /
كمحدد، مما يسمح لنا بمحاكاة دلالات نظام الملفات. للسماح بالاجتياز الفعال لحاويات التخزين السحابي الكبيرة والهرمية، تقوم واجهة برمجة تطبيقات القائمة بإرجاع البادئات والعناصر بشكل منفصل. على سبيل المثال، إذا قمت بتحميل ملف واحد /images/uid/file1
،
-
root.child('images').listAll()
سيعيد/images/uid
كبادئة. -
root.child('images/uid').listAll()
سيعيد الملف كعنصر.
لا يُرجع Cloud Storage for Firebase SDK مسارات الكائنات التي تحتوي على /
s متتاليتين أو تنتهي بـ /
. على سبيل المثال، فكر في دلو يحتوي على الكائنات التالية:
-
correctPrefix/happyItem
-
wrongPrefix//sadItem
-
lonelyItem/
ستعطي عمليات القائمة على العناصر الموجودة في هذه المجموعة النتائج التالية:
- تقوم عملية القائمة في الجذر بإرجاع المراجع إلى
correctPrefix
وwrongPrefix
وlonelyItem
prefixes
. - تقوم عملية القائمة في
correctPrefix/
بإرجاع المراجع إلىcorrectPrefix/happyItem
items
. - عملية القائمة في
wrongPrefix/
لا تُرجع أي مراجع لأنwrongPrefix//sadItem
يحتوي على اثنين/
s متتاليتين. - لا تُرجع عملية القائمة في
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.
قد تشير الأخطاء المحتملة الأخرى إلى أن المستخدم ليس لديه الإذن الصحيح. يمكن العثور على مزيد من المعلومات حول الأخطاء في التعامل مع الأخطاء .