Wyświetlaj pliki w chmurze w systemie Android

Cloud Storage dla Firebase umożliwia wyświetlenie zawartości zasobnika Cloud Storage. Pakiety SDK zwracają zarówno elementy, jak i przedrostki obiektów w ramach bieżącego odniesienia do Cloud Storage.

Projekty korzystające z interfejsu List API wymagają Cloud Storage for Firebase Rules w wersji 2. Jeśli masz istniejący projekt Firebase, wykonaj czynności opisane w Przewodniku po regułach bezpieczeństwa .

list() korzysta z interfejsu API listy Google Cloud Storage . W Cloud Storage dla Firebase używamy / jako separatora, co pozwala nam emulować semantykę systemu plików. Aby umożliwić efektywne przeglądanie dużych, hierarchicznych segmentów Cloud Storage, interfejs API listy zwraca oddzielnie prefiksy i elementy. Na przykład, jeśli prześlesz jeden 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 Cloud Storage for Firebase SDK nie zwraca ścieżek obiektów zawierających dwa kolejne znaki / lub kończących się znakiem / . Rozważmy na przykład wiadro zawierające następujące obiekty:

correctPrefix/happyItem
wrongPrefix//sadItem
lonelyItem/

Operacje listowe na elementach w tym segmencie dadzą następujące wyniki:

Operacja list w katalogu głównym zwraca odniesienia do correctPrefix , wrongPrefix i lonelyItem w postaci prefixes .
Operacja listowa na correctPrefix/ zwraca odniesienia do correctPrefix/happyItem jako items .
Operacja listowa pod wrongPrefix/ nie zwraca żadnych odniesień, ponieważ wrongPrefix//sadItem zawiera dwa kolejne / s.
Operacja listowa na lonelyItem/ nie zwraca żadnych referencji, ponieważ obiekt lonelyItem/ kończy się na / .

Lista wszystkich plików

Możesz użyć listAll , aby pobrać wszystkie wyniki dla katalogu. Najlepiej jest to stosować w przypadku małych katalogów, ponieważ wszystkie wyniki są buforowane w pamięci. Operacja może również nie zwrócić spójnej migawki, jeśli w trakcie procesu zostaną dodane lub usunięte obiekty.

W przypadku dużej listy użyj metody list() z podziałem na strony, ponieważ listAll() buforuje wszystkie wyniki w pamięci.

Poniższy przykład ilustruje listAll .

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

Wyniki listy stronicowania

Funkcja API list() nakłada ograniczenie liczby zwracanych wyników. list() zapewnia spójną odsłonę strony i udostępnia pageToken, który pozwala kontrolować, kiedy pobrać dodatkowe wyniki.

PageToken koduje ścieżkę i wersję ostatniego elementu zwróconego w poprzednim wyniku. W kolejnym żądaniu wykorzystującym pageToken wyświetlane są elementy następujące po pageToken.

Poniższy przykład ilustruje paginację wyniku:

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

Obsługuj błędy

list() i listAll() nie działają, jeśli nie zaktualizowałeś reguł bezpieczeństwa do wersji 2. Zaktualizuj reguły bezpieczeństwa, jeśli widzisz ten błąd:

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 na temat błędów można znaleźć w rozdziale Obsługa błędów .