Créer une référence Cloud Storage sur le Web

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é la Firebase Realtime Database , ces chemins devraient vous sembler très familiers. Cependant, vos données de fichier sont stockées dans Cloud Storage, et non dans la base de données en temps réel.

Créer une référence

Pour charger ou télécharger des fichiers, supprimer des fichiers ou obtenir ou mettre à jour des métadonnées, vous devez créer une référence au fichier sur lequel vous souhaitez opérer. 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, et elles sont également réutilisables pour plusieurs opérations.

Pour créer une référence, obtenez une instance du service de stockage à 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.

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);
storage_create_ref.js

// 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();
create-reference.js

Vous pouvez créer une référence à un emplacement plus bas dans l'arborescence, par exemple 'images/space.jpg' en passant ce chemin comme deuxième argument lors de l'appel ref() .

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"
storage_create_ref_child.js

// 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"
create-reference.js

Naviguer avec des références

Vous pouvez également utiliser les propriétés parent et root pour remonter dans la hiérarchie des fichiers. parent navigue vers le haut d'un niveau, tandis que root navigue jusqu'au sommet.

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
storage_navigate_ref.js

// 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
create-reference.js

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 null .

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;
storage_navigate_ref_chain.js

// 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;
create-reference.js

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 d'accès complet du fichier, le nom du fichier et le compartiment dans lequel le fichier est stocké.

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;
storage_ref_properties.js

// 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;
create-reference.js

Limitations sur les 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 1024 octets lorsqu'il est encodé en UTF-8.
2. Aucun caractère 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

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;
storage_ref_full_example.js

// 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;
create-reference.js

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