فضای ذخیرهسازی ابری برای فایربیس به شما امکان میدهد محتویات سطل فضای ذخیرهسازی ابری خود را فهرست کنید. SDKها هم آیتمها و هم پیشوندهای اشیاء را تحت مرجع فعلی فضای ذخیرهسازی ابری برمیگردانند.
پروژههایی که از List API استفاده میکنند، برای قوانین Firebase نسخه ۲ به فضای ذخیرهسازی ابری نیاز دارند. اگر پروژه Firebase موجود دارید، مراحل موجود در راهنمای قوانین امنیتی را دنبال کنید.
list() از API فهرست فضای ذخیرهسازی ابری گوگل استفاده میکند. در فضای ذخیرهسازی ابری برای فایربیس، از / به عنوان جداکننده استفاده میکنیم که به ما امکان میدهد معانی سیستم فایل را شبیهسازی کنیم. برای پیمایش کارآمد در سطلهای بزرگ و سلسله مراتبی فضای ذخیرهسازی ابری، API فهرست، پیشوندها و موارد را جداگانه برمیگرداند. به عنوان مثال، اگر یک فایل /images/uid/file1 را آپلود کنید،
-
root.child('images').listAll()/images/uid را به عنوان پیشوند برمیگرداند. -
root.child('images/uid').listAll()فایل را به عنوان یک آیتم برمیگرداند.
SDK مربوط به فضای ذخیرهسازی ابری فایربیس، مسیرهای شیء که شامل دو / متوالی باشند یا با / خاتمه یابند را برنمیگرداند. برای مثال، یک سطل را در نظر بگیرید که اشیاء زیر را دارد:
-
correctPrefix/happyItem -
wrongPrefix//sadItem -
lonelyItem/
عملیات لیست روی اقلام موجود در این سطل نتایج زیر را خواهد داشت:
- عملیات لیست در ریشه، ارجاعات به
correctPrefix،wrongPrefixوlonelyItemبه عنوانprefixesبرمیگرداند. - عملیات لیست در
correctPrefix/ارجاعات بهcorrectPrefix/happyItemرا به عنوانitemsبرمیگرداند. - عملیات لیست در
wrongPrefix/هیچ ارجاعی را برنمیگرداند زیراwrongPrefix//sadItemشامل دو/متوالی است. - عملیات لیست در
lonelyItem/هیچ ارجاعی را برنمیگرداند زیرا شیءlonelyItem/با/خاتمه مییابد.
لیست کردن تمام فایلها
شما میتوانید listAll برای دریافت تمام نتایج یک دایرکتوری استفاده کنید. این روش برای دایرکتوریهای کوچک بهتر است زیرا تمام نتایج در حافظه بافر میشوند. همچنین اگر اشیاء در طول فرآیند اضافه یا حذف شوند، ممکن است این عملیات یک snapshot ثابت برنگرداند.
برای یک لیست بزرگ، از متد 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() list تعداد نتایجی که برمیگرداند را محدود میکند. 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);
}
مدیریت خطاها
اگر قوانین امنیتی را به نسخه ۲ ارتقا نداده باشید، 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.
سایر خطاهای احتمالی ممکن است نشان دهنده عدم دسترسی کاربر باشد. اطلاعات بیشتر در مورد خطاها را میتوانید در صفحه مدیریت خطاها بیابید.