Cloud Storage pour Firebase vous permet de télécharger rapidement et facilement des fichiers vers un bucket Cloud Storage fourni et géré par Firebase.
Créer une référence
Pour télécharger un fichier, créez d'abord une référence Cloud Storage à l'emplacement dans Cloud Storage vers lequel vous souhaitez télécharger le fichier.
Vous pouvez créer une référence en ajoutant des chemins enfants à la racine de votre bucket 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
Vous ne pouvez pas importer de données avec une référence à la racine de votre bucket Cloud Storage. Votre référence doit pointer vers une URL enfant.
Télécharger des fichiers
Une fois que vous avez une référence, vous pouvez télécharger des fichiers sur Cloud Storage de deux manières :
- Télécharger à partir d'un tampon d'octets en mémoire
- Importer à partir d'un chemin de fichier représentant un fichier sur l'appareil
Télécharger à partir de données en mémoire
La méthode PutData()
est le moyen le plus simple de télécharger un fichier sur Cloud Storage. PutData()
prend un tampon d'octets et renvoie un Future<Metadata>
qui contiendra des informations sur le fichier une fois le Future terminé. Vous pouvez utiliser un Controller
pour gérer votre téléchargement et surveiller son statut.
// 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);
Au moment où la demande a été faite, nous devons attendre que le Future soit terminé avant que le fichier ne soit téléchargé. Étant donné que les jeux s'exécutent généralement en boucle et sont moins pilotés par rappel que les autres applications, vous interrogerez généralement leur achèvement.
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(); } }
Télécharger à partir d'un fichier local
Vous pouvez télécharger des fichiers locaux sur les appareils, tels que des photos et des vidéos de l'appareil photo, avec la méthode PutFile()
. PutFile()
prend un std::string
représentant le chemin d'accès au fichier et renvoie un Future<Metadata>
qui contiendra des informations sur le fichier une fois le Future terminé. Vous pouvez utiliser un Controller
pour gérer votre téléchargement et surveiller son statut.
// 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(); }
Si vous souhaitez gérer activement votre téléchargement, vous pouvez fournir un Controller
aux méthodes PutFile()
ou PutBytes()
. Cela vous permet d'utiliser le contrôleur pour observer l'opération de téléchargement en cours. Voir Gérer les téléchargements pour plus d'informations.
Ajouter des métadonnées de fichier
Vous pouvez également inclure des métadonnées lorsque vous téléchargez des fichiers. Ces métadonnées contiennent des propriétés de métadonnées de fichier typiques telles que name
, size
et content_type
(communément appelé type MIME). La méthode PutFile()
déduit automatiquement le type de contenu à partir de l'extension du nom de fichier, mais vous pouvez remplacer le type détecté automatiquement en spécifiant content_type
dans les métadonnées. Si vous ne fournissez pas de content_type
et que Cloud Storage ne peut pas déduire une valeur par défaut à partir de l'extension de fichier, Cloud Storage utilise application/octet-stream
. Consultez la section Utiliser les métadonnées de fichier pour plus d’informations sur les métadonnées de fichier.
// 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);
Gérer les téléchargements
En plus de démarrer les téléchargements, vous pouvez suspendre, reprendre et annuler les téléchargements à l'aide des méthodes Pause()
, Resume()
et Cancel()
sur Controller
, que vous pouvez éventuellement transmettre aux méthodes PutBytes()
ou 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();
Surveiller la progression du téléchargement
Vous pouvez associer des écouteurs aux téléchargements afin de surveiller la progression du téléchargement.
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); }
La gestion des erreurs
Il existe un certain nombre de raisons pour lesquelles des erreurs peuvent survenir lors du téléchargement, notamment le fichier local qui n'existe pas ou l'utilisateur qui n'est pas autorisé à télécharger le fichier souhaité. Vous pouvez trouver plus d'informations sur les erreurs dans la section Gérer les erreurs de la documentation.
Prochaines étapes
Maintenant que vous avez téléchargé des fichiers, apprenons comment les télécharger depuis Cloud Storage.