Wyświetlanie listy plików w Cloud Storage w internecie

Cloud Storage for Firebase umożliwia wyświetlenie zawartości zasobnika Cloud Storage. Pakiety SDK zwracają zarówno elementy, jak i prefiksy obiektów w bieżącym odwołaniu Cloud Storage.

Projekty, które korzystają z interfejsu List API, wymagają Cloud Storage for Firebase reguł w wersji 2. Jeśli masz już projekt w Firebase, wykonaj czynności opisane w przewodniku po regułach zabezpieczeń.

list() używa interfejsu Google Cloud Storage List API. W Cloud Storage for Firebase używamy / jako separatora, co pozwala nam emulować semantykę systemu plików. Aby umożliwić efektywne przeglądanie dużych, hierarchicznych zasobników Cloud Storage, interfejs List API zwraca prefiksy i elementy osobno. Jeśli na przykład prześlesz 1 plik /images/uid/file1,

  • root.child('images').listAll() zwróci /images/uid jako prefiks.
  • root.child('images/uid').listAll() zwróci plik jako element.

Pakiet SDK Cloud Storage for Firebase nie zwraca ścieżek obiektów, które zawierają 2 kolejne znaki / lub kończą się znakiem /.. Załóżmy na przykład, że zasobnik zawiera te obiekty:

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

Operacje wyświetlania listy elementów w tym zasobniku dadzą następujące wyniki:

  • Operacja wyświetlania listy w katalogu głównym zwraca odwołania do correctPrefix, wrongPrefix i lonelyItem jako prefixes.
  • Operacja wyświetlania listy w correctPrefix/ zwraca odwołania do correctPrefix/happyItem jako items.
  • Operacja wyświetlania listy w wrongPrefix/ nie zwraca żadnych odwołań, ponieważ wrongPrefix//sadItem zawiera 2 kolejne znaki /.
  • Operacja wyświetlania listy w lonelyItem/ nie zwraca żadnych odwołań, ponieważ obiekt lonelyItem/ kończy się na /.

Wyświetlanie listy wszystkich plików

Możesz użyć listAll, aby pobrać wszystkie wyniki dla katalogu. Najlepiej sprawdza się w przypadku małych katalogów, ponieważ wszystkie wyniki są buforowane w pamięci. Operacja może też nie zwrócić spójnego zrzutu, jeśli podczas procesu zostaną dodane lub usunięte obiekty.

W przypadku dużej listy użyj metody list() z podziałem na strony, ponieważ listAll() buforuje wszystkie wyniki w pamięci.

Poniższy przykład pokazuje 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!
  });

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

Dzielenie wyników listy na strony

Interfejs API list() nakłada limit na liczbę zwracanych wyników. list() zapewnia spójny widok strony i udostępnia parametr pageToken, który pozwala kontrolować, kiedy pobierać dodatkowe wyniki.

Parametr pageToken koduje ścieżkę i wersję ostatniego elementu zwróconego w poprzednim wyniku. W kolejnym żądaniu z użyciem parametru pageToken wyświetlane są elementy, które występują po parametrze pageToken.

Poniższy przykład pokazuje, jak podzielić wynik na strony za pomocą 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)
  }
}

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

Obsługuj błędy

Jeśli nie uaktualnisz reguł zabezpieczeń do wersji 2, list() i listAll() zwrócą odrzuconą wartość Promise. Jeśli zobaczysz ten błąd, uaktualnij reguły zabezpieczeń:

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

Inne możliwe błędy mogą wskazywać, że użytkownik nie ma odpowiednich uprawnień. Więcej informacji o błędach znajdziesz w artykule Obsługa błędów.