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
का इस्तेमाल किया जा सकता है.
इसका इस्तेमाल छोटी डायरेक्ट्री के लिए सबसे अच्छा होता है, क्योंकि सभी नतीजे मेमोरी में बफ़र किए जाते हैं.
अगर प्रोसेस के दौरान ऑब्जेक्ट जोड़े या हटाए जाते हैं, तो हो सकता है कि ऑपरेशन एक जैसा स्नैपशॉट न दिखाए.
बड़ी सूची के लिए, पेज किए गए list()
तरीके का इस्तेमाल करें, क्योंकि listAll()
सभी नतीजों को मेमोरी में बफ़र करता है.
यहां दिए गए उदाहरण में listAll
के बारे में बताया गया है.
Kotlin+KTX
val storage = Firebase.storage val listRef = storage.reference.child("files/uid") // You'll need to import com.google.firebase.storage.component1 and // com.google.firebase.storage.component2 listRef.listAll() .addOnSuccessListener { (items, prefixes) -> for (prefix in prefixes) { // All the prefixes under listRef. // You may call listAll() recursively on them. } for (item in items) { // All the items under listRef. } } .addOnFailureListener { // Uh-oh, an error occurred! }
Java
StorageReference listRef = storage.getReference().child("files/uid"); listRef.listAll() .addOnSuccessListener(new OnSuccessListener<ListResult>() { @Override public void onSuccess(ListResult listResult) { for (StorageReference prefix : listResult.getPrefixes()) { // All the prefixes under listRef. // You may call listAll() recursively on them. } for (StorageReference item : listResult.getItems()) { // All the items under listRef. } } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Uh-oh, an error occurred! } });
सूची के नतीजों को पेज के हिसाब से बांटना
list()
एपीआई, नतीजे दिखाने की सीमा तय करता है. list()
एक जैसा पेज व्यू उपलब्ध कराता है और एक पेज टोकन दिखाता है. इससे, अतिरिक्त नतीजे फ़ेच करने के समय को कंट्रोल किया जा सकता है.
pageToken, पिछले नतीजे में दिखाए गए आखिरी आइटम के पाथ और वर्शन को कोड में बदलता है. pageToken का इस्तेमाल करके किए गए अगले अनुरोध में, pageToken के बाद आने वाले आइटम दिखाए जाते हैं.
यहां दिए गए उदाहरण में, नतीजे को पेज के हिसाब से बांटने का तरीका बताया गया है:
Kotlin+KTX
fun listAllPaginated(pageToken: String?) { val storage = Firebase.storage val listRef = storage.reference.child("files/uid") // Fetch the next page of results, using the pageToken if we have one. val listPageTask = if (pageToken != null) { listRef.list(100, pageToken) } else { listRef.list(100) } // You'll need to import com.google.firebase.storage.component1 and // com.google.firebase.storage.component2 listPageTask .addOnSuccessListener { (items, prefixes, pageToken) -> // Process page of results processResults(items, prefixes) // Recurse onto next page pageToken?.let { listAllPaginated(it) } }.addOnFailureListener { // Uh-oh, an error occurred. } }
Java
public void listAllPaginated(@Nullable String pageToken) { FirebaseStorage storage = FirebaseStorage.getInstance(); StorageReference listRef = storage.getReference().child("files/uid"); // Fetch the next page of results, using the pageToken if we have one. Task<ListResult> listPageTask = pageToken != null ? listRef.list(100, pageToken) : listRef.list(100); listPageTask .addOnSuccessListener(new OnSuccessListener<ListResult>() { @Override public void onSuccess(ListResult listResult) { List<StorageReference> prefixes = listResult.getPrefixes(); List<StorageReference> items = listResult.getItems(); // Process page of results // ... // Recurse onto next page if (listResult.getPageToken() != null) { listAllPaginated(listResult.getPageToken()); } } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Uh-oh, an error occurred. } }); }
गड़बड़ियां ठीक करना
अगर आपने सुरक्षा नियमों को वर्शन 2 पर अपग्रेड नहीं किया है, तो list()
और listAll()
काम नहीं करेंगे. अगर आपको यह गड़बड़ी दिखती है, तो सुरक्षा के नियमों को अपग्रेड करें:
Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.
अन्य गड़बड़ियों का यह मतलब हो सकता है कि लोगों के पास सही अनुमति नहीं है. गड़बड़ियों के बारे में ज़्यादा जानकारी पाने के लिए, गड़बड़ियों को मैनेज करना लेख पढ़ें.