在 Apple 平台上使用 Cloud Storage 列出檔案

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 中，我們使用 / 做為分隔符，藉此模擬檔案系統語意。為有效遍歷大型階層式 Cloud Storage bucket，List API 會分別傳回前置字元和項目。舉例來說，如果您上傳一個檔案 /images/uid/file1，

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

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

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

對這個值區中的項目執行清單作業時，會得到下列結果：

  • 根層級的清單作業會傳回 correctPrefix、wrongPrefix 和 lonelyItem 的參照，做為 prefixes。
  • correctPrefix/ 的清單作業會將 correctPrefix/happyItem 的參照傳回為 items。
  • wrongPrefix/ 的清單作業不會傳回任何參照，因為 wrongPrefix//sadItem 包含兩個連續的 /。
  • 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

處理錯誤

如果尚未將安全規則升級至第 2 版，清單 API 中的方法就會失敗。如果看到這項錯誤，請升級安全性規則：

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

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