Liệt kê tệp có Cloud Storage trên các nền tảng của Apple

Cloud Storage for Firebase cho phép bạn liệt kê nội dung của bộ chứa Cloud Storage. SDK trả về cả các mục và tiền tố của đối tượng trong tệp tham chiếu Cloud Storage hiện tại.

Các dự án sử dụng API danh sách yêu cầu Cloud Storage for Firebase Quy tắc phiên bản 2. Nếu bạn đang có một dự án Firebase, hãy làm theo các bước trong Hướng dẫn về quy tắc bảo mật.

list() sử dụng Google Cloud Storage List API. Trong Cloud Storage for Firebase, chúng ta sử dụng / làm dấu phân cách, cho phép mô phỏng ngữ nghĩa hệ thống tệp. Để cho phép duyệt qua các bộ chứa Cloud Storage lớn, phân cấp một cách hiệu quả, List API trả về các tiền tố và mục riêng biệt. Ví dụ: nếu bạn tải một tệp /images/uid/file1 lên,

  • root.child('images').listAll() sẽ trả về /images/uid dưới dạng tiền tố.
  • root.child('images/uid').listAll() sẽ trả về tệp dưới dạng một mục.

SDK Cloud Storage for Firebase không trả về các đường dẫn đối tượng chứa hai / liên tiếp hoặc kết thúc bằng /.. Ví dụ: hãy xem xét một bộ chứa có các đối tượng sau:

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

Thao tác danh sách trên các mục trong bộ chứa này sẽ cho ra kết quả như sau:

  • Thao tác danh sách ở gốc trả về các tệp tham chiếu đến correctPrefix, wrongPrefix và lonelyItem dưới dạng prefixes.
  • Thao tác danh sách tại correctPrefix/ trả về các tệp tham chiếu đến correctPrefix/happyItem dưới dạng items.
  • Thao tác danh sách tại wrongPrefix/ không trả về bất kỳ tham chiếu nào vì wrongPrefix//sadItem chứa hai / liên tiếp.
  • Thao tác danh sách tại lonelyItem/ không trả về bất kỳ tham chiếu nào vì đối tượng lonelyItem/ kết thúc bằng /.

Liệt kê tất cả tệp

Bạn có thể sử dụng listAll(completion:) để tìm nạp tất cả kết quả cho một thư mục. Bạn nên sử dụng cách này tốt nhất cho các thư mục nhỏ vì tất cả kết quả đều được lưu vào vùng đệm trong bộ nhớ. Thao tác này cũng có thể không trả về một ảnh chụp nhanh nhất quán nếu các đối tượng được thêm vào hoặc bị xoá trong quá trình này.

Đối với danh sách lớn, hãy sử dụng phương thức list(withMaxResults:completion:) được phân trang vì listAll(completion:) sẽ lưu tất cả kết quả vào bộ đệm trong bộ nhớ.

Ví dụ sau minh hoạ 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

Phân trang kết quả danh sách

API list(withMaxResults:completion:) đặt ra giới hạn về số lượng kết quả trả về. list(withMaxResults:completion) cung cấp một chế độ xem trang nhất quán và hiển thị một pageToken cho phép kiểm soát thời điểm tìm nạp các kết quả bổ sung.

pageToken mã hoá đường dẫn và phiên bản của mục cuối cùng được trả về trong kết quả trước đó. Trong yêu cầu tiếp theo sử dụng pageToken, các mục sau pageToken sẽ xuất hiện.

Ví dụ sau đây minh hoạ việc phân trang kết quả:

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

Xử lý lỗi

Các phương thức trong API danh sách sẽ không thực hiện được nếu bạn chưa nâng cấp Quy tắc bảo mật lên phiên bản 2. Hãy nâng cấp Quy tắc bảo mật nếu bạn thấy lỗi này:

Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.

Các lỗi khác có thể cho biết người dùng không có quyền thích hợp. Bạn có thể xem thêm thông tin về lỗi trong phần Xử lý lỗi.