Wyświetlanie listy plików w Cloud Storage w technologii Flutter

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

Projekty korzystające z interfejsu List API wymagają Cloud Storage dla Firebase Reguły w wersji 2. Jeśli masz już projekt Firebase, wykonaj czynności opisane w sekcji Przewodnik po regułach zabezpieczeń.

Funkcja list() używa funkcji Interfejs Google Cloud Storage List API. W Cloud Storage dla Firebase używamy / jako separatora, który pozwala nam emulować semantykę systemu plików. Aby umożliwić sprawne przemierzanie dużych, hierarchicznych zasobników Cloud Storage, interfejs List API zwraca prefiksy elementów 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 zawierających dwa następujących po sobie znaków / lub kończy się znakiem /. Weźmy na przykład zasobnik z następujące obiekty:

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

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

  • Operacja na liście na poziomie głównym zwraca odwołania do correctPrefix, wrongPrefix i lonelyItem jako prefixes.
  • Operacja listy na elemencie correctPrefix/ zwraca odwołania do correctPrefix/happyItem jako items.
  • Operacja na liście w wrongPrefix/ nie zwraca żadnych odwołań ponieważ wrongPrefix//sadItem zawiera dwa kolejne elementy /.
  • Operacja na liście w lonelyItem/ nie zwraca żadnych odwołań ponieważ obiekt lonelyItem/ 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 obiekty zostały dodane lub usunięte w trakcie tego procesu.

W przypadku dużej listy użyj metody list() z podziałem na strony, ponieważ listAll() buforuje wszystko 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.
}

Wyniki dotyczące listy stron

Liczba zwracanych wyników interfejsu API list() jest ograniczona. list() zapewnia spójną odsłonę i ujawnia element pageToken, który umożliwia kontrolę nad kiedy pobrać dodatkowe wyniki.

PageToken koduje ścieżkę i wersję ostatniego elementu zwróconego w metodzie poprzedniego wyniku. W kolejnym żądaniu używającym parametru pageToken, elementy pojawiające się po wyświetleniu tokena pageToken.

Ten przykład ilustruje dzielenie wyniku 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

list() i listAll() nie powiodły się, jeśli nie uaktualnisz aplikacji reguły zabezpieczeń do wersji 2. Jeśli widzisz tę informację, uaktualnij reguły zabezpieczeń 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 o błędach znajdziesz w sekcji Obsługa błędów. stronę.