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

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

โปรเจ็กต์ที่ใช้ API รายการต้องใช้ Cloud Storage for Firebase กฎเวอร์ชัน 2 หากมีโปรเจ็กต์ Firebase อยู่แล้ว ให้ทําตามขั้นตอนในคู่มือกฎการรักษาความปลอดภัย

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

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

SDK ของ Cloud Storage for Firebase จะไม่แสดงผลเส้นทางออบเจ็กต์ที่มี / 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) ให้ Pageview ที่สอดคล้องกันและแสดง 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

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

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

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