iOS でファイルのリストを取得する

Cloud Storage では、ストレージ バケットの内容のリストを取得できます。 SDK は現在のストレージ参照の下にあるアイテムとオブジェクトの接頭辞の両方を返します。

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

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

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

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

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

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

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

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

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

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

次は listAll(completion:) の例を示しています。

Swift

let storageReference = storage.reference().child("files/uid")
storageReference.listAll { (result, error) in
  if let error = error {
    // ...
  }
  for prefix in result.prefixes {
    // The prefixes under storageReference.
    // You may call listAll(completion:) recursively on them.
  }
  for item in result.items {
    // The items under storageReference.
  }
}

Objective-C

FIRStorageReference *storageReference = [storage reference];
[storageReference listAllWithCompletion:^(FIRStorageListResult *result, NSError *error) {
  if (error != nil) {
    // ...
  }

  for (FIRStorageReference *prefix in result.prefixes) {
    // All the prefixes under storageReference.
    // You may call listAllWithCompletion: recursively on them.
  }
  for (FIRStorageReference *item in result.items) {
    // All items under storageReference.
  }
}];

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

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

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

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

Swift

func listAllPaginated(pageToken: String? = nil) {
  let storage = Storage.storage()
  let storageReference = storage.reference().child("files/uid")

  let pageHandler: (StorageListResult, Error?) -> Void = { (result, error) in
    if let error = error {
      // ...
    }
    let prefixes = result.prefixes
    let items = result.items

    // ...

    // Process next page
    if let token = result.pageToken {
      self.listAllPaginated(pageToken: token)
    }
  }

  if let pageToken = pageToken {
    storageReference.list(withMaxResults: 100, pageToken: pageToken, completion: pageHandler)
  } else {
    storageReference.list(withMaxResults: 100, completion: pageHandler)
  }
}

Objective-C

- (void)paginateFilesAtReference:(FIRStorageReference *)reference
                       pageToken:(nullable NSString *)pageToken {
  void (^pageHandler)(FIRStorageListResult *_Nonnull, NSError *_Nullable) =
      ^(FIRStorageListResult *result, NSError *error) {
        if (error != nil) {
          // ...
        }
        NSArray *prefixes = result.prefixes;
        NSArray *items = result.items;

        // ...

        // Process next page
        if (result.pageToken != nil) {
          [self paginateFilesAtReference:reference pageToken:result.pageToken];
        }
  };

  if (pageToken != nil) {
    [reference listWithMaxResults:100 pageToken:pageToken completion:pageHandler];
  } else {
    [reference listWithMaxResults:100 completion:pageHandler];
  }
}

エラーを処理する

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

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

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