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

Vos fichiers sont stockés dans un bucket Cloud Storage . Les fichiers de ce compartiment 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 accède. Ces références peuvent ensuite être utilisées pour télécharger 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. Cependant, vos données de fichiers sont stockées dans Cloud Storage et non dans la base de données en temps réel.

Créer une référence

Créez une référence pour charger, 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 vous le souhaitez. 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();

Ensuite, 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"
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 notre hiérarchie de fichiers. parent monte d'un niveau, tandis que root navigue jusqu'au sommet.

// 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. Mais accéder root.parent entraîne 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 vers lesquels elles pointent à l’aide des propriétés fullPath , name et bucket . Ces propriétés obtiennent le chemin complet, le nom et le compartiment 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 des références

Les chemins et noms de référence peuvent contenir n'importe quelle séquence de caractères Unicode valides, mais certaines restrictions sont imposées, notamment :

  1. La longueur totale de reference.fullPath doit être comprise entre 1 et 1 024 octets lorsqu’elle est codée en UTF-8.
  2. Pas de caractères de retour chariot ou de saut de ligne.
  3. Évitez d'utiliser # , [ , ] , * ou ? , car ceux-ci 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;

Voyons ensuite comment télécharger des fichiers sur Cloud Storage.