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

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

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

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

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

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

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

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

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

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

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

Для большого списка используйте метод 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.

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