בדף הזה מוסבר איך להשתמש ב-SDK של Cloud Storage for Firebase כדי להציג את התוכן של קטגוריית Cloud Storage. ה-SDK מחזיר גם את הפריטים וגם את הקידומות של האובייקטים בהפניה הנוכחית ל-Cloud Storage.
בפרויקטים שמשתמשים ב-API של הרשימה, נדרשת גרסה 2 של כללי Cloud Storage for Firebase. אם יש לכם פרויקט Firebase קיים, פעלו לפי השלבים במדריך לכללי אבטחה.
list() משתמש ב-Google Cloud Storage List API.
Cloud Storage for Firebase משתמש ב-/ כמפריד, שמאפשר לדמות סמנטיקה של מערכת קבצים. כדי לאפשר מעבר יעיל בין קטגוריות גדולות והיררכיות של Cloud Storage, ה-API של List מחזיר קידומות ופריטים בנפרד. לדוגמה, אם מעלים קובץ אחד /images/uid/file1,
- הפונקציה
root.child('images').listAll()תחזיר את/images/uidבתור קידומת. -
root.child('images/uid').listAll()תחזיר את הקובץ כפריט.
ערכת ה-SDK של Cloud Storage for Firebase לא מחזירה נתיבי אובייקטים שמכילים שני תווים עוקבים של / או מסתיימים ב-/.. לדוגמה, נניח שיש קטגוריה עם האובייקטים הבאים:
correctPrefix/happyItemwrongPrefix//sadItemlonelyItem/
פעולות הרשימה על פריטים בקטגוריה הזו יניבו את התוצאות הבאות:
- פעולת הרשימה ברמה הבסיסית (root) מחזירה את ההפניות אל
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. } }];
חלוקה של תוצאות הרשימה לדפים
ב-API של 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]; } }
טיפול בשגיאות
השיטות ב-API של הרשימה ייכשלו אם לא תשדרגו את כללי האבטחה לגרסה 2. אם השגיאה הזו מופיעה, צריך לשדרג את כללי האבטחה:
Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.
שגיאות אפשריות אחרות יכולות להצביע על כך שלמשתמש אין את ההרשאות המתאימות. למידע נוסף על שגיאות, ראו טיפול בשגיאות.