Dateien mit Cloud Storage im Web auflisten

Mit Cloud Storage for Firebase können Sie den Inhalt Ihres Cloud Storage-Buckets auflisten. Die SDKs geben sowohl die Elemente als auch die Präfixe von Objekten unter der aktuellen Cloud Storage-Referenz zurück.

Projekte, die die List API verwenden, erfordern Cloud Storage for Firebase Rules Version 2. Wenn Sie bereits ein Firebase-Projekt haben, folgen Sie der Anleitung im Leitfaden zu Sicherheitsregeln.

list() verwendet die Google Cloud Storage List API. In Cloud Storage for Firebase verwenden wir / als Trennzeichen, um die Semantik des Dateisystems zu emulieren. Damit große, hierarchische Cloud Storage-Buckets effizient durchlaufen werden können, gibt die List API Präfixe und Elemente separat zurück. Wenn Sie beispielsweise eine Datei /images/uid/file1 hochladen,

  • root.child('images').listAll() gibt /images/uid als Präfix zurück.
  • root.child('images/uid').listAll() gibt die Datei als Element zurück.

Das Cloud Storage for Firebase SDK gibt keine Objektpfade zurück, die zwei aufeinanderfolgende /s enthalten oder mit einem /. enden. Betrachten Sie beispielsweise einen Bucket mit den folgenden Objekten:

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

Die Listenvorgänge für Elemente in diesem Bucket liefern die folgenden Ergebnisse:

  • Der Listenvorgang im Stammverzeichnis gibt die Verweise auf correctPrefix, wrongPrefix und lonelyItem als prefixes zurück.
  • Der Auflistungsvorgang unter correctPrefix/ gibt die Verweise auf correctPrefix/happyItem als items zurück.
  • Der Listenvorgang bei wrongPrefix/ gibt keine Referenzen zurück, da wrongPrefix//sadItem zwei aufeinanderfolgende /s enthält.
  • Der Listenvorgang unter lonelyItem/ gibt keine Referenzen zurück, da das Objekt lonelyItem/ mit / endet.

Alle Dateien auflisten

Mit listAll können Sie alle Ergebnisse für ein Verzeichnis abrufen. Diese Methode eignet sich am besten für kleine Verzeichnisse, da alle Ergebnisse im Arbeitsspeicher gepuffert werden. Der Vorgang gibt möglicherweise auch keinen konsistenten Snapshot zurück, wenn während des Vorgangs Objekte hinzugefügt oder entfernt werden.

Verwenden Sie für eine große Liste die paginierte Methode list(), da listAll() alle Ergebnisse im Arbeitsspeicher puffert.

Im folgenden Beispiel wird listAll veranschaulicht.

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

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

Listenergebnisse paginieren

Die list() API begrenzt die Anzahl der zurückgegebenen Ergebnisse. list() bietet eine einheitliche Seitenansicht und stellt ein pageToken bereit, mit dem Sie steuern können, wann zusätzliche Ergebnisse abgerufen werden.

Das pageToken codiert den Pfad und die Version des letzten Elements, das im vorherigen Ergebnis zurückgegeben wurde. In einer nachfolgenden Anfrage mit dem pageToken werden Elemente angezeigt, die nach dem pageToken kommen.

Im folgenden Beispiel wird die Paginierung eines Ergebnisses mit async/await veranschaulicht.

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

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

Fehler verarbeiten

list() und listAll() geben ein abgelehntes Promise zurück, wenn Sie die Sicherheitsregeln nicht auf Version 2 aktualisiert haben. Aktualisieren Sie Ihre Sicherheitsregeln, wenn Sie diesen Fehler sehen:

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

Andere mögliche Fehler können darauf hindeuten, dass der Nutzer nicht die erforderliche Berechtigung hat. Weitere Informationen zu Fehlern finden Sie unter Fehler verarbeiten.