使用網頁版 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 桶，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 擷取目錄的所有結果。由於所有結果都會在記憶體中緩衝，因此這項方法最適合用於小型目錄。如果在程序中新增或移除物件，作業也可能不會傳回一致的快照。

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

以下範例說明 listAll。

Web

import { getStorage, ref, listAll } from "firebase/storage";

const storage = getStorage();

// Create a reference under which you want to list
const listRef = ref(storage, 'files/uid');

// Find all the prefixes and items.
listAll(listRef)
  .then((res) => {
    res.prefixes.forEach((folderRef) => {
      // All the prefixes under listRef.
      // You may call listAll() recursively on them.
    });
    res.items.forEach((itemRef) => {
      // All the items under listRef.
    });
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
storage_list_all.js

Web

// Create a reference under which you want to list
var listRef = storageRef.child('files/uid');

// Find all the prefixes and items.
listRef.listAll()
  .then((res) => {
    res.prefixes.forEach((folderRef) => {
      // All the prefixes under listRef.
      // You may call listAll() recursively on them.
    });
    res.items.forEach((itemRef) => {
      // All the items under listRef.
    });
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
list-files.js

分頁列出結果

list() API 會對傳回的結果數量設限。list() 會提供一致的網頁檢視畫面，並公開 pageToken，讓您控制擷取其他結果的時間。

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

以下範例說明如何使用 async/await 分頁顯示結果。

Web

import { getStorage, ref, list } from "firebase/storage";

async function pageTokenExample(){
  // Create a reference under which you want to list
  const storage = getStorage();
  const listRef = ref(storage, 'files/uid');

  // Fetch the first page of 100.
  const firstPage = await list(listRef, { maxResults: 100 });

  // Use the result.
  // processItems(firstPage.items)
  // processPrefixes(firstPage.prefixes)

  // Fetch the second page if there are more elements.
  if (firstPage.nextPageToken) {
    const secondPage = await list(listRef, {
      maxResults: 100,
      pageToken: firstPage.nextPageToken,
    });
    // processItems(secondPage.items)
    // processPrefixes(secondPage.prefixes)
  }
}
storage_list_paginate.js

Web

async function pageTokenExample(){
  // Create a reference under which you want to list
  var listRef = storageRef.child('files/uid');

  // Fetch the first page of 100.
  var firstPage = await listRef.list({ maxResults: 100});

  // Use the result.
  // processItems(firstPage.items)
  // processPrefixes(firstPage.prefixes)

  // Fetch the second page if there are more elements.
  if (firstPage.nextPageToken) {
    var secondPage = await listRef.list({
      maxResults: 100,
      pageToken: firstPage.nextPageToken,
    });
    // processItems(secondPage.items)
    // processPrefixes(secondPage.prefixes)
  }
}
list-files.js

處理錯誤

如果您尚未將安全性規則升級至第 2 版，list() 和 listAll() 會傳回已遭拒的 Promise。如果您看到以下錯誤訊息，請升級安全性規則：

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

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