Cloud Storage for Firebase की मदद से, अपनी Cloud Storage बकेट के कॉन्टेंट की सूची देखी जा सकती है. SDK, मौजूदा 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:)
एपीआई, दिखाए जाने वाले नतीजों की संख्या पर पाबंदी लगाता है. 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]; } }
गड़बड़ियां ठीक करना
अगर आपने सुरक्षा नियमों को दूसरे वर्शन पर अपग्रेड नहीं किया है, तो सूची एपीआई के तरीके काम नहीं करेंगे. अगर आपको यह गड़बड़ी दिखती है, तो सुरक्षा के नियमों को अपग्रेड करें:
Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.
अन्य संभावित गड़बड़ियों से पता चल सकता है कि उपयोगकर्ता के पास सही अनुमतियां नहीं हैं. गड़बड़ियों के बारे में ज़्यादा जानकारी पाने के लिए, गड़बड़ियों को मैनेज करना लेख पढ़ें.