Получение списка файлов с помощью Cloud Storage на Flutter

Cloud Storage for Firebase позволяет получить список содержимого вашего сегмента Cloud Storage. SDK возвращает как сами элементы, так и префиксы объектов, находящихся в текущем каталоге Cloud Storage.

Для проектов, использующих List API, требуется Cloud Storage for Firebase Rules версии 2. Если у вас уже есть проект Firebase, выполните действия, описанные в Руководстве по правилам безопасности .

list() использует API списков Google Cloud Storage . В Cloud Storage for Firebase мы используем / в качестве разделителя, что позволяет нам имитировать семантику файловой системы. Для обеспечения эффективного обхода больших иерархических сегментов Cloud Storage API списков возвращает префиксы и элементы отдельно. Например, если вы загружаете один файл /images/uid/file1 ,

  • root.child('images').listAll() вернет префикс /images/uid .
  • root.child('images/uid').listAll() вернет файл в качестве элемента.

SDK Cloud Storage for Firebase не возвращает пути к объектам, содержащие два последовательных символа / или заканчивающиеся символом / . Например, рассмотрим корзину, содержащую следующие объекты:

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

Операции над элементами в этом сегменте дадут следующие результаты:

  • Операция над списком в корневом элементе возвращает ссылки на correctPrefix , wrongPrefix и lonelyItem в качестве prefixes .
  • Операция добавления списка в correctPrefix/ возвращает ссылки на correctPrefix/happyItem в виде items .
  • Операция над списком в wrongPrefix/ не возвращает никаких ссылок, поскольку wrongPrefix//sadItem содержит два последовательных символа / .
  • Операция над списком в объекте lonelyItem/ не возвращает никаких ссылок, поскольку объект lonelyItem/ заканчивается символом / .

Список всех файлов

Для получения всех результатов поиска по каталогу можно использовать listAll . Этот метод лучше всего подходит для небольших каталогов, так как все результаты буферизуются в памяти. Однако, если в процессе добавляются или удаляются объекты, операция может не возвращать согласованный снимок состояния каталога.

Для больших списков используйте метод `paginated list() , поскольку listAll() сохраняет все результаты в памяти.

Следующий пример демонстрирует использование 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.
}

Постраничная разбивка результатов

API функции list() ограничивает количество возвращаемых результатов. list() обеспечивает согласованный просмотр страницы и предоставляет pageToken, позволяющий контролировать, когда следует получать дополнительные результаты.

pageToken кодирует путь и версию последнего элемента, возвращенного в предыдущем результате. В последующем запросе с использованием pageToken отображаются элементы, следующие за этим pageToken.

Следующий пример демонстрирует постраничную обработку результата:

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);
}

Обработка ошибок

Функции list() и listAll() завершаются с ошибкой, если вы не обновили правила безопасности до версии 2. Обновите правила безопасности, если видите эту ошибку:

Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.

Другие возможные ошибки могут указывать на то, что у пользователя нет необходимых прав доступа. Более подробную информацию об ошибках можно найти на странице «Обработка ошибок» .