فهرست فایل‌ها با فضای ذخیره‌سازی ابری در وب

Cloud Storage for Firebase به شما امکان می دهد محتویات سطل Cloud Storage خود را فهرست کنید. SDK ها هم موارد و هم پیشوندهای اشیاء را تحت مرجع Cloud Storage فعلی برمی گردانند.

پروژه‌هایی که از List API استفاده می‌کنند، به Cloud Storage for Firebase نسخه 2 نیاز دارند. اگر پروژه Firebase موجود دارید، مراحل راهنمای قوانین امنیتی را دنبال کنید.

list() از Google Cloud Storage List API استفاده می کند. در Cloud Storage for Firebase ، ما از / به عنوان یک جداکننده استفاده می‌کنیم که به ما امکان می‌دهد مفاهیم سیستم فایل را شبیه‌سازی کنیم. فهرست API برای پیمایش موثر سطل‌های Cloud Storage سلسله مراتبی و بزرگ، پیشوندها و موارد را جداگانه برمی‌گرداند. برای مثال، اگر یک فایل /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 شامل دو / s متوالی است.
• عملیات لیست در lonelyItem/ هیچ مرجعی را بر نمی گرداند زیرا شی lonelyItem/ با / ختم می شود.

لیست همه فایل ها

می توانید از listAll برای واکشی همه نتایج برای یک فهرست استفاده کنید. این به بهترین وجه برای دایرکتوری های کوچک استفاده می شود زیرا همه نتایج در حافظه بافر هستند. اگر اشیا در طول فرآیند اضافه یا حذف شوند، ممکن است این عملیات یک عکس فوری ثابت را برگرداند.

برای یک لیست بزرگ، از متد list() صفحه بندی شده استفاده کنید، زیرا listAll() تمام نتایج را در حافظه بافر می کند.

مثال زیر listAll نشان می دهد.

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

// 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

صفحه بندی نتایج لیست

list() API محدودیتی برای تعداد نتایجی که برمی گرداند قرار می دهد. list() یک نمای صفحه ثابت ارائه می دهد و یک pageToken را نشان می دهد که امکان کنترل زمان واکشی نتایج اضافی را فراهم می کند.

pageToken مسیر و نسخه آخرین موردی که در نتیجه قبلی برگردانده شده را رمزگذاری می کند. در یک درخواست بعدی با استفاده از pageToken، مواردی که بعد از pageToken قرار می گیرند نشان داده می شوند.

مثال زیر صفحه بندی یک نتیجه را با استفاده از async/await نشان می دهد.

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

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() یک 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.

سایر خطاهای احتمالی ممکن است نشان دهد که کاربر مجوز درستی ندارد. اطلاعات بیشتر در مورد خطاها را می توانید در Handle Errors بیابید.