Cloud Storage for Firebase מאפשר לכם להוריד במהירות ובקלות קבצים ממאגר (bucket) של Cloud Storage שסופק ומנוהל על ידי Firebase.
יצירת קובץ עזר
כדי להוריד קובץ, קודם צריך ליצור הפניה Cloud Storage לקובץ שרוצים להוריד.
כדי ליצור הפניה, אפשר להוסיף נתיבי צאצא לשורש של קטגוריית Cloud Storage, או ליצור הפניה מכתובת URL קיימת של Cloud Storage או של https://
שמפנה לאובייקט ב-Cloud Storage.gs://
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');
הורדת נתונים באמצעות כתובת URL
אפשר לקבל את כתובת ה-URL להורדה של קובץ על ידי קריאה לשיטה getDownloadURL()
בהפניה Cloud Storage.
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 });
הורדת נתונים ישירות מה-SDK
מגרסה 9.5 ואילך, ה-SDK מספק את הפונקציות האלה להורדה ישירה:
באמצעות הפונקציות האלה, אתם יכולים לדלג על ההורדה מכתובת URL, ובמקום זאת להחזיר נתונים בקוד. כך אפשר לנהל בקרת גישה פרטנית באמצעות Firebase Security Rules.
הגדרות CORS
כדי להוריד נתונים ישירות בדפדפן, צריך להגדיר את קטגוריית Cloud Storage לגישה חוצת-מקורות (CORS). אפשר לעשות את זה באמצעות כלי שורת הפקודה gsutil
, שאפשר להתקין מכאן.
אם לא רוצים להגביל את הגישה על בסיס דומיין (התרחיש הנפוץ ביותר),
מעתיקים את קובץ ה-JSON הזה לקובץ בשם cors.json
:
[ { "origin": ["*"], "method": ["GET"], "maxAgeSeconds": 3600 } ]
מריצים את הפקודה gsutil cors set cors.json gs://<your-cloud-storage-bucket>
כדי לפרוס את ההגבלות האלה.
מידע נוסף זמין בGoogle Cloud Storageמאמרי העזרה.
טיפול בשגיאות
יכולות להיות כמה סיבות לשגיאות בהורדה, כולל העובדה שהקובץ לא קיים או שאין למשתמש הרשאה לגשת לקובץ הרצוי. מידע נוסף על שגיאות זמין בקטע Handle Errors במסמכים.
דוגמה מלאה
דוגמה מלאה להורדה עם טיפול בשגיאות מוצגת בהמשך:
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; } });
אפשר גם לקבל או לעדכן מטא-נתונים של קבצים שמאוחסנים ב-Cloud Storage.