แสดงรายการไฟล์ด้วย 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 เราใช้ / เป็นตัวคั่น ซึ่งช่วยให้เราจำลองความหมายของระบบไฟล์ได้ API ของรายการจะแสดงคำนำหน้าและรายการแยกกันเพื่อให้การข้ามผ่านที่เก็บข้อมูลขนาดใหญ่แบบ Cloud Storage ที่มีลำดับชั้นได้อย่างมีประสิทธิภาพ ตัวอย่างเช่น หากคุณอัปโหลดไฟล์ /images/uid/file1 ไฟล์เดียว

• root.child('images').listAll() จะแสดงผล /images/uid เป็นคำนำหน้า
• root.child('images/uid').listAll() จะแสดงผลไฟล์เป็นรายการ

SDK ของ Cloud Storage for Firebase จะไม่แสดงผลเส้นทางออบเจ็กต์ที่มี / 2 ตัวติดกันหรือลงท้ายด้วย /. ตัวอย่างเช่น ลองพิจารณาที่เก็บข้อมูลซึ่งมีออบเจ็กต์ต่อไปนี้

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

การดำเนินการรายการกับรายการในที่เก็บข้อมูลนี้จะให้ผลลัพธ์ต่อไปนี้

• การดำเนินการรายการที่รูทจะแสดงผลการอ้างอิงไปยัง correctPrefix, wrongPrefix และ lonelyItem เป็น prefixes
• การดำเนินการกับลิสต์ที่ correctPrefix/ จะแสดงการอ้างอิงถึง correctPrefix/happyItem เป็น items
• การดำเนินการกับลิสต์ที่ wrongPrefix/ จะไม่แสดงการอ้างอิงใดๆ เนื่องจาก wrongPrefix//sadItem มี / ติดต่อกัน 2 ตัว
• การดำเนินการรายการที่ 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() จะแสดงผล "สัญญา" ที่ถูกปฏิเสธหากคุณยังไม่ได้อัปเกรดกฎความปลอดภัยเป็นเวอร์ชัน 2 อัปเกรดกฎความปลอดภัยหากคุณเห็นข้อผิดพลาดนี้

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

ข้อผิดพลาดอื่นๆ ที่อาจเกิดขึ้นอาจบ่งชี้ว่าผู้ใช้ไม่มีสิทธิ์ที่เหมาะสม ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดได้ในจัดการข้อผิดพลาด