Cloud Storage for Firebase تتيح لكم تحميل الملفات بسرعة وسهولة إلى مساحة تخزين سحابي في Cloud Storage توفّرها Firebase وتديرها.
تحميل ملفات
لتحميل ملف إلى Cloud Storage، عليكم أولاً إنشاء مرجع إلى الـ مسار الكامل للملف، بما في ذلك اسم الملف.
Web
import { getStorage, ref } from "firebase/storage"; // Create a root reference const storage = getStorage(); // Create a reference to 'mountains.jpg' const mountainsRef = ref(storage, 'mountains.jpg'); // Create a reference to 'images/mountains.jpg' const mountainImagesRef = ref(storage, 'images/mountains.jpg'); // While the file names are the same, the references point to different files mountainsRef.name === mountainImagesRef.name; // true mountainsRef.fullPath === mountainImagesRef.fullPath; // false
Web
// Create a root reference var storageRef = firebase.storage().ref(); // Create a reference to 'mountains.jpg' var mountainsRef = storageRef.child('mountains.jpg'); // Create a reference to 'images/mountains.jpg' var mountainImagesRef = storageRef.child('images/mountains.jpg'); // While the file names are the same, the references point to different files mountainsRef.name === mountainImagesRef.name; // true mountainsRef.fullPath === mountainImagesRef.fullPath; // false
التحميل من Blob أو File
بعد إنشاء مرجع مناسب، عليكم استدعاء طريقة uploadBytes(). تأخذ uploadBytes() الملفات من خلال واجهات JavaScript
File و
Blob البرمجية وتحمّلها إلى Cloud Storage.
Web
import { getStorage, ref, uploadBytes } from "firebase/storage"; const storage = getStorage(); const storageRef = ref(storage, 'some-child'); // 'file' comes from the Blob or File API uploadBytes(storageRef, file).then((snapshot) => { console.log('Uploaded a blob or file!'); });
Web
// 'file' comes from the Blob or File API ref.put(file).then((snapshot) => { console.log('Uploaded a blob or file!'); });
التحميل من مصفوفة بايت
بالإضافة إلى نوعَي File وBlob، يمكن لـ uploadBytes() أيضًا تحميل
Uint8Array إلى Cloud Storage.
Web
import { getStorage, ref, uploadBytes } from "firebase/storage"; const storage = getStorage(); const storageRef = ref(storage, 'some-child'); const bytes = new Uint8Array([0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x2c, 0x20, 0x77, 0x6f, 0x72, 0x6c, 0x64, 0x21]); uploadBytes(storageRef, bytes).then((snapshot) => { console.log('Uploaded an array!'); });
Web
var bytes = new Uint8Array([0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x2c, 0x20, 0x77, 0x6f, 0x72, 0x6c, 0x64, 0x21]); ref.put(bytes).then((snapshot) => { console.log('Uploaded an array!'); });
التحميل من سلسلة
إذا لم يتوفّر Blob أو File أو Uint8Array، يمكنكم استخدام طريقة
uploadString() لتحميل سلسلة خام أو مشفّرة باستخدام base64 أو base64url أو data_url
إلى Cloud Storage.
Web
import { getStorage, ref, uploadString } from "firebase/storage"; const storage = getStorage(); const storageRef = ref(storage, 'some-child'); // Raw string is the default if no format is provided const message = 'This is my message.'; uploadString(storageRef, message).then((snapshot) => { console.log('Uploaded a raw string!'); }); // Base64 formatted string const message2 = '5b6p5Y+344GX44G+44GX44Gf77yB44GK44KB44Gn44Go44GG77yB'; uploadString(storageRef, message2, 'base64').then((snapshot) => { console.log('Uploaded a base64 string!'); }); // Base64url formatted string const message3 = '5b6p5Y-344GX44G-44GX44Gf77yB44GK44KB44Gn44Go44GG77yB'; uploadString(storageRef, message3, 'base64url').then((snapshot) => { console.log('Uploaded a base64url string!'); }); // Data URL string const message4 = 'data:text/plain;base64,5b6p5Y+344GX44G+44GX44Gf77yB44GK44KB44Gn44Go44GG77yB'; uploadString(storageRef, message4, 'data_url').then((snapshot) => { console.log('Uploaded a data_url string!'); });
Web
// Raw string is the default if no format is provided var message = 'This is my message.'; ref.putString(message).then((snapshot) => { console.log('Uploaded a raw string!'); }); // Base64 formatted string var message = '5b6p5Y+344GX44G+44GX44Gf77yB44GK44KB44Gn44Go44GG77yB'; ref.putString(message, 'base64').then((snapshot) => { console.log('Uploaded a base64 string!'); }); // Base64url formatted string var message = '5b6p5Y-344GX44G-44GX44Gf77yB44GK44KB44Gn44Go44GG77yB'; ref.putString(message, 'base64url').then((snapshot) => { console.log('Uploaded a base64url string!'); }); // Data URL string var message = 'data:text/plain;base64,5b6p5Y+344GX44G+44GX44Gf77yB44GK44KB44Gn44Go44GG77yB'; ref.putString(message, 'data_url').then((snapshot) => { console.log('Uploaded a data_url string!'); });
بما أنّ المرجع يحدّد المسار الكامل للملف، تأكّدوا من التحميل إلى مسار غير فارغ.
إضافة البيانات الوصفية للملف
عند تحميل ملف، يمكنكم أيضًا تحديد بياناته الوصفية.
تحتوي هذه البيانات الوصفية على خصائص البيانات الوصفية النموذجية للملف، مثل name وsize وcontentType (يُشار إليها عادةً باسم نوع MIME). Cloud Storage
يستنتج تلقائيًا نوع المحتوى من امتداد الملف المخزّن على القرص، ولكن إذا حدّدتم contentType في البيانات الوصفية، سيتم
استبدال النوع الذي تم رصده تلقائيًا. إذا لم يتم تحديد بيانات وصفية من نوع contentType ولم يكن للملف امتداد، سيستخدم Cloud Storage تلقائيًا النوع application/octet-stream. يمكنكم الاطّلاع على مزيد من المعلومات عن البيانات الوصفية للملف
في قسم استخدام البيانات الوصفية للملف.
Web
import { getStorage, ref, uploadBytes } from "firebase/storage"; const storage = getStorage(); const storageRef = ref(storage, 'images/mountains.jpg'); // Create file metadata including the content type /** @type {any} */ const metadata = { contentType: 'image/jpeg', }; // Upload the file and metadata const uploadTask = uploadBytes(storageRef, file, metadata);
Web
// Create file metadata including the content type var metadata = { contentType: 'image/jpeg', }; // Upload the file and metadata var uploadTask = storageRef.child('images/mountains.jpg').put(file, metadata);
إدارة التحميلات
بالإضافة إلى بدء عمليات التحميل، يمكنكم إيقافها مؤقتًا واستئنافها وإلغاؤها باستخدام الطرق pause() وresume() وcancel(). سيؤدي استدعاء pause() أو
resume() إلى إظهار تغييرات الحالة pause أو running. يؤدي استدعاء طريقة cancel() إلى تعذُّر التحميل وعرض خطأ يشير إلى أنّه تم إلغاء التحميل.
Web
import { getStorage, ref, uploadBytesResumable } from "firebase/storage"; const storage = getStorage(); const storageRef = ref(storage, 'images/mountains.jpg'); // Upload the file and metadata const uploadTask = uploadBytesResumable(storageRef, file); // Pause the upload uploadTask.pause(); // Resume the upload uploadTask.resume(); // Cancel the upload uploadTask.cancel();
Web
// Upload the file and metadata var uploadTask = storageRef.child('images/mountains.jpg').put(file); // Pause the upload uploadTask.pause(); // Resume the upload uploadTask.resume(); // Cancel the upload uploadTask.cancel();
مراقبة تقدّم التحميل
أثناء التحميل، قد تُظهر مهمة التحميل أحداث تقدّم في أداة مراقبة state_changed، مثل:
| نوع الحدث | الاستخدام النموذجي |
|---|---|
running |
يتم تفعيل هذا الحدث عند بدء المهمة أو استئناف تحميلها، وغالبًا ما يتم استخدامه بالاقتران مع الحدث pause. بالنسبة إلى عمليات التحميل الأكبر حجمًا
قد يتم تفعيل هذا الحدث عدة مرات كإشعار بتقدّم التحميل. |
pause |
يتم تفعيل هذا الحدث في أي وقت يتم فيه إيقاف التحميل مؤقتًا، وغالبًا ما يتم استخدامه بالاقتران مع الحدث running. |
عند وقوع حدث، يتم إرجاع كائن TaskSnapshot. هذه اللقطة هي عرض غير قابل للتغيير للمهمة في وقت وقوع الحدث.
ويحتوي هذا الكائن على الخصائص التالية:
| الموقع | النوع | الوصف |
|---|---|---|
bytesTransferred |
Number |
إجمالي عدد البايت التي تم نقلها عند أخذ هذه اللقطة |
totalBytes |
Number |
إجمالي عدد البايت المطلوب تحميلها |
state |
firebase.storage.TaskState |
الحالة الحالية للتحميل |
metadata |
firebaseStorage.Metadata |
البيانات الوصفية التي تم إرسالها إلى الخادم قبل اكتمال التحميل البيانات الوصفية التي أرسلها الخادم بعد اكتمال التحميل |
task |
firebaseStorage.UploadTask |
المهمة التي تم أخذ هذه اللقطة منها، والتي يمكن استخدامها لـ إيقاف المهمة مؤقتًا أو استئنافها أو إلغاؤها |
ref |
firebaseStorage.Reference |
المرجع الذي أتت منه هذه المهمة |
توفّر هذه التغييرات في الحالة، بالإضافة إلى خصائص TaskSnapshot، طريقة بسيطة وفعّالة لمراقبة أحداث التحميل.
Web
import { getStorage, ref, uploadBytesResumable, getDownloadURL } from "firebase/storage"; const storage = getStorage(); const storageRef = ref(storage, 'images/rivers.jpg'); const uploadTask = uploadBytesResumable(storageRef, file); // Register three observers: // 1. 'state_changed' observer, called any time the state changes // 2. Error observer, called on failure // 3. Completion observer, called on successful completion uploadTask.on('state_changed', (snapshot) => { // Observe state change events such as progress, pause, and resume // Get task progress, including the number of bytes uploaded and the total number of bytes to be uploaded const progress = (snapshot.bytesTransferred / snapshot.totalBytes) * 100; console.log('Upload is ' + progress + '% done'); switch (snapshot.state) { case 'paused': console.log('Upload is paused'); break; case 'running': console.log('Upload is running'); break; } }, (error) => { // Handle unsuccessful uploads }, () => { // Handle successful uploads on complete // For instance, get the download URL: https://firebasestorage.googleapis.com/... getDownloadURL(uploadTask.snapshot.ref).then((downloadURL) => { console.log('File available at', downloadURL); }); } );
Web
var uploadTask = storageRef.child('images/rivers.jpg').put(file); // Register three observers: // 1. 'state_changed' observer, called any time the state changes // 2. Error observer, called on failure // 3. Completion observer, called on successful completion uploadTask.on('state_changed', (snapshot) => { // Observe state change events such as progress, pause, and resume // Get task progress, including the number of bytes uploaded and the total number of bytes to be uploaded var progress = (snapshot.bytesTransferred / snapshot.totalBytes) * 100; console.log('Upload is ' + progress + '% done'); switch (snapshot.state) { case firebase.storage.TaskState.PAUSED: // or 'paused' console.log('Upload is paused'); break; case firebase.storage.TaskState.RUNNING: // or 'running' console.log('Upload is running'); break; } }, (error) => { // Handle unsuccessful uploads }, () => { // Handle successful uploads on complete // For instance, get the download URL: https://firebasestorage.googleapis.com/... uploadTask.snapshot.ref.getDownloadURL().then((downloadURL) => { console.log('File available at', downloadURL); }); } );
خطأ أثناء المعالجة
هناك عدد من الأسباب التي قد تؤدي إلى حدوث أخطاء أثناء التحميل، بما في ذلك عدم توفّر الملف المحلي أو عدم حصول المستخدِم على إذن لتحميل الملف المطلوب. يمكنكم الاطّلاع على مزيد من المعلومات عن الأخطاء في الـ قسم معالجة الأخطاء في المستندات.
مثال كامل
في ما يلي مثال كامل على عملية تحميل مع مراقبة تقدّم التحميل ومعالجة الأخطاء:
Web
import { getStorage, ref, uploadBytesResumable, getDownloadURL } from "firebase/storage"; const storage = getStorage(); // Create the file metadata /** @type {any} */ const metadata = { contentType: 'image/jpeg' }; // Upload file and metadata to the object 'images/mountains.jpg' const storageRef = ref(storage, 'images/' + file.name); const uploadTask = uploadBytesResumable(storageRef, file, metadata); // Listen for state changes, errors, and completion of the upload. uploadTask.on('state_changed', (snapshot) => { // Get task progress, including the number of bytes uploaded and the total number of bytes to be uploaded const progress = (snapshot.bytesTransferred / snapshot.totalBytes) * 100; console.log('Upload is ' + progress + '% done'); switch (snapshot.state) { case 'paused': console.log('Upload is paused'); break; case 'running': console.log('Upload is running'); break; } }, (error) => { // A full list of error codes is available at // https://firebase.google.com/docs/storage/web/handle-errors switch (error.code) { 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 error.serverResponse break; } }, () => { // Upload completed successfully, now we can get the download URL getDownloadURL(uploadTask.snapshot.ref).then((downloadURL) => { console.log('File available at', downloadURL); }); } );
Web
// Create the file metadata var metadata = { contentType: 'image/jpeg' }; // Upload file and metadata to the object 'images/mountains.jpg' var uploadTask = storageRef.child('images/' + file.name).put(file, metadata); // Listen for state changes, errors, and completion of the upload. uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, // or 'state_changed' (snapshot) => { // Get task progress, including the number of bytes uploaded and the total number of bytes to be uploaded var progress = (snapshot.bytesTransferred / snapshot.totalBytes) * 100; console.log('Upload is ' + progress + '% done'); switch (snapshot.state) { case firebase.storage.TaskState.PAUSED: // or 'paused' console.log('Upload is paused'); break; case firebase.storage.TaskState.RUNNING: // or 'running' console.log('Upload is running'); break; } }, (error) => { // A full list of error codes is available at // https://firebase.google.com/docs/storage/web/handle-errors switch (error.code) { 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 error.serverResponse break; } }, () => { // Upload completed successfully, now we can get the download URL uploadTask.snapshot.ref.getDownloadURL().then((downloadURL) => { console.log('File available at', downloadURL); }); } );
بعد تحميل الملفات، لننتقل إلى كيفية تنزيلها من Cloud Storage.