Cloud Storage की मदद से, Apple प्लैटफ़ॉर्म पर फ़ाइलों की सूची बनाना

Cloud Storage for Firebase की मदद से, आपके Cloud Storage बकेट में मौजूद कॉन्टेंट की सूची देखी जा सकती है. एसडीके, मौजूदा Cloud Storage रेफ़रंस के तहत आने वाले ऑब्जेक्ट के आइटम और प्रीफ़िक्स , दोनों दिखाते हैं.

list API का इस्तेमाल करने वाले प्रोजेक्ट के लिए, 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() फ़ाइल को आइटम के तौर पर दिखाएगा.

Cloud Storage for Firebase SDK, ऑब्जेक्ट के ऐसे पाथ नहीं दिखाता जिनमें दो बार लगातार / का इस्तेमाल किया गया हो या जो /. से खत्म होते हों. उदाहरण के लिए, मान लें कि किसी बकेट में ये ऑब्जेक्ट मौजूद हैं:

  • 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:) API, नतीजों की संख्या पर सीमा लगाता है. 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 में अपग्रेड नहीं किया है, तो list API के तरीके काम नहीं करेंगे. अगर आपको यह गड़बड़ी दिखती है, तो सुरक्षा के नियमों को अपग्रेड करें:

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

अन्य गड़बड़ियों से पता चल सकता है कि उपयोगकर्ता के पास सही अनुमतियां नहीं हैं. गड़बड़ियों के बारे में ज़्यादा जानकारी, गड़बड़ियां ठीक करना लेख में मिल सकती है.