إدراج الملفات في Cloud Storage على منصات Apple

توضّح هذه الصفحة كيفية استخدام حزمة تطوير البرامج (SDK) لـ Cloud Storage for Firebase من أجل عرض محتوى حزمة Cloud Storage. تعرض حزمة SDK كلاً من العناصر والبادئات الخاصة بالكائنات ضمن مرجع Cloud Storage الحالي.

تتطلّب المشاريع التي تستخدم واجهة برمجة التطبيقات list API الإصدار 2 من Cloud Storage for Firebase Rules. إذا كان لديك مشروع حالي على Firebase، اتّبِع الخطوات الواردة في دليل قواعد الأمان.

يستخدم "list()" واجهة برمجة التطبيقات الخاصة بقائمة "Google Cloud Storage". يستخدم Cloud Storage for Firebase الرمز / كمحدِّد، ما يتيح لك محاكاة دلالات نظام الملفات. للسماح بالانتقال الفعّال بين حِزم Cloud Storage الهرمية الكبيرة، تعرض واجهة برمجة التطبيقات List 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:) لجلب جميع النتائج لدليل معيّن. يُفضَّل استخدام هذا الخيار مع الأدلة الصغيرة لأنّ جميع النتائج يتم تخزينها مؤقتًا في الذاكرة. قد لا تعرض العملية أيضًا لقطة متسقة إذا تمت إضافة كائنات أو إزالتها أثناء العملية.

بالنسبة إلى القوائم الكبيرة، استخدِم طريقة list(withMaxResults:completion:) المقسّمة إلى صفحات لأنّ listAll(completion:) تخزّن جميع النتائج مؤقتًا في الذاكرة.

يوضّح المثال التالي listAll(completion:).

Swift

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 {
  // ...
}

Objective-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.
  }
}];

تقسيم نتائج القائمة إلى صفحات

تضع واجهة برمجة التطبيقات list(withMaxResults:completion:) حدًا لعدد النتائج التي تعرضها. توفر السمة list(withMaxResults:completion) طريقة عرض متّسقة لمشاهدة صفحة على الويب وتعرض pageToken يتيح التحكّم في وقت استرجاع النتائج الإضافية.

يرمّز pageToken المسار والإصدار لآخر عنصر تم عرضه في النتيجة السابقة. في طلب لاحق باستخدام pageToken، يتم عرض العناصر التي تأتي بعد pageToken.

يوضّح المثال التالي كيفية تقسيم نتيجة إلى صفحات:

Swift

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)
  }
}

Objective-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];
  }
}

معالجة الأخطاء

ستتعذّر الطُرق في واجهة برمجة التطبيقات الخاصة بالقائمة إذا لم تتم ترقية قواعد الأمان إلى الإصدار 2. يُرجى ترقية "قواعد الأمان" إذا ظهر لك هذا الخطأ:

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

قد تشير الأخطاء المحتملة الأخرى إلى أنّ المستخدم ليس لديه الأذونات الصحيحة. لمزيد من المعلومات حول الأخطاء، يُرجى الاطّلاع على معالجة الأخطاء.