Wyświetlanie listy plików w Cloud Storage na Androidzie

Cloud Storage for Firebase umożliwia wyświetlenie zawartości zasobnika Cloud Storage. Zestawy SDK zwracają zarówno elementy, jak i prefiks obiektów w bieżącym odwołaniu Cloud Storage.

Projekty, które korzystają z interfejsu List API, wymagają Cloud Storage for Firebase reguł w wersji 2. Jeśli masz już projekt Firebase, wykonaj czynności opisane w przewodniku po regułach zabezpieczeń.

list() korzysta z Google Cloud Storage interfejsu List API. W Cloud Storage for Firebase używamy znaku / jako ogranicznika, co pozwala nam emulować semantykę systemu plików. Aby umożliwić wydajne przechodzenie przez duże, hierarchiczne zasoby Cloud Storage, interfejs List API zwraca prefiksy i elementy oddzielnie. Jeśli na przykład prześlesz 1 plik /images/uid/file1,

  • root.child('images').listAll() zwróci /images/uid jako przedrostek.
  • root.child('images/uid').listAll() zwróci plik jako element.

Pakiet SDK Cloud Storage for Firebase nie zwraca ścieżek obiektów, które zawierają 2 kolejne znaki / lub kończą się znakiem /. Załóżmy, że masz zasobnik z tymi obiektami:

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

Operacje wyświetlania listy elementów w tym zasobniku dadzą te wyniki:

  • Operacja wyświetlania listy w katalogu głównym zwraca odwołania do elementów correctPrefix, wrongPrefix i lonelyItem jako prefixes.
  • Operacja listy w przypadku correctPrefix/ zwraca odwołania do correctPrefix/happyItem jako items.
  • Operacja listy w miejscu wrongPrefix/ nie zwraca żadnych odwołań, ponieważ wrongPrefix//sadItem zawiera 2 kolejne znaki /.
  • Operacja na liście w miejscu lonelyItem/ nie zwraca żadnych odwołań, ponieważ obiekt lonelyItem/ kończy się znakiem /.

Wyświetlanie listy wszystkich plików

Aby pobrać wszystkie wyniki dla katalogu, możesz użyć listAll. Najlepiej sprawdza się w przypadku małych katalogów, ponieważ wszystkie wyniki są buforowane w pamięci. Operacja może też nie zwrócić spójnego zrzutu, jeśli w trakcie procesu dodawane lub usuwane są obiekty.

W przypadku długiej listy użyj metody stronicowanej list(), ponieważ listAll() buforuje wszystkie wyniki w pamięci.

Poniższy przykład pokazuje listAll.

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

Podział wyników listy na strony

Interfejs list() API ogranicza liczbę zwracanych wyników. list() zapewnia spójny widok strony i udostępnia element pageToken, który umożliwia kontrolowanie, kiedy pobierać dodatkowe wyniki.

Parametr pageToken koduje ścieżkę i wersję ostatniego elementu zwróconego w poprzednim wyniku. W kolejnym żądaniu z użyciem parametru pageToken wyświetlane są elementy, które występują po tym parametrze.

Poniższy przykład pokazuje stronicowanie wyniku:

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

Obsługuj błędy

list() i listAll() nie działają, jeśli nie uaktualnisz reguł zabezpieczeń do wersji 2. Jeśli zobaczysz ten błąd, uaktualnij reguły zabezpieczeń:

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

Inne możliwe błędy mogą wskazywać, że użytkownik nie ma odpowiednich uprawnień. Więcej informacji o błędach znajdziesz w sekcji Obsługa błędów.