يتيح لك 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
.
Web modular API
import { getStorage, ref, listAll } from "firebase/storage"; const storage = getStorage(); // Create a reference under which you want to list const listRef = ref(storage, 'files/uid'); // Find all the prefixes and items. listAll(listRef) .then((res) => { res.prefixes.forEach((folderRef) => { // All the prefixes under listRef. // You may call listAll() recursively on them. }); res.items.forEach((itemRef) => { // All the items under listRef. }); }).catch((error) => { // Uh-oh, an error occurred! });
Web namespaced API
// Create a reference under which you want to list var listRef = storageRef.child('files/uid'); // Find all the prefixes and items. listRef.listAll() .then((res) => { res.prefixes.forEach((folderRef) => { // All the prefixes under listRef. // You may call listAll() recursively on them. }); res.items.forEach((itemRef) => { // All the items under listRef. }); }).catch((error) => { // Uh-oh, an error occurred! });
نتائج قائمة الصفحات
تضع واجهة برمجة التطبيقات list()
حدًا لعدد النتائج التي تُرجعها. يوفر list()
عرضًا متسقًا للصفحة ويكشف عن pageToken الذي يسمح بالتحكم في وقت جلب نتائج إضافية.
يقوم pageToken بتشفير مسار وإصدار العنصر الأخير الذي تم إرجاعه في النتيجة السابقة. في طلب لاحق باستخدام pageToken، يتم عرض العناصر التي تأتي بعد pageToken.
يوضح المثال التالي ترقيم النتائج باستخدام async/await
.
Web modular API
import { getStorage, ref, list } from "firebase/storage"; async function pageTokenExample(){ // Create a reference under which you want to list const storage = getStorage(); const listRef = ref(storage, 'files/uid'); // Fetch the first page of 100. const firstPage = await list(listRef, { maxResults: 100 }); // Use the result. // processItems(firstPage.items) // processPrefixes(firstPage.prefixes) // Fetch the second page if there are more elements. if (firstPage.nextPageToken) { const secondPage = await list(listRef, { maxResults: 100, pageToken: firstPage.nextPageToken, }); // processItems(secondPage.items) // processPrefixes(secondPage.prefixes) } }
Web namespaced API
async function pageTokenExample(){ // Create a reference under which you want to list var listRef = storageRef.child('files/uid'); // Fetch the first page of 100. var firstPage = await listRef.list({ maxResults: 100}); // Use the result. // processItems(firstPage.items) // processPrefixes(firstPage.prefixes) // Fetch the second page if there are more elements. if (firstPage.nextPageToken) { var secondPage = await listRef.list({ maxResults: 100, pageToken: firstPage.nextPageToken, }); // processItems(secondPage.items) // processPrefixes(secondPage.prefixes) } }
التعامل مع الأخطاء
تعرض 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.
قد تشير الأخطاء المحتملة الأخرى إلى أن المستخدم ليس لديه الإذن الصحيح. يمكن العثور على مزيد من المعلومات حول الأخطاء في التعامل مع الأخطاء .