Liệt kê các tệp bằng Cloud Storage trên Flutter

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

Các dự án sử dụng List API yêu cầu Cloud Storage cho Quy tắc Firebase 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 cho Firebase, chúng tôi sử dụng / làm dấu phân cách, cho phép chúng tôi mô phỏng ngữ nghĩa của hệ thống tệp. Để cho phép duyệt qua các bộ chứa Cloud Storage lớn, có phân cấp một cách hiệu quả, List API sẽ 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 cho 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 vùng chứa có các đối tượng sau:

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

Các thao tác liệt kê trên các mục trong nhóm này sẽ cho ra kết quả như sau:

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

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

Bạn có thể dùng listAll để tìm nạp tất cả kết quả cho một thư mục. Phương thức này phù hợp nhất với các thư mục nhỏ vì tất cả kết quả đều được lưu vào bộ nhớ đệm. 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 hoặc 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() được phân trang vì listAll() sẽ đệm tất cả kết quả trong bộ nhớ.

Ví dụ sau đây minh hoạ listAll.

final storageRef = FirebaseStorage.instance.ref().child("files/uid");
final listResult = await storageRef.listAll();
for (var prefix in listResult.prefixes) {
  // The prefixes under storageRef.
  // You can call listAll() recursively on them.
}
for (var item in listResult.items) {
  // The items under storageRef.
}

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

API list() giới hạn số lượng kết quả mà API này trả về. list() cung cấp một lượt 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 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 một yêu cầu tiếp theo bằng pageToken, các mục xuất hiện sau pageToken sẽ được hiển thị.

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

Stream<ListResult> listAllPaginated(Reference storageRef) async* {
  String? pageToken;
  do {
    final listResult = await storageRef.list(ListOptions(
      maxResults: 100,
      pageToken: pageToken,
    ));
    yield listResult;
    pageToken = listResult.nextPageToken;
  } while (pageToken != null);
}

Xử lý lỗi

list() và listAll() sẽ không hoạt động nếu bạn chưa nâng cấp Quy tắc bảo mật lên phiên bản 2. 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 có thể xảy ra khác có thể cho biết người dùng không có quyền phù hợp. Bạn có thể xem thêm thông tin về các lỗi trên trang Xử lý lỗi.