Android'de Cloud Storage ile dosyaları listeleme

Cloud Storage for Firebase, Cloud Storage paketinizin içeriğini listelemenize olanak tanır. SDK'lar, geçerli Cloud Storage referansı altındaki öğeleri ve nesnelerin ön eklerinin yanı sıra döndürür.

List API'yi kullanan projeler için Cloud Storage for Firebase Kurallar 2 sürümü gerekir. Mevcut bir Firebase projeniz varsa Güvenlik Kuralları Kılavuzu'ndaki adımları uygulayın.

list(), Google Cloud Storage List API'yi kullanır. Cloud Storage for Firebase dosyasında, dosya sistemi anlamlarını taklit etmemizi sağlayan bir ayırıcı olarak / kullanılır. List API, büyük ve hiyerarşik Cloud Storage paketlerinin verimli bir şekilde taranmasına olanak tanımak için ön ekleri ve öğeleri ayrı ayrı döndürür. Örneğin, /images/uid/file1 adlı bir dosya yüklerseniz

  • root.child('images').listAll(), ön ek olarak /images/uid değerini döndürür.
  • root.child('images/uid').listAll(), dosyayı öğe olarak döndürür.

Cloud Storage for Firebase SDK'sı, art arda iki / içeren veya / ile biten nesne yolları döndürmez. Örneğin, aşağıdaki nesneleri içeren bir paketi ele alalım:

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

Bu paketteki öğelerle ilgili liste işlemleri aşağıdaki sonuçları verir:

  • Kökteki liste işlemi, correctPrefix, wrongPrefix ve lonelyItem referanslarını prefixes olarak döndürür.
  • correctPrefix/'teki liste işlemi, correctPrefix/happyItem'a yapılan referansları items olarak döndürür.
  • wrongPrefix//sadItem art arda iki / içerdiğinden wrongPrefix/ öğesindeki liste işlemi herhangi bir referans döndürmez.
  • lonelyItem/ nesnesi / ile bittiği için lonelyItem/ adresindeki liste işlemi hiçbir referans döndürmez.

Tüm dosyaları listeleme

Bir dizinle ilgili tüm sonuçları almak için listAll kullanabilirsiniz. Tüm sonuçlar bellekte arabelleğe alındığından bu yöntem küçük dizinler için en iyi şekilde kullanılır. İşlem sırasında nesne eklenir veya kaldırılırsa işlem tutarlı bir anlık görüntü döndürmeyebilir.

Büyük bir liste söz konusu olduğunda listAll(), tüm sonuçları bellekte arabelleğe aldığı için sayfalara ayrı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ırma

list() API, döndürdüğü sonuç sayısına bir sınır uygular. list(), tutarlı bir sayfa görüntüleme sağlar ve ek sonuçların ne zaman getirileceğini kontrol etmenize olanak tanıyan bir pageToken gösterir.

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

Aşağıdaki örnekte bir sonucu sayfalara ayırma gösterilmektedir:

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ı 2. sürüme yükseltmediyseniz list() ve listAll() başarısız olur. Aşağıdaki hatayı görüyorsanız 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.

Olası diğer hatalar, kullanıcının doğru izne sahip olmadığını gösterebilir. Hatalarla ilgili daha fazla bilgiyi Hataları ele alma bölümünde bulabilirsiniz.