Получение списка файлов с помощью Cloud Storage на Android

Cloud Storage for Firebase позволяет вам перечислить содержимое вашего контейнера Cloud Storage . SDK возвращают как элементы, так и префиксы объектов в текущей ссылке Cloud Storage .

Для проектов, использующих API списков, требуется Cloud Storage for Firebase версии 2. Если у вас есть существующий проект Firebase, следуйте инструкциям в Руководстве по правилам безопасности .

Примечание: API списков разрешено только для правил версии 2. В правилах версии 2 allow read — это сокращение для allow get, list .

list() использует Google Cloud Storage List API . В Cloud Storage for Firebase мы используем / в качестве разделителя, что позволяет нам эмулировать семантику файловой системы. Для эффективного обхода больших иерархических контейнеров Cloud Storage API List возвращает префиксы и элементы отдельно. Например, если вы загружаете один файл /images/uid/file1 ,

• root.child('images').listAll() вернет /images/uid в качестве префикса.
• root.child('images/uid').listAll() вернет файл как элемент.

Cloud Storage for Firebase SDK не возвращает пути объектов, которые содержат два последовательных символа / или заканчиваются на / . Например, рассмотрим контейнер, который содержит следующие объекты:

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

Операции со списком элементов в этом сегменте дадут следующие результаты:

• Операция списка в корне возвращает ссылки на correctPrefix , wrongPrefix и lonelyItem в качестве prefixes .
• Операция со списком в correctPrefix/ возвращает ссылки на correctPrefix/happyItem как items .
• Операция со списком в wrongPrefix/ не возвращает никаких ссылок, поскольку wrongPrefix//sadItem содержит два последовательных символа / .
• Операция со списком в lonelyItem/ не возвращает никаких ссылок, поскольку объект lonelyItem/ заканчивается на / .

Список всех файлов

Вы можете использовать listAll для извлечения всех результатов для каталога. Это лучше всего использовать для небольших каталогов, так как все результаты буферизуются в памяти. Операция также может не возвращать согласованный снимок, если объекты добавляются или удаляются во время процесса.

Для большого списка используйте метод paginated list() поскольку listAll() буферизует все результаты в памяти.

Следующий пример демонстрирует 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

Результаты постраничного списка

API list() накладывает ограничение на количество возвращаемых результатов. list() обеспечивает единообразный просмотр страницы и предоставляет pageToken, позволяющий контролировать время извлечения дополнительных результатов.

PageToken кодирует путь и версию последнего элемента, возвращенного в предыдущем результате. В последующем запросе с использованием pageToken отображаются элементы, которые идут после pageToken.

Следующий пример демонстрирует разбиение результата на страницы:

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

Обработка ошибок

list() и listAll() завершатся ошибкой, если вы не обновили правила безопасности до версии 2. Обновите правила безопасности, если вы видите эту ошибку:

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

Другие возможные ошибки могут указывать на то, что у пользователя нет нужного разрешения. Более подробную информацию об ошибках можно найти в разделе Handle Errors .