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 .