Wyświetlaj pliki w chmurze w Internecie

Cloud Storage dla Firebase umożliwia wyświetlenie zawartości zasobnika Cloud Storage. Pakiety SDK zwracają zarówno elementy, jak i przedrostki obiektów w ramach bieżącego odniesienia do Cloud Storage.

Projekty korzystające z interfejsu List API wymagają Cloud Storage for Firebase Rules w wersji 2. Jeśli masz istniejący projekt Firebase, wykonaj kroki opisane w Przewodniku po regułach zabezpieczeń .

list() korzysta z interfejsu API listy Google Cloud Storage . W Cloud Storage dla Firebase używamy / jako separatora, co pozwala nam emulować semantykę systemu plików. Aby umożliwić efektywne przeglądanie dużych, hierarchicznych segmentów Cloud Storage, interfejs API listy zwraca oddzielnie prefiksy i elementy. Na przykład, jeśli prześlesz jeden plik /images/uid/file1 ,

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

Pakiet Cloud Storage for Firebase SDK nie zwraca ścieżek obiektów zawierających dwa kolejne znaki / lub kończących się znakiem /. . Rozważmy na przykład wiadro zawierające następujące obiekty:

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

Operacje listowe na elementach w tym segmencie dadzą następujące wyniki:

• Operacja list w katalogu głównym zwraca odniesienia do correctPrefix , wrongPrefix i lonelyItem w postaci prefixes .
• Operacja listowa na correctPrefix/ zwraca odniesienia do correctPrefix/happyItem jako items .
• Operacja listowa pod wrongPrefix/ nie zwraca żadnych odniesień, ponieważ wrongPrefix//sadItem zawiera dwa kolejne / s.
• Operacja listowa na lonelyItem/ nie zwraca żadnych referencji, ponieważ obiekt lonelyItem/ kończy się na / .

Lista wszystkich plików

Możesz użyć listAll , aby pobrać wszystkie wyniki dla katalogu. Najlepiej jest to stosować w przypadku małych katalogów, ponieważ wszystkie wyniki są buforowane w pamięci. Operacja może również nie zwrócić spójnej migawki, jeśli w trakcie 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 ilustruje 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

Wyniki listy stronicowania

Funkcja API list() nakłada ograniczenie liczby zwracanych wyników. list() zapewnia spójną odsłonę strony i udostępnia pageToken, który pozwala kontrolować, kiedy pobrać dodatkowe wyniki.

PageToken koduje ścieżkę i wersję ostatniego elementu zwróconego w poprzednim wyniku. W kolejnym żądaniu wykorzystującym pageToken wyświetlane są elementy następujące po pageToken.

Poniższy przykład ilustruje podział wyniku na strony przy użyciu 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ługuj błędy

list() i listAll() zwracają odrzuconą obietnicę, jeśli nie zaktualizowałeś reguł bezpieczeństwa do wersji 2. Zaktualizuj reguły bezpieczeństwa, jeśli widzisz ten błąd:

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 na temat błędów można znaleźć w rozdziale Obsługa błędów .