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

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

Для проектов, использующих List API, требуется облачное хранилище для правил Firebase версии 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 .

Web modular API

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!
  });storage_list_all.js

Web namespaced API

// 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-files.js

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

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

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

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

Web modular API

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)
  }
}storage_list_paginate.js

Web namespaced API

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-files.js

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

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.

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