Créer une référence Cloud Storage avec Cloud Storage pour Unity

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 sur votre disque dur local ou les données dans Firebase Realtime Database. Lorsque vous créez une référence à un fichier, votre application peut y accéder. 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 de multiples opérations.

Les références sont créées à partir du service Firebase.Storage.FirebaseStorage de votre application Firebase en appelant la méthode GetReferenceFromUrl() et en transmettant une URL de type 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
FirebaseStorage storage = FirebaseStorage.DefaultInstance;

// Create a storage reference from our storage service
StorageReference storageRef =
    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
// imagesRef now points to "images"
StorageReference imagesRef = storageRef.Child("images");

// Child references can also take paths delimited by '/' such as:
// "images/space.jpg".
StorageReference spaceRef = imagesRef.Child("space.jpg");
// spaceRef now points to "images/space.jpg"
// imagesRef still points to "images"

// This is equivalent to creating the full referenced
StorageReference spaceRefFull = 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 notre hiérarchie de 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
// imagesRef now points to 'images'
StorageReference imagesRef = spaceRef.Parent;

// Root allows us to move all the way back to the top of our bucket
// rootRef now points to the root
StorageReference rootRef = spaceRef.Root;

Child, Parent et Root peuvent être chaî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
// earthRef points to "images/earth.jpg"
StorageReference earthRef =
    spaceRef.Parent.Child("earth.jpg");

// nullRef is null since the parent of root is an invalid StorageReference
StorageReference nullRef = spaceRef.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 propriétés Path, Name et Bucket. Ces propriétés récupèrent le chemin d'accès complet, le nom et le bucket du fichier.

// Reference's path is: "images/space.jpg"
// This is analogous to a file path on disk
string path = spaceRef.Path;

// Reference's name is the last segment of the full path: "space.jpg"
// This is analogous to the file name
string name = spaceRef.Name;

// Reference's bucket is the name of the storage bucket where files are stored
string bucket = spaceRef.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 :

1. La longueur totale de reference.Path doit être comprise entre 1 et 1 024 octets lorsqu'elle est encodée en UTF-8.
2. Aucun caractère de retour chariot ni de saut de ligne.
3. Évitez d'utiliser #, [, ], * ou ?, car ils ne fonctionnent pas bien avec d'autres outils tels que Firebase Realtime Database ou gsutil.

Exemple complet

FirebaseStorage storage = FirebaseStorage.DefaultInstance;

// Points to the root reference
StorageReference storageRef =
    storage.GetReferenceFromUrl("gs://<your-bucket-name>");

// Points to "images"
StorageReference imagesRef = storageRef.Child("images");

// Points to "images/space.jpg"
// Note that you can use variables to create child values
string filename = "space.jpg";
StorageReference spaceRef = imagesRef.Child(filename);

// File path is "images/space.jpg"
string path = spaceRef.Path;

// File name is "space.jpg"
string name = spaceRef.Name;

// Points to "images"
StorageReference imagesRef = spaceRef.Parent;

Étapes suivantes

Découvrez ensuite comment importer des fichiers dans Cloud Storage.