Cloud Storage for Firebase به شما امکان می دهد محتویات سطل Cloud Storage خود را فهرست کنید. SDK ها هم موارد و هم پیشوندهای اشیاء را تحت مرجع ذخیره سازی ابری فعلی برمی گردانند.
پروژه‌هایی که از List API استفاده می‌کنند، به Cloud Storage برای قوانین Firebase نسخه 2 نیاز دارند. اگر پروژه Firebase موجود دارید، مراحل راهنمای قوانین امنیتی را دنبال کنید.
list() از Google Cloud Storage List API استفاده می کند. در Cloud Storage برای Firebase، ما از / به عنوان یک جداکننده استفاده می‌کنیم که به ما امکان می‌دهد مفاهیم سیستم فایل را شبیه‌سازی کنیم. فهرست API برای پیمایش موثر سطل‌های ذخیره‌سازی ابری سلسله مراتبی و بزرگ، پیشوندها و موارد را جداگانه برمی‌گرداند. برای مثال، اگر یک فایل /images/uid/file1 آپلود کنید،
-
root.child('images').listAll()/images/uidرا به عنوان پیشوند برمی گرداند. -
root.child('images/uid').listAll()فایل را به عنوان یک آیتم برمی گرداند.
Cloud Storage برای Firebase SDK مسیرهای شی که شامل دو / ثانیه متوالی هستند یا با یک / ختم می شوند را بر نمی گرداند. به عنوان مثال، سطلی را در نظر بگیرید که دارای اشیاء زیر است:
-
correctPrefix/happyItem -
wrongPrefix//sadItem -
lonelyItem/
عملیات لیست روی اقلام در این سطل نتایج زیر را به همراه خواهد داشت:
- عملیات لیست در ریشه، ارجاعات به
correctPrefix،wrongPrefixوlonelyItemرا به عنوانprefixesبرمی گرداند. - عملیات لیست در
correctPrefix/ارجاعات بهcorrectPrefix/happyItemرا به عنوانitemsبرمی گرداند. - عملیات لیست در
wrongPrefix/هیچ مرجعی را برنمی‌گرداند زیراwrongPrefix//sadItemشامل دو/s متوالی است. - عملیات لیست در
lonelyItem/هیچ مرجعی را بر نمی گرداند زیرا شیlonelyItem/با/ختم می شود.
لیست همه فایل ها
می توانید listAll برای واکشی همه نتایج برای یک فهرست استفاده کنید. این به بهترین وجه برای دایرکتوری های کوچک استفاده می شود زیرا همه نتایج در حافظه بافر هستند. اگر اشیا در طول فرآیند اضافه یا حذف شوند، ممکن است این عملیات یک عکس فوری ثابت را برگرداند.
برای یک لیست بزرگ، از متد list() صفحه بندی شده استفاده کنید، زیرا listAll() تمام نتایج را در حافظه بافر می کند.
مثال زیر listAll را نشان می دهد.
final storageRef = FirebaseStorage.instance.ref().child("files/uid");
final listResult = await storageRef.listAll();
for (var prefix in listResult.prefixes) {
// The prefixes under storageRef.
// You can call listAll() recursively on them.
}
for (var item in listResult.items) {
// The items under storageRef.
}
صفحه بندی نتایج لیست
list() API محدودیتی برای تعداد نتایجی که برمی گرداند قرار می دهد. list() یک نمای صفحه ثابت ارائه می دهد و یک pageToken را نشان می دهد که امکان کنترل زمان واکشی نتایج اضافی را فراهم می کند.
pageToken مسیر و نسخه آخرین موردی که در نتیجه قبلی برگردانده شده را رمزگذاری می کند. در یک درخواست بعدی با استفاده از pageToken، مواردی که بعد از pageToken قرار می گیرند نشان داده می شوند.
مثال زیر صفحه بندی یک نتیجه را نشان می دهد:
Stream<ListResult> listAllPaginated(Reference storageRef) async* {
String? pageToken;
do {
final listResult = await storageRef.list(ListOptions(
maxResults: 100,
pageToken: pageToken,
));
yield listResult;
pageToken = listResult.nextPageToken;
} while (pageToken != null);
}
رسیدگی به خطاها
اگر قوانین امنیتی را به نسخه 2 ارتقا نداده باشید list() و listAll() با شکست مواجه می شوند. اگر این خطا را مشاهده کردید، قوانین امنیتی خود را ارتقا دهید:
Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.
سایر خطاهای احتمالی ممکن است نشان دهد که کاربر مجوز درستی ندارد. اطلاعات بیشتر در مورد خطاها را می توانید در صفحه Handle Errors پیدا کنید.