在 Flutter 中使用 Cloud Storage 列出檔案

您可以使用 Cloud Storage for Firebase 列出 Cloud Storage bucket 的內容。SDK 會傳回目前 Cloud Storage 參照下的物件項目和前置字元。

使用 List API 的專案必須採用 Cloud Storage for Firebase 規則第 2 版。如果您已有 Firebase 專案，請按照安全性規則指南中的步驟操作。

list() 使用 Google Cloud Storage List API。在 Cloud Storage for Firebase 中，我們使用 / 做為分隔符號，藉此模擬檔案系統語意。為有效率地遍歷大型階層式 Cloud Storage bucket，List API 會分別傳回前置字元和項目。舉例來說，如果您上傳一個檔案 /images/uid/file1，

  • root.child('images').listAll() 會傳回 /images/uid 做為前置字串。
  • root.child('images/uid').listAll() 會將檔案做為項目傳回。

Cloud Storage for Firebase SDK 不會傳回含有兩個連續 / 或以 / 結尾的物件路徑。舉例來說，假設某個 bucket 包含下列物件：

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

對這個 bucket 中的項目執行清單作業時，會產生下列結果：

  • 根層級的清單作業會傳回 correctPrefix、wrongPrefix 和 lonelyItem 的參照，做為 prefixes。
  • correctPrefix/ 的清單作業會傳回 correctPrefix/happyItem 的參照，做為 items。
  • 由於 wrongPrefix//sadItem 包含兩個連續的 /，因此 wrongPrefix/ 的清單作業不會傳回任何參照。
  • lonelyItem/ 的清單作業不會傳回任何參照，因為物件 lonelyItem/ 會以 / 結尾。

列出所有檔案

您可以使用 listAll 擷取目錄的所有結果。 這項功能最適合用於小型目錄，因為所有結果都會緩衝處理到記憶體中。 如果在作業期間新增或移除物件，作業也可能無法傳回一致的快照。

如要處理大型清單，請使用分頁 list() 方法，因為 listAll() 會將所有結果緩衝處理至記憶體。

以下範例會示範 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.
}

將清單結果分頁

list() API 會限制傳回的結果數量。list() 提供一致的網頁瀏覽，並公開 pageToken，方便控制何時要擷取其他結果。

pageToken 會編碼先前結果中傳回的最後一個項目的路徑和版本。在後續使用 pageToken 的要求中，系統會顯示 pageToken 之後的項目。

以下範例說明如何將結果分頁：

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);
}

處理錯誤

如果尚未將安全性規則升級至第 2 版，list() 和 listAll() 就會失敗。如果看到下列錯誤，請升級安全性規則：

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

其他可能發生的錯誤可能表示使用者沒有適當的權限。如要進一步瞭解錯誤，請參閱「處理錯誤」頁面。