फायरबेस के लिए क्लाउड स्टोरेज आपको अपने क्लाउड स्टोरेज बकेट की सामग्री को सूचीबद्ध करने की अनुमति देता है। एसडीके वर्तमान क्लाउड स्टोरेज संदर्भ के तहत आइटम और ऑब्जेक्ट के उपसर्ग दोनों लौटाते हैं।
सूची एपीआई का उपयोग करने वाले प्रोजेक्टों को फायरबेस नियम संस्करण 2 के लिए क्लाउड स्टोरेज की आवश्यकता होती है। यदि आपके पास मौजूदा फायरबेस प्रोजेक्ट है, तो सुरक्षा नियम गाइड में दिए गए चरणों का पालन करें।
list() Google क्लाउड स्टोरेज सूची एपीआई का उपयोग करती है। फायरबेस के लिए क्लाउड स्टोरेज में, हम एक सीमांकक के रूप में / का उपयोग करते हैं, जो हमें फ़ाइल सिस्टम शब्दार्थ का अनुकरण करने की अनुमति देता है। बड़े, पदानुक्रमित क्लाउड स्टोरेज बकेट के कुशल ट्रैवर्सल की अनुमति देने के लिए, सूची एपीआई उपसर्ग और आइटम अलग से लौटाता है। उदाहरण के लिए, यदि आप एक फ़ाइल /images/uid/file1 अपलोड करते हैं,
-
root.child('images').listAll()उपसर्ग के रूप में/images/uidलौटाएगा। -
root.child('images/uid').listAll()फ़ाइल को एक आइटम के रूप में लौटाएगा।
फायरबेस एसडीके के लिए क्लाउड स्टोरेज उन ऑब्जेक्ट पथों को वापस नहीं लौटाता है जिनमें दो लगातार / होते हैं या / के साथ समाप्त होते हैं। उदाहरण के लिए, एक बाल्टी पर विचार करें जिसमें निम्नलिखित वस्तुएं हैं:
-
correctPrefix/happyItem -
wrongPrefix//sadItem -
lonelyItem/
इस बकेट में आइटमों पर सूची संचालन निम्नलिखित परिणाम देगा:
- रूट पर सूची ऑपरेशन
correctPrefix,wrongPrefixऔरlonelyItemके संदर्भ कोprefixesके रूप में लौटाता है। -
correctPrefix/पर सूची ऑपरेशनitemsके रूप मेंcorrectPrefix/happyItemके संदर्भ लौटाता है। -
wrongPrefix/पर सूची कार्रवाई कोई संदर्भ नहीं लौटाती क्योंकिwrongPrefix//sadItemमें लगातार दो/s शामिल हैं। -
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() एक सुसंगत पृष्ठदृश्य प्रदान करती है और एक पृष्ठटोकन को उजागर करती है जो अतिरिक्त परिणाम लाने के समय पर नियंत्रण की अनुमति देता है।
पेजटोकन पिछले परिणाम में लौटाए गए अंतिम आइटम के पथ और संस्करण को एन्कोड करता है। पेजटोकन का उपयोग करते हुए बाद के अनुरोध में, पेजटोकन के बाद आने वाले आइटम दिखाए जाते हैं।
निम्नलिखित उदाहरण परिणाम को पेजिनेट करना दर्शाता है:
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.
अन्य संभावित त्रुटियाँ यह संकेत दे सकती हैं कि उपयोगकर्ता के पास सही अनुमति नहीं है। त्रुटियों के बारे में अधिक जानकारी हैंडल एरर्स में पाई जा सकती है।