Créer une référence Cloud Storage sur Flutter

Vos fichiers sont stockés dans un bucket Cloud Storage. Les fichiers de ce bucket sont présentés dans une structure hiérarchique, tout comme le système de fichiers sur votre disque dur local ou les données de la base de données Firebase Realtime. 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 devraient vous sembler très familiers. Toutefois, les données de vos fichiers sont stockées dans Cloud Storage, pas 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 sont légères. Vous pouvez donc en créer autant que nécessaire. Ils sont également réutilisables pour plusieurs opérations.

Créez une référence à l'aide de l'instance singleton FirebaseStorage et en appelant sa méthode ref().

final storageRef = FirebaseStorage.instance.ref();

Vous pouvez ensuite créer une référence à un emplacement plus bas dans l'arborescence, par exemple "images/space.jpg", à l'aide de la méthode child() sur une référence existante.

// Create a child reference
// imagesRef now points to "images"
final imagesRef = storageRef.child("images");

// Child references can also take paths
// spaceRef now points to "images/space.jpg
// imagesRef still points to "images"
final spaceRef = storageRef.child("images/space.jpg");

Vous pouvez également utiliser les propriétés parent et root pour remonter dans la hiérarchie de nos fichiers. parent permet de remonter d'un niveau, tandis que root permet de remonter tout en haut.

// parent allows us to move our reference to a parent node
// imagesRef2 now points to 'images'
final imagesRef2 = spaceRef.parent;

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

child(), parent et root peuvent être enchaînés plusieurs fois, car chacun est une référence. Toutefois, l'accès à root.parent génère null.

// References can be chained together multiple times
// earthRef points to 'images/earth.jpg'
final earthRef = spaceRef.parent?.child("earth.jpg");

// nullRef is null, since the parent of root is null
final nullRef = spaceRef.root.parent;

Propriétés de référence

Vous pouvez inspecter les références pour mieux comprendre les fichiers auxquels elles pointent à l'aide des propriétés fullPath, name et bucket. Ces propriétés permettent d'obtenir 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
spaceRef.fullPath;

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

// Reference's bucket is the name of the storage bucket that the files are stored in
spaceRef.bucket;

Limites relatives aux références

Les chemins d'accès et les noms de référence peuvent contenir n'importe quelle séquence de caractères Unicode valides, mais certaines restrictions s'appliquent, y compris :

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

Exemple complet

// Points to the root reference
final storageRef = FirebaseStorage.instance.ref();

// Points to "images"
Reference? imagesRef = storageRef.child("images");

// Points to "images/space.jpg"
// Note that you can use variables to create child values
final fileName = "space.jpg";
final spaceRef = imagesRef.child(fileName);

// File path is "images/space.jpg"
final path = spaceRef.fullPath;

// File name is "space.jpg"
final name = spaceRef.name;

// Points to "images"
imagesRef = spaceRef.parent;

Ensuite, découvrons comment importer des fichiers dans Cloud Storage.