Cloud Storage for Firebase vous permet d'importer rapidement et facilement des fichiers dans un bucket Cloud Storage fourni et géré par Firebase.
Créer une référence
Pour importer un fichier, commencez par créer une référence Cloud Storage vers l'emplacement dans Cloud Storage où vous souhaitez importer le fichier.
Vous pouvez créer une référence en ajoutant des chemins d'accès 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 rediriger vers une URL enfant.
Importer des fichiers
Une fois que vous disposez d'une référence, vous pouvez importer des fichiers dans Cloud Storage de deux manières:
- Importer à partir d'un tampon d'octets en mémoire
- Importer à partir d'un chemin d'accès à un fichier sur l'appareil
Importer à partir de données en mémoire
La méthode PutData() est le moyen le plus simple d'importer un fichier dans Cloud Storage. PutData() prend un tampon d'octets et renvoie un Future<Metadata> qui contient des informations sur le fichier lorsque l'opération Future est terminée. Vous pouvez utiliser un Controller pour gérer votre importation et surveiller son état.
// 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);
La requête a été effectuée, mais nous devons attendre la fin de la Future avant d'importer le fichier. Étant donné que les jeux s'exécutent généralement en boucle et sont moins basés sur les rappels que les autres applications, vous effectuez généralement une requête pour vérifier la finalisation.
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();
}
}
Importer à partir d'un fichier local
Vous pouvez importer des fichiers locaux sur les appareils, tels que des photos et des vidéos de l'appareil photo, à l'aide de 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 importation et surveiller son état.
// 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();
}
Si vous souhaitez gérer activement votre importation, vous pouvez fournir un Controller aux méthodes PutFile() ou PutBytes(). Vous pouvez ainsi utiliser le contrôleur pour observer l'opération d'importation en cours. Pour en savoir plus, consultez la section Gérer les importations.
Ajouter des métadonnées de fichier
Vous pouvez également inclure des métadonnées lorsque vous importez 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 (généralement appelées type MIME). La méthode PutFile() infère automatiquement le type de contenu à partir de l'extension de 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 de valeur par défaut à partir de l'extension de fichier, Cloud Storage utilise application/octet-stream. Pour en savoir plus sur les métadonnées de fichier, consultez la section Utiliser 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 importations
En plus de démarrer des importations, vous pouvez les suspendre, les reprendre et les annuler à 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 de l'importation
Vous pouvez associer des écouteurs aux importations afin de surveiller leur progression.
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);
}
Traitement des erreurs
Plusieurs raisons peuvent expliquer l'apparition d'erreurs lors de l'importation, par exemple si le fichier local n'existe pas ou si l'utilisateur n'est pas autorisé à importer le fichier souhaité. Pour en savoir plus sur les erreurs, consultez la section Gérer les erreurs de la documentation.
Étapes suivantes
Maintenant que vous avez importé des fichiers, découvrez comment les télécharger depuis Cloud Storage.