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

تتيح لك خدمة Cloud Storage for Firebase إمكانية سرد محتويات حزمة Cloud Storage تعرض حِزم تطوير البرامج (SDK) كلاً من العناصر والبادئات من العناصر ضمن مرجع Cloud Storage الحالي

تتطلّب المشاريع التي تستخدم List API توفّر Cloud Storage for Firebase. الإصدار 2 من القواعد إذا كان لديك مشروع حالي على 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.

قد تشير الأخطاء المحتملة الأخرى إلى أن المستخدم لا يملك الأذونات الصحيحة. يمكن العثور على مزيد من المعلومات حول الأخطاء في التعامل مع الأخطاء: