Cloud Storage dla Firebase umożliwia wyświetlanie zawartości zasobnika Cloud Storage. Pakiety SDK zwracają zarówno elementy, jak i prefiksy obiektów w bieżącym odniesieniu do Cloud Storage.
Projekty korzystające z interfejsu List API wymagają reguł Cloud Storage dla Firebase w wersji 2. Jeśli masz już projekt Firebase, wykonaj czynności opisane w przewodniku po regułach zabezpieczeń.
list()
używa interfejsu Google Cloud Storage List API.
W Cloud Storage dla Firebase używamy /
jako separatora, co pozwala nam emulować semantykę systemu plików. Aby umożliwić sprawne przechodzenie dużych, hierarchicznych zasobników Cloud Storage, interfejs List API zwraca prefiksy i elementy oddzielnie. Jeśli na przykład prześlesz 1 plik /images/uid/file1
,
root.child('images').listAll()
zwraca prefiks/images/uid
.root.child('images/uid').listAll()
zwróci plik jako element.
Pakiet SDK Cloud Storage dla Firebase nie zwraca ścieżek obiektów, które zawierają 2 kolejne obiekty /
lub kończą się /.
. Rozważmy na przykład zasobnik z tymi obiektami:
correctPrefix/happyItem
wrongPrefix//sadItem
lonelyItem/
Operacje wyświetlania listy elementów w tym zasobniku dają następujące wyniki:
- Operacja listy na poziomie głównym zwraca odwołania do
correctPrefix
,wrongPrefix
ilonelyItem
jakoprefixes
. - Operacja listy w elemencie
correctPrefix/
zwraca odwołania docorrectPrefix/happyItem
jakoitems
. - Operacja listy w elemencie
wrongPrefix/
nie zwraca żadnych odwołań, ponieważwrongPrefix//sadItem
zawiera 2 kolejne obiekty/
. - Operacja listy w obiekcie
lonelyItem/
nie zwraca żadnych odwołań, ponieważ obiektlonelyItem/
kończy się na/
.
Wyświetl wszystkie pliki
Aby pobrać wszystkie wyniki z katalogu, możesz użyć narzędzia listAll
.
Najlepiej sprawdza się to 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 w jej trakcie obiekty zostały dodane lub usunięte.
W przypadku obszernej 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! });
Wyniki dotyczące listy stron
Liczba zwracanych wyników interfejsu API list()
jest ograniczona. list()
zapewnia spójną odsłonę i udostępnia token pageToken, który pozwala kontrolować, kiedy mają być pobierane dodatkowe wyniki.
pageToken koduje ścieżkę i wersję ostatniego elementu zwróconego w poprzednim wyniku. W kolejnym żądaniu z użyciem pageToken wyświetlają się elementy znajdujące się po elemencie pageToken.
Poniższy przykład pokazuje dzielenie wyniku na strony za pomocą funkcji 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ługa błędów
Jeśli reguły zabezpieczeń nie zostały uaktualnione do wersji 2, list()
i listAll()
zwracają odrzuconą obietnicę. Jeśli widzisz 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 sekcji Obsługa błędów.