Cloud Storage for C++ を使用してファイルをダウンロードする

Cloud Storage for Firebase を使用すると、Firebase によって提供、管理される Cloud Storage バケットからファイルを迅速かつ容易にダウンロードできます。

参照を作成する

ファイルをダウンロードするには、まずダウンロードするファイルへのCloud Storage参照を作成します。

参照は、Cloud Storage バケットのルートに子パスを付加して作成することも、Cloud Storage のオブジェクトを参照する既存の gs:// または https:// URL から作成することもできます。

// Create a reference with an initial file path and name
StorageReference path_reference = storage->GetReference("images/stars.jpg");

// Create a reference from a Cloud Storage URI
StorageReference gs_reference = storage->GetReferenceFromUrl("gs://bucket/images/stars.jpg");

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
StorageReference https_reference = storage->GetReferenceFromUrl("https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg");

ファイルをダウンロードする

参照を作成したら、次の 3 つの方法でファイルを Cloud Storage からダウンロードできます。

  1. メモリ内のバッファにダウンロードする
  2. 端末の特定のパスにダウンロードする
  3. オンラインのファイルを表す文字列 URL を生成する

メモリにダウンロードする

GetBytes() メソッドを使用して、ファイルをメモリ内のバイトバッファにダウンロードします。これは最も簡単にすばやくファイルをダウンロードできる方法ですが、ファイルのコンテンツ全体をメモリ内に読み込む必要があります。アプリで使用できるメモリよりも大きなファイルをリクエストすると、アプリがクラッシュします。メモリの問題が発生しないように、アプリで処理できる範囲内で最大サイズを設定するか、別のダウンロード方法を使用してください。

// Create a reference to the file you want to download
StorageReference island_ref = storage_ref.Child("images/island.jpg");

// Download in memory with a maximum allowed size of 1MB (1 * 1024 * 1024 bytes)
const size_t kMaxAllowedSize = 1 * 1024 * 1024
int8_t byte_buffer[kMaxAllowedSize];
firebase::Future<size_t> future = island_ref.GetBytes(byte_buffer, kMaxAllowedSize);

この時点でリクエストは行われていますが、Future が完了してからでないと、ファイルを読み取ることができません。ゲームは通常ループ内で動作し、他のアプリケーションよりもコールバックが少なくなります。そのため、一般的には、完了をポーリングします。

// In the game loop that polls for the result...

if (future.status() != firebase::kFutureStatusPending) {
  if (future.status() != firebase::kFutureStatusComplete) {
    LogMessage("ERROR: GetBytes() returned an invalid future.");
    // Handle the error...
  } else if (future.Error() != firebase::storage::kErrorNone) {
    LogMessage("ERROR: GetBytes() returned error %d: %s", future.Error(),
               future.error_message());
    // Handle the error...
  } else {
    // byte_buffer is now populated with data for "images/island.jpg"
  }
}

ローカル ファイルにダウンロードする

GetFile() メソッドは、ファイルをローカル デバイスに直接ダウンロードします。ユーザーがオフライン中にファイルにアクセスする場合や、別のアプリでファイルを共有する場合は、このメソッドを使用します。

// Create a reference to the file you want to download
StorageReference islandRef = storage_ref.Child("images/island.jpg"];

// Create local filesystem URL
const char* local_url = "file:///local/images/island.jpg";

// Download to the local filesystem
Future<size_t> future = islandRef.GetFile(local_url);

// Wait for Future to complete...

if (future.Error() != firebase::storage::kErrorNone) {
  // Uh-oh, an error occurred!
} else {
  // The file has been downloaded to local file URL "images/island.jpg"
}

GetFile() は、ダウンロードの管理に使用できる、オプションの Controller 引数を受け取ります。詳しくは、ダウンロードの管理をご覧ください。

ダウンロード URL を生成する

URL をベースにしたダウンロード インフラストラクチャがすでにある場合や、URL を共有したい場合は、Cloud Storage 参照に対して GetDownloadUrl() メソッドを呼び出してファイルのダウンロード URL を取得できます。

// Create a reference to the file you want to download
StorageReference stars_ref = storage_ref.Child("images/stars.jpg");

// Fetch the download URL
firebase::Future<std::string> future = stars_ref.GetDownloadUrl();

// Wait for Future to complete...

if (future.Error() != firebase::storage::kErrorNone) {
  // Uh-oh, an error occurred!
} else {
  // Get the download URL for 'images/stars.jpg'
  std::string download_url = future.Result();
}

ダウンロードを管理する

ダウンロードを開始するだけでなく、Controller で Pause()、Resume()、Cancel() メソッドを使用してダウンロードを一時停止、再開、キャンセルすることもできます。これは、必要に応じて GetBytes() または GetFile() メソッドに渡すこともできます。

// Start downloading a file
Controller controller;
storage_ref.Child("images/mountains.jpg").GetFile(local_file, nullptr, &controller);

// Pause the download
controller.Pause();

// Resume the download
controller.Resume();

// Cancel the download
controller.Cancel();

ダウンロードの進捗状況を監視する

ダウンロードの進捗状況を監視するためにリスナーをダウンロードにアタッチすることができます。

class MyListener : public firebase::storage::Listener {
 public:
  virtual void OnProgress(firebase::storage::Controller* controller) {
    // A progress event occurred
  }
};

{
  // Start uploading a file
  MyEventListener my_listener;
  storage_ref.Child("images/mountains.jpg").GetFile(local_file, my_listener);
}

エラーを処理する

ダウンロード時にエラーが発生する理由としては、ファイルが存在しない、目的のファイルへのアクセス権がないなど、多くの理由が考えられます。エラーについて詳しくは、このドキュメントのエラーの処理のセクションをご覧ください。

次のステップ

Cloud Storage に保存されているファイルのメタデータを取得して更新することもできます。