Elenca i file con Cloud Storage sul Web

Cloud Storage for Firebase ti consente di elencare i contenuti del tuo bucket Cloud Storage. Gli SDK restituiscono sia gli elementi che i prefissi degli oggetti nel riferimento Cloud Storage corrente.

I progetti che utilizzano l'API List richiedono Cloud Storage for Firebase Rules versione 2. Se disponi di un progetto Firebase esistente, segui i passaggi nella Guida alle regole di sicurezza .

list() utilizza l' API Google Cloud Storage List . In Cloud Storage for Firebase utilizziamo / come delimitatore, che ci consente di emulare la semantica del file system. Per consentire un attraversamento efficiente di bucket Cloud Storage gerarchici e di grandi dimensioni, l'API List restituisce prefissi ed elementi separatamente. Ad esempio, se carichi un file /images/uid/file1 ,

• root.child('images').listAll() restituirà /images/uid come prefisso.
• root.child('images/uid').listAll() restituirà il file come elemento.

L'SDK Cloud Storage for Firebase non restituisce percorsi di oggetti che contengono due / s consecutivi o che terminano con /. . Ad esempio, considera un bucket che contiene i seguenti oggetti:

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

Le operazioni di elenco sugli elementi in questo bucket forniranno i seguenti risultati:

• L'operazione list alla radice restituisce i riferimenti a correctPrefix , wrongPrefix e lonelyItem come prefixes .
• L'operazione di elenco in correctPrefix/ restituisce i riferimenti a correctPrefix/happyItem come items .
• L'operazione di elenco su wrongPrefix/ non restituisce alcun riferimento perché wrongPrefix//sadItem contiene due / s consecutivi.
• L'operazione di elenco su lonelyItem/ non restituisce alcun riferimento perché l'oggetto lonelyItem/ termina con / .

Elenca tutti i file

Puoi utilizzare listAll per recuperare tutti i risultati per una directory. È meglio utilizzarlo per directory di piccole dimensioni poiché tutti i risultati vengono memorizzati nel buffer. L'operazione potrebbe inoltre non restituire uno snapshot coerente se gli oggetti vengono aggiunti o rimossi durante il processo.

Per un elenco di grandi dimensioni, utilizzare il metodo impaginato list() poiché listAll() memorizza nel buffer tutti i risultati.

L'esempio seguente mostra listAll .

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

// 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

Risultati dell'elenco di impaginazione

L'API list() pone un limite al numero di risultati restituiti. list() fornisce una visualizzazione di pagina coerente ed espone un pageToken che consente il controllo su quando recuperare risultati aggiuntivi.

Il pageToken codifica il percorso e la versione dell'ultimo elemento restituito nel risultato precedente. In una richiesta successiva che utilizza pageToken, vengono visualizzati gli elementi che seguono il pageToken.

L'esempio seguente illustra l'impaginazione di un risultato utilizzando async/await .

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

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

Gestire gli errori

list() e listAll() restituiscono una promessa rifiutata se non hai aggiornato le regole di sicurezza alla versione 2. Aggiorna le tue regole di sicurezza se vedi questo errore:

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

Altri possibili errori potrebbero indicare che l'utente non dispone dell'autorizzazione corretta. Ulteriori informazioni sugli errori sono disponibili nella sezione Gestire gli errori .