Android'de Cloud Storage ile dosyaları listeleme

Firebase için Cloud Storage, Cloud Storage paketinizin içeriğini listelemenize olanak tanır. SDK'lar, geçerli Cloud Storage referansı altındaki nesnelerin hem öğelerini hem de öneklerini döndürür.

Liste API'sini kullanan projeler, Firebase Kuralları için Cloud Storage sürüm 2'yi gerektirir. Mevcut bir Firebase projeniz varsa Güvenlik Kuralları Kılavuzu'ndaki adımları izleyin.

list() Google Bulut Depolama Listesi API'sini kullanır. Firebase için Cloud Storage'da sınırlayıcı olarak / kullanıyoruz, bu da dosya sistemi anlambilimini taklit etmemize olanak tanıyor. List API, büyük, hiyerarşik Cloud Storage paketlerinde verimli bir şekilde geçiş yapılmasına olanak sağlamak için önekleri ve öğeleri ayrı ayrı döndürür. Örneğin, bir dosya /images/uid/file1 yüklerseniz,

root.child('images').listAll() önek olarak /images/uid döndürür.
root.child('images/uid').listAll() dosyayı bir öğe olarak döndürecektir.

Firebase için Cloud Storage SDK, ardışık iki / içeren veya / ile biten nesne yollarını döndürmez. Örneğin, aşağıdaki nesneleri içeren bir paket düşünün:

correctPrefix/happyItem
wrongPrefix//sadItem
lonelyItem/

Bu paketteki öğelere ilişkin liste işlemleri aşağıdaki sonuçları verecektir:

Kökteki liste işlemi, correctPrefix , wrongPrefix ve lonelyItem yapılan başvuruları prefixes olarak döndürür.
correctPrefix/ deki liste işlemi, correctPrefix/happyItem yapılan başvuruları items olarak döndürür.
wrongPrefix/ deki liste işlemi herhangi bir başvuru döndürmez çünkü wrongPrefix//sadItem ardışık iki / s içerir.
lonelyItem/ nesnesindeki liste işlemi herhangi bir başvuru döndürmez çünkü lonelyItem/ nesnesi / ile biter.

Tüm dosyaları listele

Bir dizine ilişkin tüm sonuçları getirmek için listAll kullanabilirsiniz. Tüm sonuçlar bellekte ara belleğe alındığından, bu en iyi şekilde küçük dizinler için kullanılır. İşlem sırasında nesneler eklenir veya kaldırılırsa işlem aynı zamanda tutarlı bir anlık görüntü döndürmeyebilir.

Büyük bir liste için, listAll() tüm sonuçları bellekte ara belleğe aldığından sayfalandırılmış list() yöntemini kullanın.

Aşağıdaki örnekte listAll gösterilmektedir.

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

Liste sonuçlarını sayfalara ayır

list() API'si, döndürdüğü sonuç sayısına bir sınır koyar. list() tutarlı bir sayfa görünümü sağlar ve ek sonuçların ne zaman getirileceği konusunda kontrole izin veren bir pageToken sunar.

pageToken, önceki sonuçta döndürülen son öğenin yolunu ve sürümünü kodlar. pageToken kullanılarak yapılan sonraki bir istekte, pageToken'dan sonra gelen öğeler gösterilir.

Aşağıdaki örnek, bir sonucun sayfalandırılmasını gösterir:

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

Hataları işleme

Güvenlik Kurallarını sürüm 2'ye yükseltmediyseniz list() ve listAll() başarısız olur. Bu hatayı görürseniz Güvenlik Kurallarınızı yükseltin:

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

Diğer olası hatalar kullanıcının doğru izne sahip olmadığını gösterebilir. Hatalarla ilgili daha fazla bilgiyi Hataları İşleme bölümünde bulabilirsiniz.