فهرست فایل‌ها با Cloud Storage در پلتفرم‌های اپل

Cloud Storage for Firebase به شما امکان می‌دهد محتویات سطل Cloud Storage خود را فهرست کنید. SDKها هم آیتم‌ها و هم پیشوندهای اشیاء را تحت مرجع فعلی Cloud Storage برمی‌گردانند.

پروژه‌هایی که از API لیست استفاده می‌کنند، Cloud Storage for Firebase نیاز دارند. اگر پروژه فایربیس موجود دارید، مراحل موجود در راهنمای قوانین امنیتی را دنبال کنید.

list() از API فهرست Google Cloud Storage استفاده می‌کند. در Cloud Storage for Firebase ، ما از / به عنوان جداکننده استفاده می‌کنیم که به ما امکان می‌دهد معانی سیستم فایل را شبیه‌سازی کنیم. برای پیمایش کارآمد در سطل‌های بزرگ و سلسله مراتبی Cloud Storage ، API فهرست، پیشوندها و موارد را جداگانه برمی‌گرداند. به عنوان مثال، اگر یک فایل /images/uid/file1 را آپلود کنید،

• root.child('images').listAll() /images/uid ‎ را به عنوان پیشوند برمی‌گرداند.
• root.child('images/uid').listAll() فایل را به عنوان یک آیتم برمی‌گرداند.

SDK Cloud Storage for Firebase مسیرهای شیء که شامل دو / متوالی باشند یا با /. خاتمه یابند را برنمی‌گرداند. برای مثال، یک سطل را در نظر بگیرید که اشیاء زیر را دارد:

• correctPrefix/happyItem
• wrongPrefix//sadItem
• lonelyItem/

عملیات لیست روی اقلام موجود در این سطل نتایج زیر را خواهد داشت:

• عملیات لیست در ریشه، ارجاعات به correctPrefix ، wrongPrefix و lonelyItem را به عنوان prefixes برمی‌گرداند.
• عملیات لیست در correctPrefix/ ارجاعات به correctPrefix/happyItem را به عنوان items برمی‌گرداند.
• عملیات لیست در wrongPrefix/ هیچ ارجاعی را برنمی‌گرداند زیرا wrongPrefix//sadItem شامل دو / متوالی است.
• عملیات لیست در lonelyItem/ هیچ ارجاعی را برنمی‌گرداند زیرا شیء lonelyItem/ با / خاتمه می‌یابد.

لیست کردن تمام فایل‌ها

شما می‌توانید از listAll(completion:) برای دریافت تمام نتایج یک دایرکتوری استفاده کنید. این روش برای دایرکتوری‌های کوچک بهتر است زیرا تمام نتایج در حافظه بافر می‌شوند. همچنین اگر اشیاء در طول فرآیند اضافه یا حذف شوند، ممکن است این عملیات یک snapshot ثابت برنگرداند.

برای یک لیست بزرگ، از متد list(withMaxResults:completion:) صفحه‌بندی شده استفاده کنید، زیرا listAll(completion:) تمام نتایج را در حافظه بافر می‌کند.

مثال زیر listAll(completion:) را نشان می‌دهد.

let storageReference = storage.reference().child("files/uid")
do {
  let result = try await storageReference.listAll()
  for prefix in result.prefixes {
    // The prefixes under storageReference.
    // You may call listAll(completion:) recursively on them.
  }
  for item in result.items {
    // The items under storageReference.
  }
} catch {
  // ...
}
ViewController.swift

FIRStorageReference *storageReference = [storage reference];
[storageReference listAllWithCompletion:^(FIRStorageListResult *result, NSError *error) {
  if (error != nil) {
    // ...
  }

  for (FIRStorageReference *prefix in result.prefixes) {
    // All the prefixes under storageReference.
    // You may call listAllWithCompletion: recursively on them.
  }
  for (FIRStorageReference *item in result.items) {
    // All items under storageReference.
  }
}];
ViewController.m

نتایج لیست را صفحه بندی کنید

رابط برنامه‌نویسی کاربردی list(withMaxResults:completion:) محدودیتی بر تعداد نتایجی که برمی‌گرداند، اعمال می‌کند. list(withMaxResults:completion) یک نمای صفحه ثابت ارائه می‌دهد و یک pageToken را نمایش می‌دهد که امکان کنترل زمان دریافت نتایج اضافی را فراهم می‌کند.

pageToken مسیر و نسخه آخرین آیتم برگردانده شده در نتیجه قبلی را کدگذاری می‌کند. در درخواست بعدی با استفاده از pageToken، آیتم‌هایی که بعد از pageToken می‌آیند نمایش داده می‌شوند.

مثال زیر صفحه‌بندی یک نتیجه را نشان می‌دهد:

func listAllPaginated(pageToken: String? = nil) async throws {
  let storage = Storage.storage()
  let storageReference = storage.reference().child("files/uid")

  let listResult: StorageListResult
  if let pageToken = pageToken {
    listResult = try await storageReference.list(maxResults: 100, pageToken: pageToken)
  } else {
    listResult = try await storageReference.list(maxResults: 100)
  }
  let prefixes = listResult.prefixes
  let items = listResult.items
  // Handle list result
  // ...

  // Process next page
  if let token = listResult.pageToken {
    try await listAllPaginated(pageToken: token)
  }
}
ViewController.swift

- (void)paginateFilesAtReference:(FIRStorageReference *)reference
                       pageToken:(nullable NSString *)pageToken {
  void (^pageHandler)(FIRStorageListResult *_Nonnull, NSError *_Nullable) =
      ^(FIRStorageListResult *result, NSError *error) {
        if (error != nil) {
          // ...
        }
        NSArray *prefixes = result.prefixes;
        NSArray *items = result.items;

        // ...

        // Process next page
        if (result.pageToken != nil) {
          [self paginateFilesAtReference:reference pageToken:result.pageToken];
        }
  };

  if (pageToken != nil) {
    [reference listWithMaxResults:100 pageToken:pageToken completion:pageHandler];
  } else {
    [reference listWithMaxResults:100 completion:pageHandler];
  }
}
ViewController.m

مدیریت خطاها

اگر قوانین امنیتی خود را به نسخه ۲ ارتقا نداده باشید، متدهای موجود در API لیست با شکست مواجه می‌شوند. اگر این خطا را مشاهده کردید، قوانین امنیتی خود را ارتقا دهید:

Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.

سایر خطاهای احتمالی ممکن است نشان دهنده این باشد که کاربر مجوزهای لازم را ندارد. اطلاعات بیشتر در مورد خطاها را می‌توانید در بخش «مدیریت خطاها» بیابید.