Как получить список файлов в Cloud Storage в веб-версии

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

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

list() использует Google Cloud Storage List API. В Cloud Storage for Firebase в качестве разделителя используется /, что позволяет эмулировать семантику файловой системы. Чтобы обеспечить эффективный обход больших иерархических сегментов Cloud Storage, List 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/

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

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

Как получить список всех файлов

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

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

Ниже приведен пример listAll.

Web

import { getStorage, ref, listAll } from "firebase/storage";

const storage = getStorage();

// Create a reference under which you want to list
const listRef = ref(storage, 'files/uid');

// Find all the prefixes and items.
listAll(listRef)
  .then((res) => {
    res.prefixes.forEach((folderRef) => {
      // All the prefixes under listRef.
      // You may call listAll() recursively on them.
    });
    res.items.forEach((itemRef) => {
      // All the items under listRef.
    });
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });

Web

// Create a reference under which you want to list
var listRef = storageRef.child('files/uid');

// Find all the prefixes and items.
listRef.listAll()
  .then((res) => {
    res.prefixes.forEach((folderRef) => {
      // All the prefixes under listRef.
      // You may call listAll() recursively on them.
    });
    res.items.forEach((itemRef) => {
      // All the items under listRef.
    });
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });

Разбиение списка результатов на страницы

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

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

В примере ниже показано, как разбить результаты на страницы с помощью async/await.

Web

import { getStorage, ref, list } from "firebase/storage";

async function pageTokenExample(){
  // Create a reference under which you want to list
  const storage = getStorage();
  const listRef = ref(storage, 'files/uid');

  // Fetch the first page of 100.
  const firstPage = await list(listRef, { maxResults: 100 });

  // Use the result.
  // processItems(firstPage.items)
  // processPrefixes(firstPage.prefixes)

  // Fetch the second page if there are more elements.
  if (firstPage.nextPageToken) {
    const secondPage = await list(listRef, {
      maxResults: 100,
      pageToken: firstPage.nextPageToken,
    });
    // processItems(secondPage.items)
    // processPrefixes(secondPage.prefixes)
  }
}

Web

async function pageTokenExample(){
  // Create a reference under which you want to list
  var listRef = storageRef.child('files/uid');

  // Fetch the first page of 100.
  var firstPage = await listRef.list({ maxResults: 100});

  // Use the result.
  // processItems(firstPage.items)
  // processPrefixes(firstPage.prefixes)

  // Fetch the second page if there are more elements.
  if (firstPage.nextPageToken) {
    var secondPage = await listRef.list({
      maxResults: 100,
      pageToken: firstPage.nextPageToken,
    });
    // processItems(secondPage.items)
    // processPrefixes(secondPage.prefixes)
  }
}

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

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

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

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