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

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 เราใช้ / เป็นตัวคั่น ซึ่งช่วยให้เราจำลองความหมายของระบบไฟล์ได้ List 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

Kotlin+KTX

val storage = Firebase.storage
val listRef = storage.reference.child("files/uid")

// You'll need to import com.google.firebase.storage.component1 and
// com.google.firebase.storage.component2
listRef.listAll()
    .addOnSuccessListener { (items, prefixes) ->
        for (prefix in prefixes) {
            // All the prefixes under listRef.
            // You may call listAll() recursively on them.
        }

        for (item in items) {
            // All the items under listRef.
        }
    }
    .addOnFailureListener {
        // Uh-oh, an error occurred!
    }
StorageActivity.kt

Java

StorageReference listRef = storage.getReference().child("files/uid");

listRef.listAll()
        .addOnSuccessListener(new OnSuccessListener<ListResult>() {
            @Override
            public void onSuccess(ListResult listResult) {
                for (StorageReference prefix : listResult.getPrefixes()) {
                    // All the prefixes under listRef.
                    // You may call listAll() recursively on them.
                }

                for (StorageReference item : listResult.getItems()) {
                    // All the items under listRef.
                }
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Uh-oh, an error occurred!
            }
        });
StorageActivity.java

จัดเรียงรายการผลลัพธ์เป็นหน้า

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

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

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

Kotlin+KTX

fun listAllPaginated(pageToken: String?) {
    val storage = Firebase.storage
    val listRef = storage.reference.child("files/uid")

    // Fetch the next page of results, using the pageToken if we have one.
    val listPageTask = if (pageToken != null) {
        listRef.list(100, pageToken)
    } else {
        listRef.list(100)
    }

    // You'll need to import com.google.firebase.storage.component1 and
    // com.google.firebase.storage.component2
    listPageTask
        .addOnSuccessListener { (items, prefixes, pageToken) ->
            // Process page of results
            processResults(items, prefixes)

            // Recurse onto next page
            pageToken?.let {
                listAllPaginated(it)
            }
        }.addOnFailureListener {
            // Uh-oh, an error occurred.
        }
}
StorageActivity.kt

Java

public void listAllPaginated(@Nullable String pageToken) {
    FirebaseStorage storage = FirebaseStorage.getInstance();
    StorageReference listRef = storage.getReference().child("files/uid");

    // Fetch the next page of results, using the pageToken if we have one.
    Task<ListResult> listPageTask = pageToken != null
            ? listRef.list(100, pageToken)
            : listRef.list(100);

    listPageTask
            .addOnSuccessListener(new OnSuccessListener<ListResult>() {
                @Override
                public void onSuccess(ListResult listResult) {
                    List<StorageReference> prefixes = listResult.getPrefixes();
                    List<StorageReference> items = listResult.getItems();

                    // Process page of results
                    // ...

                    // Recurse onto next page
                    if (listResult.getPageToken() != null) {
                        listAllPaginated(listResult.getPageToken());
                    }
                }
            }).addOnFailureListener(new OnFailureListener() {
                @Override
                public void onFailure(@NonNull Exception e) {
                    // Uh-oh, an error occurred.
                }
            });
}
StorageActivity.java

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

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.

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