Cloud Storage for Firebase vous permet de télécharger rapidement et facilement des fichiers à partir d'un Cloud Storage bucket fourni et géré par Firebase.
Créer une référence
Pour télécharger un fichier, commencez par créer une Cloud Storage référence au fichier que vous souhaitez télécharger.
Vous pouvez créer une référence en ajoutant des chemins enfants à la racine de votre
Cloud Storage bucket ou à partir d'une URL
gs:// ou https:// existante faisant référence à un objet dans Cloud Storage.
Web
import { getStorage, ref } from "firebase/storage"; // Create a reference with an initial file path and name const storage = getStorage(); const pathReference = ref(storage, 'images/stars.jpg'); // Create a reference from a Google Cloud Storage URI const gsReference = ref(storage, 'gs://bucket/images/stars.jpg'); // Create a reference from an HTTPS URL // Note that in the URL, characters are URL escaped! const httpsReference = ref(storage, 'https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg');
Web
// Create a reference with an initial file path and name var storage = firebase.storage(); var pathReference = storage.ref('images/stars.jpg'); // Create a reference from a Google Cloud Storage URI var gsReference = storage.refFromURL('gs://bucket/images/stars.jpg'); // Create a reference from an HTTPS URL // Note that in the URL, characters are URL escaped! var httpsReference = storage.refFromURL('https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg');
Télécharger des données via une URL
Vous pouvez obtenir l'URL de téléchargement d'un fichier en appelant la
getDownloadURL() méthode sur une Cloud Storage référence.
Web
import { getStorage, ref, getDownloadURL } from "firebase/storage"; const storage = getStorage(); getDownloadURL(ref(storage, 'images/stars.jpg')) .then((url) => { // `url` is the download URL for 'images/stars.jpg' // This can be downloaded directly: const xhr = new XMLHttpRequest(); xhr.responseType = 'blob'; xhr.onload = (event) => { const blob = xhr.response; }; xhr.open('GET', url); xhr.send(); // Or inserted into an <img> element const img = document.getElementById('myimg'); img.setAttribute('src', url); }) .catch((error) => { // Handle any errors });
Web
storageRef.child('images/stars.jpg').getDownloadURL() .then((url) => { // `url` is the download URL for 'images/stars.jpg' // This can be downloaded directly: var xhr = new XMLHttpRequest(); xhr.responseType = 'blob'; xhr.onload = (event) => { var blob = xhr.response; }; xhr.open('GET', url); xhr.send(); // Or inserted into an <img> element var img = document.getElementById('myimg'); img.setAttribute('src', url); }) .catch((error) => { // Handle any errors });
Télécharger des données directement à partir du SDK
À partir de la version 9.5, le SDK fournit les fonctions suivantes pour le téléchargement direct :
Ces fonctions vous permettent de contourner le téléchargement à partir d'une URL et de renvoyer des données dans votre code. Cela permet un contrôle des accès plus précis via Firebase Security Rules.
Configuration CORS
Pour télécharger des données directement dans le navigateur, vous devez configurer votre
Cloud Storage bucket pour l'accès entre origines multiples (CORS). Vous pouvez le faire
avec l'outil de ligne de commande gsutil, que vous pouvez
installer ici.
Si vous ne souhaitez aucune restriction basée sur le domaine (le scénario le plus courant),
copiez ce JSON dans un fichier nommé cors.json :
[
{
"origin": ["*"],
"method": ["GET"],
"maxAgeSeconds": 3600
}
]Exécutez gsutil cors set cors.json gs://<your-cloud-storage-bucket> pour déployer
ces restrictions.
Pour en savoir plus, consultez la Google Cloud Storage documentation.
Gérer les erreurs
Plusieurs raisons peuvent expliquer les erreurs de téléchargement, y compris le fichier inexistant ou le manque d'autorisation de l'utilisateur pour accéder au fichier souhaité. Pour en savoir plus sur les erreurs, consultez la section Gérer les erreurs de la documentation.
Exemple complet
Vous trouverez ci-dessous un exemple complet de téléchargement avec gestion des erreurs :
Web
import { getStorage, ref, getDownloadURL } from "firebase/storage"; // Create a reference to the file we want to download const storage = getStorage(); const starsRef = ref(storage, 'images/stars.jpg'); // Get the download URL getDownloadURL(starsRef) .then((url) => { // Insert url into an <img> tag to "download" }) .catch((error) => { // A full list of error codes is available at // https://firebase.google.com/docs/storage/web/handle-errors switch (error.code) { case 'storage/object-not-found': // File doesn't exist break; case 'storage/unauthorized': // User doesn't have permission to access the object break; case 'storage/canceled': // User canceled the upload break; // ... case 'storage/unknown': // Unknown error occurred, inspect the server response break; } });
Web
// Create a reference to the file we want to download var starsRef = storageRef.child('images/stars.jpg'); // Get the download URL starsRef.getDownloadURL() .then((url) => { // Insert url into an <img> tag to "download" }) .catch((error) => { // A full list of error codes is available at // https://firebase.google.com/docs/storage/web/handle-errors switch (error.code) { case 'storage/object-not-found': // File doesn't exist break; case 'storage/unauthorized': // User doesn't have permission to access the object break; case 'storage/canceled': // User canceled the upload break; // ... case 'storage/unknown': // Unknown error occurred, inspect the server response break; } });
Vous pouvez également obtenir ou mettre à jour les métadonnées des fichiers stockés dans Cloud Storage.