在 Android 上使用 Cloud Storage 列出檔案

Cloud Storage for Firebase 可讓您列出 Cloud Storage 值區的內容。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/ 的清單作業不會傳回任何參照，因為 wrongPrefix//sadItem 包含兩個連續的 /。
  • lonelyItem/ 的清單作業不會傳回任何參照，因為物件 lonelyItem/ 的結尾是 /。

列出所有檔案

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

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

以下範例示範 listAll。

Kotlin

val storage = Firebase.storage
val listRef = storage.reference.child("files/uid")

// You'll need to import com.google.firebase.storage.component1 and
// com.google.firebase.storage.component2
listRef.listAll()
    .addOnSuccessListener { (items, prefixes) ->
        for (prefix in prefixes) {
            // All the prefixes under listRef.
            // You may call listAll() recursively on them.
        }

        for (item in items) {
            // All the items under listRef.
        }
    }
    .addOnFailureListener {
        // Uh-oh, an error occurred!
    }

Java

StorageReference listRef = storage.getReference().child("files/uid");

listRef.listAll()
        .addOnSuccessListener(new OnSuccessListener<ListResult>() {
            @Override
            public void onSuccess(ListResult listResult) {
                for (StorageReference prefix : listResult.getPrefixes()) {
                    // All the prefixes under listRef.
                    // You may call listAll() recursively on them.
                }

                for (StorageReference item : listResult.getItems()) {
                    // All the items under listRef.
                }
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Uh-oh, an error occurred!
            }
        });

將清單結果分頁

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

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

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

Kotlin

fun listAllPaginated(pageToken: String?) {
    val storage = Firebase.storage
    val listRef = storage.reference.child("files/uid")

    // Fetch the next page of results, using the pageToken if we have one.
    val listPageTask = if (pageToken != null) {
        listRef.list(100, pageToken)
    } else {
        listRef.list(100)
    }

    // You'll need to import com.google.firebase.storage.component1 and
    // com.google.firebase.storage.component2
    listPageTask
        .addOnSuccessListener { (items, prefixes, pageToken) ->
            // Process page of results
            processResults(items, prefixes)

            // Recurse onto next page
            pageToken?.let {
                listAllPaginated(it)
            }
        }.addOnFailureListener {
            // Uh-oh, an error occurred.
        }
}

Java

public void listAllPaginated(@Nullable String pageToken) {
    FirebaseStorage storage = FirebaseStorage.getInstance();
    StorageReference listRef = storage.getReference().child("files/uid");

    // Fetch the next page of results, using the pageToken if we have one.
    Task<ListResult> listPageTask = pageToken != null
            ? listRef.list(100, pageToken)
            : listRef.list(100);

    listPageTask
            .addOnSuccessListener(new OnSuccessListener<ListResult>() {
                @Override
                public void onSuccess(ListResult listResult) {
                    List<StorageReference> prefixes = listResult.getPrefixes();
                    List<StorageReference> items = listResult.getItems();

                    // Process page of results
                    // ...

                    // Recurse onto next page
                    if (listResult.getPageToken() != null) {
                        listAllPaginated(listResult.getPageToken());
                    }
                }
            }).addOnFailureListener(new OnFailureListener() {
                @Override
                public void onFailure(@NonNull Exception e) {
                    // Uh-oh, an error occurred.
                }
            });
}

處理錯誤

如果未將安全性規則升級至第 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.

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