แสดงรายการไฟล์ด้วย Cloud Storage บนแพลตฟอร์ม Apple

Cloud Storage for Firebase ช่วยให้คุณแสดงรายการเนื้อหาของที่เก็บข้อมูล Cloud Storage ของคุณได้ SDK ส่งคืนทั้งรายการและคำนำหน้าของออบเจ็กต์ภายใต้การอ้างอิง Cloud Storage ปัจจุบัน

โปรเจ็กต์ที่ใช้ API รายการต้องใช้ Cloud Storage สำหรับกฎ Firebase เวอร์ชัน 2 หากคุณมีโปรเจ็กต์ Firebase อยู่แล้ว ให้ทำตามขั้นตอนใน คำแนะนำเกี่ยวกับกฎความปลอดภัย

list() ใช้ Google Cloud Storage List API ใน Cloud Storage สำหรับ Firebase เราใช้ / เป็นตัวคั่น ซึ่งช่วยให้เราจำลองความหมายของระบบไฟล์ได้ เพื่อให้การข้ามผ่านที่เก็บข้อมูล Cloud Storage ขนาดใหญ่ที่มีลำดับชั้นมีประสิทธิภาพ List API จะส่งคืนคำนำหน้าและรายการแยกกัน ตัวอย่างเช่น หากคุณอัปโหลดหนึ่งไฟล์ /images/uid/file1

  • root.child('images').listAll() จะส่งคืน /images/uid เป็นคำนำหน้า
  • root.child('images/uid').listAll() จะส่งคืนไฟล์เป็นรายการ

Cloud Storage for Firebase SDK จะไม่ส่งคืนเส้นทางออบเจ็กต์ที่มี / 2 รายการติดต่อกันหรือลงท้ายด้วย /. . ตัวอย่างเช่น พิจารณาที่เก็บข้อมูลที่มีออบเจ็กต์ต่อไปนี้:

  • correctPrefix/happyItem
  • wrongPrefix//sadItem
  • lonelyItem/

การดำเนินการรายการกับรายการในที่เก็บข้อมูลนี้จะให้ผลลัพธ์ดังต่อไปนี้:

  • การดำเนินการรายการที่ root ส่งคืนการอ้างอิงไปยัง correctPrefix , wrongPrefix และ lonelyItem เป็น prefixes
  • การดำเนินการรายการที่ correctPrefix/ ส่งคืนการอ้างอิงไปยัง correctPrefix/happyItem เป็น items
  • การดำเนินการรายการที่ wrongPrefix/ จะไม่ส่งคืนการอ้างอิงใดๆ เนื่องจาก wrongPrefix//sadItem มีสอง / s ติดต่อกัน
  • การดำเนินการรายการที่ lonelyItem/ จะไม่ส่งคืนการอ้างอิงใดๆ เนื่องจากอ็อบเจ็กต์ lonelyItem/ ลงท้ายด้วย /

แสดงรายการไฟล์ทั้งหมด

คุณสามารถใช้ listAll(completion:) เพื่อดึงผลลัพธ์ทั้งหมดสำหรับไดเร็กทอรี วิธีนี้เหมาะที่สุดสำหรับไดเร็กทอรีขนาดเล็ก เนื่องจากผลลัพธ์ทั้งหมดถูกบัฟเฟอร์ไว้ในหน่วยความจำ การดำเนินการอาจไม่ส่งคืนสแน็ปช็อตที่สอดคล้องกันหากมีการเพิ่มหรือลบออบเจ็กต์ในระหว่างกระบวนการ

สำหรับรายการขนาดใหญ่ ให้ใช้เมธอด list(withMaxResults:completion:) แบบแบ่งหน้า เนื่องจาก listAll(completion:) บัฟเฟอร์ผลลัพธ์ทั้งหมดอยู่ในหน่วยความจำ

ตัวอย่างต่อไปนี้แสดงให้เห็นถึง listAll(completion:)

สวิฟท์

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 {
  // ...
}
ViewController.swift

วัตถุประสงค์-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.
  }
}];
ViewController.m

ผลลัพธ์รายการเลขหน้า

list(withMaxResults:completion:) API กำหนดขีดจำกัดจำนวนผลลัพธ์ที่ส่งคืน list(withMaxResults:completion) ให้การดูหน้าเว็บที่สอดคล้องกันและเปิดเผย pageToken ที่อนุญาตให้ควบคุมได้ว่าเมื่อใดที่จะดึงผลลัพธ์เพิ่มเติม

pageToken เข้ารหัสเส้นทางและเวอร์ชันของรายการสุดท้ายที่ส่งคืนในผลลัพธ์ก่อนหน้า ในคำขอครั้งถัดไปที่ใช้ pageToken รายการที่ตามมาหลัง pageToken จะแสดงขึ้น

ตัวอย่างต่อไปนี้แสดงให้เห็นถึงการแบ่งหน้าผลลัพธ์:

สวิฟท์

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)
  }
}
ViewController.swift

วัตถุประสงค์-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];
  }
}
ViewController.m

จัดการกับข้อผิดพลาด

วิธีการในรายการ 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.

ข้อผิดพลาดอื่นๆ ที่เป็นไปได้อาจบ่งชี้ว่าผู้ใช้ไม่มีสิทธิ์ที่ถูกต้อง ข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดสามารถพบได้ใน Handle Errors