Na tej stronie dowiesz się, jak za pomocą pakietu SDK Cloud Storage for Firebase wyświetlić listę zawartości zasobnika Cloud Storage. Pakiet SDK zwraca 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 dla Firebase Rules w wersji 2. Jeśli masz już projekt w Firebase, wykonaj czynności opisane w przewodniku po regułach zabezpieczeń.
list() korzysta z interfejsu API listy Google Cloud Storage.
Cloud Storage for Firebase używa / jako separatora, co pozwala emulować semantykę systemu plików. Aby umożliwić efektywne przechodzenie przez duże, hierarchiczne zasobniki 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/uidjako prefiks.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 znaki / lub kończą się znakiem /. Załóżmy na przykład, że zasobnik zawiera te obiekty:
correctPrefix/happyItemwrongPrefix//sadItemlonelyItem/
Operacje wyświetlania listy elementów w tym zasobniku dadzą te wyniki:
- Operacja wyświetlania listy w katalogu głównym zwraca odwołania do
correctPrefix,wrongPrefixilonelyItemjakoprefixes. - Operacja wyświetlania listy w
correctPrefix/zwraca odwołania docorrectPrefix/happyItemjakoitems. - Operacja wyświetlania listy w
wrongPrefix/nie zwraca żadnych odwołań, ponieważwrongPrefix//sadItemzawiera 2 następujące po sobie znaki/. - Operacja wyświetlania listy w
lonelyItem/nie zwraca żadnych odwołań, ponieważ obiektlonelyItem/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.
final storageRef = FirebaseStorage.instance.ref().child("files/uid");
final listResult = await storageRef.listAll();
for (var prefix in listResult.prefixes) {
// The prefixes under storageRef.
// You can call listAll() recursively on them.
}
for (var item in listResult.items) {
// The items under storageRef.
}
Podział 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:
Stream<ListResult> listAllPaginated(Reference storageRef) async* {
String? pageToken;
do {
final listResult = await storageRef.list(ListOptions(
maxResults: 100,
pageToken: pageToken,
));
yield listResult;
pageToken = listResult.nextPageToken;
} while (pageToken != null);
}
Obsługa błędów
Jeśli nie uaktualnisz reguł zabezpieczeń do wersji 2, metody list() i listAll() nie będą działać. 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 artykule Obsługa błędów.