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

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

پروژه‌هایی که از List API استفاده می‌کنند، Cloud Storage for Firebase نیاز دارند. اگر یک پروژه 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 برای دریافت تمام نتایج یک دایرکتوری استفاده کنید. این روش برای دایرکتوری‌های کوچک بهتر است زیرا تمام نتایج در حافظه بافر می‌شوند. همچنین اگر اشیاء در طول فرآیند اضافه یا حذف شوند، ممکن است این عملیات یک snapshot ثابت برنگرداند.

برای یک لیست بزرگ، از متد 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() list تعداد نتایجی که برمی‌گرداند را محدود می‌کند. 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 رد شده برمی‌گردانند. اگر این خطا را مشاهده کردید، قوانین امنیتی خود را ارتقا دهید:

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

سایر خطاهای احتمالی ممکن است نشان دهنده عدم دسترسی کاربر باشد. اطلاعات بیشتر در مورد خطاها را می‌توانید در بخش «مدیریت خطاها» بیابید.