向 Cloud Storage 上传文件 (C++)

Cloud Storage for Firebase 可让您快速轻松地将文件上传到 Firebase 提供和管理的 Cloud Storage 存储桶中。

创建引用

如需上传文件，请先创建一个 Cloud Storage 引用，指向 Cloud Storage 中您希望将文件上传到的位置。

您可以通过将子路径附加到 Cloud Storage 存储桶的根目录来创建引用：

// Create a root reference
StorageReference storage_ref = storage->GetReference();

// Create a reference to "mountains.jpg"
StorageReference mountains_ref = storage_ref.Child("mountains.jpg");

// Create a reference to 'images/mountains.jpg'
StorageReference mountain_images_ref = storage_ref.Child("images/mountains.jpg");

// While the file names are the same, the references point to different files
mountains_ref.name() == mountain_images_ref.name();           // true
mountains_ref.full_path() == mountain_images_ref.full_path(); // false

您无法通过指向 Cloud Storage 存储桶根目录的引用来上传数据。您的引用必须指向一个子网址。

上传文件

有了引用之后，您可以通过两种方式将文件上传到 Cloud Storage：

  1. 通过内存中的某个字节缓冲区上传
  2. 通过表示设备上文件的某个文件路径上传

通过内存中的数据上传

PutData() 方法是将文件上传到 Cloud Storage 最简单的方法。PutData()会获取一个字节缓冲区，并返回一个Future<Metadata>，后者将在模板完成时包含有关该文件的信息。您可以使用 Controller 管理上传并监控其状态。

// Data in memory
const size_t kByteBufferSize = ...
uint8_t byte_buffer[kByteBufferSize] = { ... };

// Create a reference to the file you want to upload
StorageReference rivers_ref = storage_ref.Child("images/rivers.jpg");

// Upload the file to the path "images/rivers.jpg"
Future future = rivers_ref.PutBytes(byte_buffer, kByteBufferSize);

此时请求已经发出，但我们必须等待 Future 变成已完成状态之后才能上传文件。由于游戏通常在一个循环中运行，并且比起其他应用较少采用回调驱动方式，因此您通常应采用轮询方式来判断操作是否完成。

if (future.status() != firebase::kFutureStatusPending) {
  if (future.status() != firebase::kFutureStatusComplete) {
    LogMessage("ERROR: GetData() returned an invalid future.");
    // Handle the error...
  } else if (future.Error() != firebase::storage::kErrorNone) {
    LogMessage("ERROR: GetData() returned error %d: %s", future.Error(),
               future.error_message());
    // Handle the error...
    }
  } else {
    // Metadata contains file metadata such as size, content-type, and download URL.
    Metadata* metadata = future.Result();
    std::string download_url = metadata->download_url();
  }
}

通过本地文件上传

您可以使用 PutFile() 方法上传设备上的本地文件，如相机中的照片和视频。PutFile() 用一个表示文件路径的 std::string 作为参数，并返回一个 Future<Metadata>，Future 完成后，其中将包含该文件的相关信息。您可以使用 Controller 管理上传并监控其状态。

// File located on disk
std::string local_file = ...

// Create a reference to the file you want to upload
StorageReference rivers_ref = storage_ref.Child("images/rivers.jpg");

// Upload the file to the path "images/rivers.jpg"
Future future = rivers_ref.PutFile(localFile);

// Wait for Future to complete...

if (future.Error() != firebase::storage::kErrorNone) {
  // Uh-oh, an error occurred!
} else {
  // Metadata contains file metadata such as size, content-type, and download URL.
  Metadata* metadata = future.Result();
  std::string download_url = metadata->download_url();
}

如果您想要主动管理上传过程，可以向 PutFile() 或 PutBytes() 方法提供一个 Controller。这样，您就可以使用该控制器来观察正在进行的上传操作。如需了解详情，请参阅管理上传。

添加文件元数据

在上传文件时，您还可以包含元数据。这些元数据包括常见的文件元数据属性，如 name、size 和 content_type（通常称为 MIME 类型）。PutFile() 方法会自动根据文件扩展名推断内容类型，但您可以通过在元数据中指定 content_type 来覆盖自动检测到的类型。如果您未提供 content_type，并且 Cloud Storage 无法根据文件扩展名推断出默认值，则 Cloud Storage 将使用 application/octet-stream。如需详细了解文件元数据，请参阅使用文件元数据部分。

// Create storage reference
StorageReference mountains_ref = storage_ref.Child("images/mountains.jpg");

// Create file metadata including the content type
StorageMetadata metadata;
metadata.set_content_type("image/jpeg");

// Upload data and metadata
mountains_ref.PutBytes(data, metadata);

// Upload file and metadata
mountains_ref.PutFile(local_file, metadata);

管理上传

除了开始上传操作，您还可以使用 Controller（可以视情况将其传递给 PutBytes() 或 PutFile() 方法）中的 Pause()、Resume() 和 Cancel() 方法来暂停、继续和取消上传。

// Start uploading a file
firebase::storage::Controller controller;
storage_ref.Child("images/mountains.jpg").PutFile(local_file, nullptr, &controller);

// Pause the upload
controller.Pause();

// Resume the upload
controller.Resume();

// Cancel the upload
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").PutFile(local_file, my_listener);
}

错误处理

导致上传时出现错误的原因有很多，包括本地文件不存在，或者用户不具备上传所需文件的权限。如需了解错误详情，请参阅相关文档的处理错误部分。

后续步骤

现在您已经上传了文件，接下来，我们将学习如何从 Cloud Storage 下载文件。