Dateien mit Cloud Storage auf Android-Geräten auflisten

Mit Cloud Storage for Firebase können Sie den Inhalt Ihres Cloud Storage-Buckets auflisten. Die SDKs geben sowohl die Elemente als auch die Präfixe der Objekte unter der aktuellen Cloud Storage-Referenz zurück.

Für Projekte, die die List API verwenden, ist Cloud Storage for Firebase-Regeln Version 2 erforderlich. Wenn Sie bereits ein Firebase-Projekt haben, folgen Sie der Anleitung im Leitfaden zu Sicherheitsregeln.

list() verwendet die Google Cloud Storage List API. In Cloud Storage for Firebase verwenden wir / als Trennzeichen, um die Semantik des Dateisystems zu emulieren. Damit große, hierarchische Cloud Storage-Buckets effizient durchlaufen werden können, gibt die List API Präfixe und Elemente separat zurück. Wenn Sie beispielsweise eine Datei /images/uid/file1 hochladen,

Für root.child('images').listAll() wird /images/uid als Präfix zurückgegeben.
root.child('images/uid').listAll() gibt die Datei als Element zurück.

Das Cloud Storage for Firebase SDK gibt keine Objektpfade zurück, die zwei aufeinanderfolgende /s enthalten oder mit einem / enden. Angenommen, Sie haben einen Bucket mit den folgenden Objekten:

correctPrefix/happyItem
wrongPrefix//sadItem
lonelyItem/

Die Listenvorgänge für Elemente in diesem Bucket führen zu den folgenden Ergebnissen:

Der Listenvorgang am Stamm gibt die Verweise auf correctPrefix, wrongPrefix und lonelyItem als prefixes zurück.
Der Listenvorgang bei correctPrefix/ gibt die Verweise auf correctPrefix/happyItem als items zurück.
Der Listenvorgang bei wrongPrefix/ gibt keine Verweise zurück, da wrongPrefix//sadItem zwei aufeinanderfolgende /s enthält.
Der Listenvorgang bei lonelyItem/ gibt keine Verweise zurück, da das Objekt lonelyItem/ auf / endet.

Alle Dateien auflisten

Mit listAll können Sie alle Ergebnisse für ein Verzeichnis abrufen. Diese Methode eignet sich am besten für kleine Verzeichnisse, da alle Ergebnisse im Arbeitsspeicher zwischengespeichert werden. Außerdem wird möglicherweise kein konsistenter Snapshot zurückgegeben, wenn während des Vorgangs Objekte hinzugefügt oder entfernt werden.

Verwenden Sie für eine große Liste die paginated list()-Methode, da listAll() alle Ergebnisse im Arbeitsspeicher puffert.

Im folgenden Beispiel wird listAll veranschaulicht.

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

Listenergebnisse paginieren

Die list() API begrenzt die Anzahl der zurückgegebenen Ergebnisse. list() bietet einen einheitlichen Seitenaufruf und gibt ein pageToken aus, mit dem gesteuert werden kann, wann zusätzliche Ergebnisse abgerufen werden.

Das Seitentoken codiert den Pfad und die Version des letzten Elements, das im vorherigen Ergebnis zurückgegeben wurde. In einer nachfolgenden Anfrage mit dem pageToken werden Elemente angezeigt, die nach dem pageToken kommen.

Im folgenden Beispiel wird die Paginierung eines Ergebnisses veranschaulicht:

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

Fehler verarbeiten

list() und listAll() schlagen fehl, wenn Sie die Sicherheitsregeln nicht auf Version 2 aktualisiert haben. Aktualisieren Sie Ihre Sicherheitsregeln, wenn Sie diese Fehlermeldung sehen:

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

Andere mögliche Fehler können darauf hinweisen, dass der Nutzer nicht die richtige Berechtigung hat. Weitere Informationen zu Fehlern finden Sie unter Fehler beheben.