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

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

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

تستخدِم list() واجهة برمجة التطبيقات Google Cloud Storage List API. في Cloud Storage for Firebase، نستخدم / كمحدِّد، ما يسمح لنا بـ محاكاة دلالات نظام الملفات. للسماح بالتنقّل بكفاءة في نطاقات Cloud Storage الكبيرة ذات التسلسل الهرمي، تعرض واجهة برمجة التطبيقات List API البادئات والعناصر بشكل منفصل.Cloud Storage على سبيل المثال، إذا حمّلت ملفًا واحدًا /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];
  }
}

التعامل مع الأخطاء

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

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

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