تتيح لك أداة Cloud Storage for Firebase تنزيل الملفات بسرعة وسهولة من حزمة Cloud Storage التي توفّرها Firebase وتديرها.
إنشاء مرجع
لتنزيل ملف، عليك أولاً إنشاء مرجع Cloud Storage للملف الذي تريد تنزيله.
يمكنك إنشاء مرجع من خلال إلحاق مسارات فرعية بجذر حزمة Cloud Storage، أو يمكنك إنشاء مرجع من عنوان URL حالي لـ gs:// أو https:// يشير إلى عنصر في Cloud Storage.
Swift
// Create a reference with an initial file path and name let pathReference = storage.reference(withPath: "images/stars.jpg") // Create a reference from a Google Cloud Storage URI let gsReference = storage.reference(forURL: "gs://<your-firebase-storage-bucket>/images/stars.jpg") // Create a reference from an HTTPS URL // Note that in the URL, characters are URL escaped! let httpsReference = storage.reference(forURL: "https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg")
Objective-C
// Create a reference with an initial file path and name FIRStorageReference *pathReference = [storage referenceWithPath:@"images/stars.jpg"]; // Create a reference from a Google Cloud Storage URI FIRStorageReference *gsReference = [storage referenceForURL:@"gs://<your-firebase-storage-bucket>/images/stars.jpg"]; // Create a reference from an HTTPS URL // Note that in the URL, characters are URL escaped! FIRStorageReference *httpsReference = [storage referenceForURL:@"https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg"];
تنزيل الملفات
بعد الحصول على مرجع، يمكنك تنزيل الملفات من Cloud Storage بثلاث طرق:
- تنزيل إلى
NSDataفي الذاكرة - التنزيل إلى
NSURLيمثّل ملفًا على الجهاز - إنشاء
NSURLيمثّل الملف على الإنترنت
تنزيل الذكريات
نزِّل الملف إلى كائن NSData في الذاكرة باستخدام طريقة dataWithMaxSize:completion:. هذه هي أسهل طريقة لتنزيل ملف بسرعة، ولكن يجب تحميل محتويات الملف بالكامل في الذاكرة.
إذا طلبت ملفًا أكبر من الذاكرة المتاحة لتطبيقك، سيتعطّل
التطبيق. للحماية من مشاكل الذاكرة، تأكَّد من ضبط الحد الأقصى للحجم
على قيمة يمكن لتطبيقك التعامل معها، أو استخدِم طريقة
تنزيل أخرى.
Swift
// Create a reference to the file you want to download let islandRef = storageRef.child("images/island.jpg") // Download in memory with a maximum allowed size of 1MB (1 * 1024 * 1024 bytes) islandRef.getData(maxSize: 1 * 1024 * 1024) { data, error in if let error = error { // Uh-oh, an error occurred! } else { // Data for "images/island.jpg" is returned let image = UIImage(data: data!) } }
Objective-C
// Create a reference to the file you want to download FIRStorageReference *islandRef = [storageRef child:@"images/island.jpg"]; // Download in memory with a maximum allowed size of 1MB (1 * 1024 * 1024 bytes) [islandRef dataWithMaxSize:1 * 1024 * 1024 completion:^(NSData *data, NSError *error){ if (error != nil) { // Uh-oh, an error occurred! } else { // Data for "images/island.jpg" is returned UIImage *islandImage = [UIImage imageWithData:data]; } }];
التنزيل إلى ملف على الجهاز
تنزّل طريقة writeToFile:completion: ملفًا مباشرةً على جهاز محلي. يمكنك استخدام هذه الطريقة إذا أراد المستخدمون الوصول إلى الملف بلا إنترنت أو مشاركته في تطبيق مختلف. تعرض writeToFile:completion: FIRStorageDownloadTask يمكنك استخدامه لإدارة عملية التنزيل ومراقبة حالة التحميل.
Swift
// Create a reference to the file you want to download let islandRef = storageRef.child("images/island.jpg") // Create local filesystem URL let localURL = URL(string: "path/to/image")! // Download to the local filesystem let downloadTask = islandRef.write(toFile: localURL) { url, error in if let error = error { // Uh-oh, an error occurred! } else { // Local file URL for "images/island.jpg" is returned } }
Objective-C
// Create a reference to the file you want to download FIRStorageReference *islandRef = [storageRef child:@"images/island.jpg"]; // Create local filesystem URL NSURL *localURL = [NSURL URLWithString:@"path/to/image"]; // Download to the local filesystem FIRStorageDownloadTask *downloadTask = [islandRef writeToFile:localURL completion:^(NSURL *URL, NSError *error){ if (error != nil) { // Uh-oh, an error occurred! } else { // Local file URL for "images/island.jpg" is returned } }];
إذا أردت إدارة عملية التنزيل بشكل نشط، يمكنك استخدام طريقة writeToFile: ومراقبة مهمة التنزيل، بدلاً من استخدام معالج الإكمال.
لمزيد من المعلومات، يُرجى الاطّلاع على إدارة عمليات التنزيل.
إنشاء عنوان URL للتنزيل
إذا كانت لديك بنية أساسية للتنزيل تستند إلى عناوين URL، أو إذا أردت فقط
عنوان URL لمشاركته، يمكنك الحصول على عنوان URL لتنزيل ملف من خلال استدعاء
الطريقة downloadURLWithCompletion: في مرجع Cloud Storage.
Swift
// Create a reference to the file you want to download let starsRef = storageRef.child("images/stars.jpg") // Fetch the download URL starsRef.downloadURL { url, error in if let error = error { // Handle any errors } else { // Get the download URL for 'images/stars.jpg' } }
Objective-C
// Create a reference to the file you want to download FIRStorageReference *starsRef = [storageRef child:@"images/stars.jpg"]; // Fetch the download URL [starsRef downloadURLWithCompletion:^(NSURL *URL, NSError *error){ if (error != nil) { // Handle any errors } else { // Get the download URL for 'images/stars.jpg' } }];
تنزيل الصور باستخدام FirebaseUI
توفّر FirebaseUI عمليات ربط بسيطة وقابلة للتخصيص وجاهزة للإنتاج على الأجهزة الجوّالة لإزالة الرموز البرمجية النموذجية والترويج لأفضل ممارسات Google. باستخدام FirebaseUI، يمكنك تنزيل الصور وتخزينها مؤقتًا وعرضها بسرعة وسهولة من Cloud Storage باستخدام عملية الدمج مع SDWebImage.
أولاً، أضِف FirebaseUI إلى Podfile:
pod 'FirebaseStorageUI'
بعد ذلك، يمكنك تحميل الصور مباشرةً من "Cloud Storage" إلى
"UIImageView":
Swift
// Reference to an image file in Firebase Storage let reference = storageRef.child("images/stars.jpg") // UIImageView in your ViewController let imageView: UIImageView = self.imageView // Placeholder image let placeholderImage = UIImage(named: "placeholder.jpg") // Load the image using SDWebImage imageView.sd_setImage(with: reference, placeholderImage: placeholderImage)
Objective-C
// Reference to an image file in Firebase Storage FIRStorageReference *reference = [storageRef child:@"images/stars.jpg"]; // UIImageView in your ViewController UIImageView *imageView = self.imageView; // Placeholder image UIImage *placeholderImage; // Load the image using SDWebImage [imageView sd_setImageWithStorageReference:reference placeholderImage:placeholderImage];
إدارة عمليات التنزيل
بالإضافة إلى بدء عمليات التنزيل، يمكنك إيقافها مؤقتًا واستئنافها وإلغاؤها باستخدام الطرق pause وresume وcancel. تؤدي هذه الطرق إلى ظهور أحداث pause وresume وcancel التي يمكنك ملاحظتها.
Swift
// Start downloading a file let downloadTask = storageRef.child("images/mountains.jpg").write(toFile: localFile) // Pause the download downloadTask.pause() // Resume the download downloadTask.resume() // Cancel the download downloadTask.cancel()
Objective-C
// Start downloading a file FIRStorageDownloadTask *downloadTask = [[storageRef child:@"images/mountains.jpg"] writeToFile:localFile]; // Pause the download [downloadTask pause]; // Resume the download [downloadTask resume]; // Cancel the download [downloadTask cancel];
مراقبة مستوى تقدُّم عملية التنزيل
يمكنك إرفاق مراقبين بـ FIRStorageDownloadTask لمراقبة
تقدّم عملية التنزيل. تؤدي إضافة مراقب إلى عرض FIRStorageHandle
يمكن استخدامه لإزالة المراقب.
Swift
// Add a progress observer to a download task let observer = downloadTask.observe(.progress) { snapshot in // A progress event occurred }
Objective-C
// Add a progress observer to a download task NSString *observer = [downloadTask observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot *snapshot) { // A progress event occurred }];
يمكن تسجيل أدوات المراقبة هذه في حدث FIRStorageTaskStatus:
| حدث `FIRStorageTaskStatus` | الاستخدام المعتاد |
|---|---|
FIRStorageTaskStatusResume |
يتم بدء هذا الحدث عندما تبدأ المهمة أو تستأنف التنزيل، وغالبًا ما يتم استخدامه مع الحدث FIRStorageTaskStatusPause. |
FIRStorageTaskStatusProgress |
يتم تنشيط هذا الحدث في أي وقت يتم فيه تنزيل البيانات من Cloud Storage، ويمكن استخدامه لتعبئة مؤشر تقدّم عملية التنزيل. |
FIRStorageTaskStatusPause |
يتم تنشيط هذا الحدث في أي وقت يتم فيه إيقاف عملية التنزيل مؤقتًا، وغالبًا ما يتم استخدامه مع الحدث FIRStorageTaskStatusResume. |
FIRStorageTaskStatusSuccess |
يتم تنشيط هذا الحدث عند اكتمال عملية تنزيل بنجاح. |
FIRStorageTaskStatusFailure |
يتم تنشيط هذا الحدث عند تعذُّر عملية تنزيل. افحص الخطأ لتحديد سبب حدوثه. |
عند وقوع حدث، يتم تمرير عنصر FIRStorageTaskSnapshot مرة أخرى. هذه اللقطة هي عرض غير قابل للتغيير للمهمة في وقت وقوع الحدث.
يحتوي هذا العنصر على السمات التالية:
| الموقع | النوع | الوصف |
|---|---|---|
progress |
NSProgress |
عنصر NSProgress يحتوي على مستوى تقدُّم عملية التنزيل |
error |
NSError |
الخطأ الذي حدث أثناء التنزيل، إن وُجد |
metadata |
FIRStorageMetadata |
nil على عمليات التنزيل |
task |
FIRStorageDownloadTask |
المهمة التي تمثّل هذه اللقطة جزءًا منها، والتي يمكن استخدامها لإدارة
(pause، resume، cancel) المهمة. |
reference |
FIRStorageReference |
المرجع الذي تم إنشاء هذه المهمة منه |
يمكنك أيضًا إزالة المراقبين، إما بشكل فردي أو حسب الحالة أو عن طريق إزالة كلهم.
Swift
// Create a task listener handle let observer = downloadTask.observe(.progress) { snapshot in // A progress event occurred } // Remove an individual observer downloadTask.removeObserver(withHandle: observer) // Remove all observers of a particular status downloadTask.removeAllObservers(for: .progress) // Remove all observers downloadTask.removeAllObservers()
Objective-C
// Create a task listener handle NSString *observer = [downloadTask observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot *snapshot) { // A progress event occurred }]; // Remove an individual observer [downloadTask removeObserverWithHandle:observer]; // Remove all observers of a particular status [downloadTask removeAllObserversForStatus:FIRStorageTaskStatusProgress]; // Remove all observers [downloadTask removeAllObservers];
لمنع تسرّب الذاكرة، تتم إزالة جميع المراقبين بعد حدوث
FIRStorageTaskStatusSuccess أو FIRStorageTaskStatusFailure.
معالجة الأخطاء
هناك عدد من الأسباب التي قد تؤدي إلى حدوث أخطاء عند عملية التنزيل، بما في ذلك عدم وجود الملف، أو عدم حصول المستخدم على الأذونات للوصول إلى الملف المطلوب. يمكنك الاطّلاع على مزيد من المعلومات حول الأخطاء في قسم معالجة الأخطاء في المستندات.
مثال كامل
في ما يلي مثال كامل على التنزيل إلى ملف على الجهاز مع معالجة الأخطاء:
Swift
// Create a reference to the file we want to download let starsRef = storageRef.child("images/stars.jpg") // Start the download (in this case writing to a file) let downloadTask = storageRef.write(toFile: localURL) // Observe changes in status downloadTask.observe(.resume) { snapshot in // Download resumed, also fires when the download starts } downloadTask.observe(.pause) { snapshot in // Download paused } downloadTask.observe(.progress) { snapshot in // Download reported progress let percentComplete = 100.0 * Double(snapshot.progress!.completedUnitCount) / Double(snapshot.progress!.totalUnitCount) } downloadTask.observe(.success) { snapshot in // Download completed successfully } // Errors only occur in the "Failure" case downloadTask.observe(.failure) { snapshot in guard let errorCode = (snapshot.error as? NSError)?.code else { return } guard let error = StorageErrorCode(rawValue: errorCode) else { return } switch (error) { case .objectNotFound: // File doesn't exist break case .unauthorized: // User doesn't have permission to access file break case .cancelled: // User cancelled the download break /* ... */ case .unknown: // Unknown error occurred, inspect the server response break default: // Another error occurred. This is a good place to retry the download. break } }
Objective-C
// Create a reference to the file we want to download FIRStorageReference *starsRef = [storageRef child:@"images/stars.jpg"]; // Start the download (in this case writing to a file) FIRStorageDownloadTask *downloadTask = [storageRef writeToFile:localURL]; // Observe changes in status [downloadTask observeStatus:FIRStorageTaskStatusResume handler:^(FIRStorageTaskSnapshot *snapshot) { // Download resumed, also fires when the download starts }]; [downloadTask observeStatus:FIRStorageTaskStatusPause handler:^(FIRStorageTaskSnapshot *snapshot) { // Download paused }]; [downloadTask observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot *snapshot) { // Download reported progress double percentComplete = 100.0 * (snapshot.progress.completedUnitCount) / (snapshot.progress.totalUnitCount); }]; [downloadTask observeStatus:FIRStorageTaskStatusSuccess handler:^(FIRStorageTaskSnapshot *snapshot) { // Download completed successfully }]; // Errors only occur in the "Failure" case [downloadTask observeStatus:FIRStorageTaskStatusFailure handler:^(FIRStorageTaskSnapshot *snapshot) { if (snapshot.error != nil) { switch (snapshot.error.code) { case FIRStorageErrorCodeObjectNotFound: // File doesn't exist break; case FIRStorageErrorCodeUnauthorized: // User doesn't have permission to access file break; case FIRStorageErrorCodeCancelled: // User canceled the upload break; /* ... */ case FIRStorageErrorCodeUnknown: // Unknown error occurred, inspect the server response break; } } }];
يمكنك أيضًا الحصول على البيانات الوصفية وتعديلها للملفات المخزَّنة في Cloud Storage.