5 月 14 日開催の Google I/O で Firebase の最新情報をお届けします。今すぐご登録ください。

Android で Cloud Storage を使用してファイルを一覧表示する

Cloud Storage for Firebase では、Cloud Storage バケットの内容を一覧表示できます。SDK は現在の Cloud Storage 参照の下にあるアイテム、およびオブジェクトの接頭辞の両方を返します。

List API を使用するプロジェクトには、Cloud Storage for Firebase ルールバージョン 2 が必要です。Firebase プロジェクトがすでに存在する場合は、セキュリティルールガイドの手順に沿って操作してください。

list() は Google Cloud Storage List API を使用します。Cloud Storage for Firebase では、ファイルシステムセマンティクスをエミュレートするために、区切り文字として / を使用します。大規模な階層型の Cloud Storage バケットを効率的に走査できるようにするために、List API は接頭辞とアイテムを別々に返します。たとえば、1 つのファイル /images/uid/file1 をアップロードすると、次のようになります。

root.child('images').listAll() は、接頭辞として /images/uid を返します。
root.child('images/uid').listAll() は、ファイルをアイテムとして返します。

Cloud Storage for Firebase SDK は、2 つの連続する / を含む、または / で終わるオブジェクトパスを返しません。たとえば、次のようなオブジェクトを持つバケットがあるとします。

correctPrefix/happyItem
wrongPrefix//sadItem
lonelyItem/

このバケット内のアイテムのリスト操作によって、次のような結果が得られます。

ルートでリスト操作を行うと、correctPrefix、wrongPrefix、lonelyItem への参照を prefixes として返します。
correctPrefix/ でリスト操作を行うと、correctPrefix/happyItem への参照を items として返します。
wrongPrefix/ でリスト操作を行うと、wrongPrefix//sadItem に 2 つの連続した / が含まれているため、参照は返されません。
lonelyItem/ でリスト操作を行うと、オブジェクト lonelyItem/ が / で終わるため、参照は返されません。

すべてのファイルのリストを取得する

listAll を使用して、ディレクトリのすべての結果をフェッチできます。すべての結果がメモリにバッファされるため、小さなディレクトリに適しています。処理中にオブジェクトが追加または削除された場合は、整合性のあるスナップショットが返されない可能性があります。

listAll() ではすべての結果がメモリにバッファされるため、大きなリストの場合はページ分割に対応した list() メソッドを使用します。

次は 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

リストの結果をページ分割する

list() API では、返される結果の数に制限が設けられます。list() は整合性のあるページビューを提供し、pageToken を公開します。pageToken を使用して、後続の結果をフェッチするタイミングを制御できます。

pageToken には、前の結果で返された最後のアイテムのパスとバージョンがエンコードされます。pageToken を使用した後続のリクエストでは、前回の pageToken の後のアイテムが取り出されます。

次の例は、結果をページ分割する方法を示します。

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

エラーを処理する

セキュリティルールをバージョン 2 にアップグレードしていない場合は、list() と listAll() が失敗します。次のエラーが返された場合は、セキュリティルールをアップグレードしてください。

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

他にも発生する可能性のあるエラーとして、ユーザーが正しい権限を持っていないことを示すエラーがあります。エラーの詳細については、エラーを処理するのセクションをご覧ください。