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 nesnelerin hem öğelerini hem de öneklerini döndürür.

List API'yi kullanan projeler için Cloud Storage for Firebase Kurallar sürüm 2 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 içinde, dosya sistemi semantiğini taklit etmemize olanak tanıyan / karakterini sınırlayıcı olarak kullanırız. 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, bir dosya yüklerseniz /images/uid/file1,

  • root.child('images').listAll(), önek olarak /images/uid 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 öğeler üzerinde liste işlemleri aşağıdaki sonuçları verir:

  • Kök dizindeki liste işlemi, correctPrefix, wrongPrefix ve lonelyItem referanslarını prefixes olarak döndürür.
  • correctPrefix/ adresindeki liste işlemi, correctPrefix/happyItem referanslarını items olarak döndürür.
  • wrongPrefix/ konumundaki liste işlemi, wrongPrefix//sadItem iki ardışık / içerdiğinden herhangi bir referans döndürmüyor.
  • lonelyItem/ konumundaki liste işlemi, lonelyItem/ nesnesi / ile bittiği için referans döndürmüyor.

Tüm dosyaları listeleme

Bir dizindeki tüm sonuçları getirmek için listAll kullanabilirsiniz. Tüm sonuçlar bellekte arabelleğe alındığından, bu yöntem küçük dizinler için idealdir. İş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 için sayfalandırılmış list() yöntemini kullanın. listAll(), tüm sonuçları bellekte arabelleğe alır.

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

Kotlin

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!
    }

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!
            }
        });

Liste sonuçlarını sayfalara ayırma

list() API, döndürdüğü sonuç sayısına bir sınır koyar. 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 sunar.

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

Aşağıdaki örnekte bir sonucun sayfalandırılması gösterilmektedir:

Kotlin

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.
        }
}

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.
                }
            });
}

Hataları işleme

Güvenlik Kuralları'nı 2. sürüme 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.

Olası diğer hatalar, kullanıcının doğru izne sahip olmadığını gösterebilir. Hatalar hakkında daha fazla bilgiyi Hataları İşleme bölümünde bulabilirsiniz.