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

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 เราใช้ / เป็นตัวคั่น ซึ่งช่วยให้เรา จำลองความหมายของระบบไฟล์ได้ List API จะแสดงคำนำหน้าและรายการแยกกันเพื่อให้การข้ามผ่านCloud Storageที่เก็บข้อมูลขนาดใหญ่แบบลำดับชั้นมีประสิทธิภาพ เช่น หากคุณอัปโหลดไฟล์ 1 ไฟล์ /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/

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

  • การดำเนินการกับรายการที่รูทจะแสดงการอ้างอิงถึง correctPrefix, wrongPrefix และ lonelyItem เป็น prefixes
  • การดำเนินการกับรายการที่ correctPrefix/ จะแสดงผลการอ้างอิงถึง correctPrefix/happyItem เป็น items
  • การดำเนินการกับรายการที่ wrongPrefix/ ไม่แสดงการอ้างอิงใดๆ เนื่องจาก wrongPrefix//sadItem มี / 2 รายการติดต่อกัน
  • การดำเนินการกับรายการที่ 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 {
  // ...
}
ViewController.swift

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.
  }
}];
ViewController.m

แบ่งหน้าผลลัพธ์รายการ

list(withMaxResults:completion:) API จะจำกัดจำนวนผลลัพธ์ที่แสดง 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)
  }
}
ViewController.swift

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];
  }
}
ViewController.m

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

เมธอดใน List 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.

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