Vos fichiers sont stockés dans un Cloud Storage. La les fichiers de ce bucket sont présentés dans une structure hiérarchique, système de fichiers sur votre disque dur local ou les données dans le 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 désigner un fichier spécifique ou un niveau supérieur. dans la hiérarchie.
Si vous avez utilisé Firebase Realtime Database, ces chemins d'accès doivent vous semble très familier. Toutefois, les données de vos fichiers sont stockées Cloud Storage, pas dans Realtime Database.
Créer une référence
Pour importer ou télécharger des fichiers, les supprimer, ou obtenir ou mettre à jour des métadonnées, vous devez créer une référence au fichier sur lequel vous souhaitez effectuer des opérations. Une référence peut être considérée comme un pointeur vers un fichier dans le cloud. Les références sont afin que vous puissiez en créer autant que vous le souhaitez. Ils sont aussi réutilisables plusieurs opérations.
Pour créer une référence, obtenez une instance du service Storage à l'aide de
getStorage()
, puis appelez ref()
avec le service comme argument.
Cette référence pointe vers la racine de votre bucket Cloud Storage.
Web
import { getStorage, ref } from "firebase/storage"; // Get a reference to the storage service, which is used to create references in your storage bucket const storage = getStorage(); // Create a storage reference from our storage service const storageRef = ref(storage);
Web
// Get a reference to the storage service, which is used to create references in your storage bucket var storage = firebase.storage(); // Create a storage reference from our storage service var storageRef = storage.ref();
Vous pouvez créer une référence à un
emplacement plus bas dans l'arborescence,
dites 'images/space.jpg'
en transmettant ce chemin comme deuxième argument lorsque
Appel de ref()
en cours.
Web
import { getStorage, ref } from "firebase/storage"; const storage = getStorage(); // Create a child reference const imagesRef = ref(storage, 'images'); // imagesRef now points to 'images' // Child references can also take paths delimited by '/' const spaceRef = ref(storage, 'images/space.jpg'); // spaceRef now points to "images/space.jpg" // imagesRef still points to "images"
Web
// Create a child reference var imagesRef = storageRef.child('images'); // imagesRef now points to 'images' // Child references can also take paths delimited by '/' var spaceRef = storageRef.child('images/space.jpg'); // spaceRef now points to "images/space.jpg" // imagesRef still points to "images"
Naviguer avec des références
Vous pouvez également utiliser les propriétés parent
et root
pour remonter
la hiérarchie des fichiers. parent
permet de monter d'un niveau, tandis que root
permet de monter jusqu'en haut.
Web
import { getStorage, ref } from "firebase/storage"; const storage = getStorage(); const spaceRef = ref(storage, 'images/space.jpg'); // Parent allows us to move to the parent of a reference const imagesRef = spaceRef.parent; // imagesRef now points to 'images' // Root allows us to move all the way back to the top of our bucket const rootRef = spaceRef.root; // rootRef now points to the root
Web
// Parent allows us to move to the parent of a reference var imagesRef = spaceRef.parent; // imagesRef now points to 'images' // Root allows us to move all the way back to the top of our bucket var rootRef = spaceRef.root; // rootRef now points to the root
child()
, parent
et root
peuvent être chaînés plusieurs fois, car
renvoie chacune une référence. L'exception est parent
de root
, qui
est null
.
Web
import { getStorage, ref } from "firebase/storage"; const storage = getStorage(); const spaceRef = ref(storage, 'images/space.jpg'); // References can be chained together multiple times const earthRef = ref(spaceRef.parent, 'earth.jpg'); // earthRef points to 'images/earth.jpg' // nullRef is null, since the parent of root is null const nullRef = spaceRef.root.parent;
Web
// References can be chained together multiple times var earthRef = spaceRef.parent.child('earth.jpg'); // earthRef points to 'images/earth.jpg' // nullRef is null, since the parent of root is null var 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 renvoient
à l'aide des propriétés fullPath
, name
et bucket
. Ces propriétés
obtenir le chemin d'accès complet du fichier, le nom du fichier,
et le bucket dans lequel
le fichier est stocké.
Web
import { getStorage, ref } from "firebase/storage"; const storage = getStorage(); const spaceRef = ref(storage, 'images/space.jpg'); // 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 where files are stored spaceRef.bucket;
Web
// 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 where files are stored spaceRef.bucket;
Limites applicables aux 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 lors de l'encodage UTF-8. - Les caractères de retour chariot ou de saut de ligne ne sont pas autorisés.
- Évitez d'utiliser
#
,[
,]
,*
ou?
, car ils ne fonctionnent pas bien avec à d'autres outils tels que Firebase Realtime Database ; ou gsutil.
Exemple complet
Web
import { getStorage, ref } from "firebase/storage"; const storage = getStorage(); // Points to the root reference const storageRef = ref(storage); // Points to 'images' const imagesRef = ref(storageRef, 'images'); // Points to 'images/space.jpg' // Note that you can use variables to create child values const fileName = 'space.jpg'; const spaceRef = ref(imagesRef, fileName); // File path is 'images/space.jpg' const path = spaceRef.fullPath; // File name is 'space.jpg' const name = spaceRef.name; // Points to 'images' const imagesRefAgain = spaceRef.parent;
Web
// Points to the root reference var storageRef = firebase.storage().ref(); // Points to 'images' var imagesRef = storageRef.child('images'); // Points to 'images/space.jpg' // Note that you can use variables to create child values var fileName = 'space.jpg'; var spaceRef = imagesRef.child(fileName); // File path is 'images/space.jpg' var path = spaceRef.fullPath; // File name is 'space.jpg' var name = spaceRef.name; // Points to 'images' var imagesRef = spaceRef.parent;
Ensuite, apprenons à importer des fichiers dans Cloud Storage