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

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

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

list() korzysta z Google Cloud Storage interfejsu List API. W Cloud Storage for Firebase używamy znaku / jako separatora, co pozwala nam emulować semantykę systemu plików. Aby umożliwić wydajne przechodzenie przez duże, hierarchiczne Cloud Storage zasobniki, interfejs List API zwraca prefiksy i elementy oddzielnie. Jeśli na przykład prześlesz 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 /.. Rozważmy na przykład zasobnik, który zawiera te obiekty:

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

Operacje na liście elementów w tym zasobniku dadzą te wyniki:

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

Wyświetlanie wszystkich plików

Aby pobrać wszystkie wyniki dla katalogu, możesz użyć listAll. Najlepiej używać tej funkcji w przypadku małych katalogów, ponieważ wszystkie wyniki są buforowane w pamięci. Jeśli podczas procesu dodawane lub usuwane są obiekty, operacja może też nie zwrócić spójnego stanu.

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

Ten przykład pokazuje, jak używać 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

Dzielenie wyników listy na strony

Interfejs list() API ogranicza liczbę zwracanych wyników. list() zapewnia spójny widok strony i udostępnia token strony, który umożliwia kontrolowanie, kiedy pobierać dodatkowe wyniki.

Token strony koduje ścieżkę i wersję ostatniego elementu zwróconego w poprzednim wyniku. W kolejnym żądaniu z użyciem tokena strony wyświetlane są elementy, które znajdują się za tokenem strony.

Ten przykład pokazuje, jak dzielić wynik na strony za pomocą 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

Obsługa błędów

Jeśli nie zaktualizujesz reguł bezpieczeństwa do wersji 2, list() i listAll() zwrócą odrzuconą obietnicę. Jeśli widzisz ten błąd, zaktualizuj reguły bezpieczeństwa:

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 sekcji Obsługa błędów.