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

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 odwołaniu do Cloud Storage.

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

list() korzysta z interfejsu Google Cloud Storage List API. W Cloud Storage dla Firebase używamy znaku / jako separatora, co pozwala nam emulować semantykę systemu plików. Aby umożliwić wydajne przechodzenie przez duże, hierarchiczne zasobniki 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() zwróci /images/uid jako przedrostek.
  • root.child('images/uid').listAll() zwróci plik jako element.

Pakiet SDK Cloud Storage dla Firebase nie zwraca ścieżek do obiektów, które zawierają dwa kolejne znaki / lub kończą się znakiem /. Załóżmy, że masz zasobnik z tymi obiektami:

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

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, wrongPrefix i lonelyItem jako prefixes.
  • Operacja listy w przypadku correctPrefix/ zwraca odwołania do correctPrefix/happyItem jako items.
  • Operacja listy w miejscu wrongPrefix/ nie zwraca żadnych odwołań, ponieważ wrongPrefix//sadItem zawiera 2 kolejne znaki /.
  • Operacja na liście w miejscu lonelyItem/ nie zwraca żadnych odwołań, ponieważ obiekt lonelyItem/ kończy się znakiem /.

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 w trakcie procesu dodawane lub usuwane są obiekty.

W przypadku długiej listy użyj metody list() z podziałem na strony, ponieważ metoda 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.
}

Dzielenie wyników listy na strony

Interfejs list() API ogranicza liczbę zwracanych wyników. list() zapewnia spójny widok strony i udostępnia element pageToken, który umożliwia kontrolowanie, 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 tym parametrze.

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ługuj błędy

list() i listAll() nie działają, jeśli nie uaktualnisz reguł zabezpieczeń do wersji 2. Jeśli zobaczysz 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 na stronie Obsługa błędów.