Как загружать файлы с помощью Cloud Storage для C++

Cloud Storage for Firebase позволяет быстро и легко загружать файлы в сегмент Cloud Storage, предоставленный и управляемый Firebase.

Создание ссылки

Чтобы загрузить файл, сначала создайте ссылку 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. Ссылка должна вести на дочерний URL.

Загрузка файлов

После того как вы создадите образец, вы сможете загрузить файлы в Cloud Storage двумя способами:

  1. Загрузка из буфера байтов в памяти
  2. Загрузка из пути к файлу на устройстве

Загрузка данных из памяти

Метод PutData() – самый простой способ загрузить файл в Cloud Storage. Функция PutData() принимает буфер байтов и возвращает объект Future<Metadata>, который будет содержать информацию о файле после завершения Future. Вы можете использовать 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();
}

Если вы хотите управлять загрузкой, укажите Controller в методах PutFile() или PutBytes(). Это позволяет использовать контроллер для наблюдения за процессом загрузки. Подробнее о том, как управлять загрузками…

Как добавить метаданные файла

При загрузке файлов можно также добавлять метаданные. Эти метаданные содержат типичные свойства файлов, такие как 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);

Управление загрузками

Помимо запуска загрузки, вы можете приостанавливать, возобновлять и отменять ее с помощью методов Pause(), Resume() и Cancel() в Controller, которые можно передать методам PutBytes() или PutFile().

// 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.