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

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

پروژه‌هایی که از فهرست API استفاده می‌کنند، نیازمند فضای ذخیره‌سازی ابری برای قوانین 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(completion:) برای واکشی همه نتایج برای یک فهرست استفاده کنید. این به بهترین وجه برای دایرکتوری های کوچک استفاده می شود زیرا همه نتایج در حافظه بافر هستند. اگر اشیا در طول فرآیند اضافه یا حذف شوند، ممکن است این عملیات یک عکس فوری ثابت را برگرداند.

برای یک لیست بزرگ، از روش 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

هدف-C

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:) API محدودیتی برای تعداد نتایجی که برمی گرداند ایجاد می کند. 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

هدف-C

- (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

رسیدگی به خطاها

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

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 بیابید.