Vos fichiers sont stockés dans un bucket Cloud Storage. Les fichiers de ce bucket sont présentés dans une structure hiérarchique, comme le système de fichiers de votre disque dur local ou les données de Firebase Realtime Database. En créant une référence à un fichier, votre application y a accès. Ces références peuvent ensuite être utilisées pour importer ou télécharger des données, obtenir ou mettre à jour des métadonnées ou supprimer le fichier. Une référence peut pointer vers un fichier spécifique ou vers un nœud de niveau supérieur dans la hiérarchie.
Si vous avez utilisé Firebase Realtime Database, ces chemins vous sembleront très familiers. Toutefois, vos données de fichier sont stockées dans Cloud Storage, et non dans Realtime Database.
Créer une référence
Créez une référence pour importer, télécharger ou supprimer un fichier, ou pour obtenir ou mettre à jour ses métadonnées. Une référence peut être considérée comme un pointeur vers un fichier dans le cloud. Les références étant légères, vous pouvez en créer autant que nécessaire. Ils sont également réutilisables pour plusieurs opérations.
Les références sont créées à partir du service storage de votre application Firebase en appelant la méthode GetReferenceFromUrl() et en transmettant une URL de la forme gs://<your-cloud-storage-bucket>. Vous trouverez cette URL dans la section Stockage de la console Firebase.
// Get a reference to the storage service, using the default Firebase App
Storage* storage = Storage::GetInstance(app);
// Create a Cloud Storage reference from our storage service
StorageReference storage_ref = storage->GetReferenceFromUrl("gs://<your-cloud-storage-bucket>");
Vous pouvez créer une référence à un emplacement plus bas dans l'arborescence, par exemple 'images/space.jpg', en utilisant la méthode child sur une référence existante.
// Create a child reference
// images_ref now points to "images"
StorageReference images_ref = storage_ref.Child("images");
// Child references can also take paths delimited by '/'
// space_ref now points to "images/space.jpg"
// images_ref still points to "images"
StorageReference space_ref = storage_ref.Child("images/space.jpg");
// This is equivalent to creating the full reference
StorageReference space_ref = storage.GetReferenceFromUrl("gs://<your-cloud-storage-bucket>/images/space.jpg");
Naviguer avec des références
Vous pouvez également utiliser les méthodes Parent et Root pour remonter dans la hiérarchie des fichiers. Parent permet de monter d'un niveau, tandis que Root permet de monter jusqu'en haut.
// Parent allows us to move to the parent of a reference // images_ref now points to 'images' StorageReference images_ref = space_ref.Parent(); // Root allows us to move all the way back to the top of our bucket // root_ref now points to the root StorageReference root_ref = space_ref.Root();
Child, Parent et Root peuvent être enchaînés plusieurs fois, car chacun renvoie une référence. L'exception est le Parent de Root, qui est un StorageReference non valide.
// References can be chained together multiple times
// earth_ref points to "images/earth.jpg"
StorageReference earth_ref = space_ref.Parent().Child("earth.jpg");
// null_ref is null, since the parent of root is an invalid StorageReference
StorageReference null_ref = space_ref.Root().Parent();
Méthodes de référence
Vous pouvez inspecter les références pour mieux comprendre les fichiers auxquels elles font référence à l'aide des méthodes full_path, name et bucket. Ces méthodes obtiennent le chemin d'accès, le nom et le bucket complets du fichier.
// Reference's path is: "images/space.jpg"
// This is analogous to a file path on disk
space_ref.full_path();
// Reference's name is the last segment of the full path: "space.jpg"
// This is analogous to the file name
space_ref.name();
// Reference's bucket is the name of the Cloud Storage bucket where files are stored
space_ref.bucket();
Limites concernant les références
Les noms et les chemins de référence peuvent contenir n'importe quelle séquence de caractères Unicode valides, mais certaines restrictions s'appliquent, y compris les suivantes:
- La longueur totale de reference.fullPath doit être comprise entre 1 et 1 024 octets lorsqu'elle est encodée en UTF-8.
- Aucun caractère de retour chariot ni de saut de ligne.
- Évitez d'utiliser
#,[,],*ou?, car ils ne fonctionnent pas bien avec d'autres outils tels que Firebase Realtime Database ou gsutil.
Exemple complet
Storage* storage = Storage::GetInstance(app);
// Points to the root reference
StorageReference storage_ref = storage->GetReferenceFromUrl("gs://<your-bucket-name>");
// Points to "images"
StorageReference images_ref = storage_ref.Child("images");
// Points to "images/space.jpg"
// Note that you can use variables to create child values
std::string filename = "space.jpg";
StorageReference space_ref = images_ref.Child(filename);
// File path is "images/space.jpg"
std::string path = space_ref.full_path()
// File name is "space.jpg"
std::string name = space_ref.name()
// Points to "images"
StorageReference images_ref = space_ref.Parent();
Étapes suivantes
Découvrez ensuite comment importer des fichiers dans Cloud Storage.