แสดงรายการไฟล์ด้วย Cloud Storage ใน Flutter

Cloud Storage for Firebase ช่วยให้คุณแสดงรายการเนื้อหาใน Bucket ของ Cloud Storage ได้ โดย SDK จะแสดงทั้งรายการและคำนำหน้าของออบเจ็กต์ภายใต้การอ้างอิง Cloud Storage ปัจจุบัน

โปรเจ็กต์ที่ใช้ List API ต้องใช้กฎ Cloud Storage for Firebase เวอร์ชัน 2 หากมีโปรเจ็กต์ Firebase อยู่แล้ว ให้ทำตามขั้นตอนใน คู่มือเกี่ยวกับกฎความปลอดภัย

list() ใช้ Google Cloud Storage List API ใน Cloud Storage for Firebase เราใช้ / เป็นตัวคั่น ซึ่งช่วยให้เราจำลองความหมายของระบบไฟล์ได้ List API จะแสดงคำนำหน้าและรายการแยกกันเพื่อให้การข้ามผ่าน Bucket ของ Cloud Storage ขนาดใหญ่ที่มีลำดับชั้นเป็นไปอย่างมีประสิทธิภาพ ตัวอย่างเช่น หากคุณอัปโหลดไฟล์ /images/uid/file1

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

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

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

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

  • การดำเนินการกับรายการที่รูทจะแสดงการอ้างอิง correctPrefix, wrongPrefix และ lonelyItem เป็น prefixes
  • การดำเนินการกับรายการที่ correctPrefix/ จะแสดงการอ้างอิง correctPrefix/happyItem เป็น items
  • การดำเนินการกับรายการที่ wrongPrefix/ จะไม่แสดงการอ้างอิงใดๆ เนื่องจาก wrongPrefix//sadItem มี / 2 ตัวติดกัน
  • การดำเนินการกับรายการที่ lonelyItem/ จะไม่แสดงการอ้างอิงใดๆ เนื่องจากออบเจ็กต์ lonelyItem/ ลงท้ายด้วย /

แสดงรายการไฟล์ทั้งหมด

คุณสามารถใช้ listAll เพื่อดึงผลลัพธ์ทั้งหมดสำหรับไดเรกทอรี วิธีนี้เหมาะที่สุดสำหรับไดเรกทอรีขนาดเล็ก เนื่องจากระบบจะบัฟเฟอร์ผลลัพธ์ทั้งหมดไว้ในหน่วยความจำ นอกจากนี้ การดำเนินการอาจไม่แสดงภาพรวมที่สอดคล้องกันหากมีการเพิ่มหรือนำออบเจ็กต์ออกระหว่างกระบวนการ

สำหรับรายการขนาดใหญ่ ให้ใช้เมธอด list() ที่แบ่งหน้า เนื่องจาก listAll() จะบัฟเฟอร์ผลลัพธ์ทั้งหมดไว้ในหน่วยความจำ

ตัวอย่างต่อไปนี้แสดง listAll

final storageRef = FirebaseStorage.instance.ref().child("files/uid");
final listResult = await storageRef.listAll();
for (var prefix in listResult.prefixes) {
  // The prefixes under storageRef.
  // You can call listAll() recursively on them.
}
for (var item in listResult.items) {
  // The items under storageRef.
}

แบ่งหน้าผลลัพธ์ของรายการ

API list() กำหนดขีดจำกัดจำนวนผลลัพธ์ที่จะแสดง list()มีมุมมองการดูหน้าเว็บที่สอดคล้องกันและแสดง pageToken ที่ช่วยให้คุณควบคุมได้ว่าจะดึงผลลัพธ์เพิ่มเติมเมื่อใด

pageToken จะเข้ารหัสเส้นทางและเวอร์ชันของรายการสุดท้ายที่แสดงในผลลัพธ์ก่อนหน้า ในคำขอที่ตามมาโดยใช้ pageToken ระบบจะแสดงรายการที่อยู่หลัง pageToken

ตัวอย่างต่อไปนี้แสดงการแบ่งหน้าผลลัพธ์

Stream<ListResult> listAllPaginated(Reference storageRef) async* {
  String? pageToken;
  do {
    final listResult = await storageRef.list(ListOptions(
      maxResults: 100,
      pageToken: pageToken,
    ));
    yield listResult;
    pageToken = listResult.nextPageToken;
  } while (pageToken != null);
}

จัดการข้อผิดพลาด

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.

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