通过 C++ 版 Cloud Storage 下载文件

Cloud Storage for Firebase 可让您快速轻松地从 Firebase 提供和管理的 Cloud Storage 存储桶中下载文件。

创建引用

如需下载某个文件，请先为要下载的文件创建一个 Cloud Storage 引用。

您可以通过将子路径附加到 Cloud Storage 存储桶的根目录来创建引用，也可以根据指向 Cloud Storage 中对象的现有 gs:// 或 https:// 网址创建引用。

// 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");

下载文件

有了引用之后，可通过三种方法从 Cloud Storage 中下载文件：

  1. 下载到内存中的某个缓冲区
  2. 下载到设备上的某个具体路径
  3. 生成一个表示在线文件的字符串网址

下载至内存

使用 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 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 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 参数，您可以使用此参数来管理您的下载。请参阅管理下载了解详细信息。

生成下载网址

如果您已经有了基于网址的下载基础架构，或者只需要一个网址用于共享，可通过对 Cloud Storage 引用调用 GetDownloadUrl() 方法来获取文件的下载网址。

// 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 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（可以视情况将其传递给 GetBytes() 或 GetFile() 方法）中的 Pause()、Resume() 和 Cancel() 方法来暂停、继续和取消下载。

// 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 中的文件，您还可以获取和更新元数据。