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

يتيح لك Cloud Storage for Firebase إدراج محتوى حزمة Cloud Storage. تعرض حِزم SDK كلاً من العناصر وبادئات العناصر ضمن مرجع Cloud Storage الحالي.

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

تستخدم list() Google Cloud Storage List API. في 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.

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