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 двумя способами:
- Загрузка из байтового буфера в памяти
- Загрузка по пути к файлу, представляющему файл на устройстве.
Загрузка из данных в памяти
Метод 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" Futurefuture = 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" Futurefuture = 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 .