قم بتنزيل الملفات باستخدام Cloud Storage على منصات Apple

يتيح لك Cloud Storage for Firebase تنزيل الملفات بسرعة وسهولة من مجموعة Cloud Storage التي توفرها وتديرها Firebase.

إنشاء مرجع

لتنزيل ملف، قم أولاً بإنشاء مرجع Cloud Storage للملف الذي تريد تنزيله.

يمكنك إنشاء مرجع عن طريق إلحاق مسارات فرعية بجذر مجموعة Cloud Storage، أو يمكنك إنشاء مرجع من عنوان URL موجود gs:// أو https:// يشير إلى كائن في Cloud Storage.

سويفت

// 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")

ج موضوعية

// 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 بثلاث طرق:

  1. تحميل إلى NSData في الذاكرة
  2. قم بالتنزيل إلى NSURL الذي يمثل ملفًا على الجهاز
  3. قم بإنشاء NSURL يمثل الملف عبر الإنترنت

تحميل في الذاكرة

قم بتنزيل الملف إلى كائن NSData في الذاكرة باستخدام الأسلوب dataWithMaxSize:completion: . هذه هي أسهل طريقة لتنزيل ملف بسرعة، ولكن يجب تحميل محتويات الملف بالكامل إلى الذاكرة. إذا طلبت ملفًا أكبر من الذاكرة المتوفرة لتطبيقك، فسيتعطل تطبيقك. للحماية من مشكلات الذاكرة، تأكد من ضبط الحجم الأقصى على شيء تعرف أن تطبيقك يمكنه التعامل معه، أو استخدم طريقة تنزيل أخرى.

سويفت

// 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!)
  }
}
    

ج موضوعية

// 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 والذي يمكنك استخدامه لإدارة التنزيل ومراقبة حالة التحميل.

سويفت

// 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
  }
}
    

ج موضوعية

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

سويفت

// 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'
  }
}
    

ج موضوعية

// 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 :

سويفت

// 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)
    

ج موضوعية

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

سويفت

// 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()
    

ج موضوعية

// 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 الذي يمكن استخدامه لإزالة المراقب.

سويفت

// Add a progress observer to a download task
let observer = downloadTask.observe(.progress) { snapshot in
  // A progress event occurred
}
    

ج موضوعية

// Add a progress observer to a download task
FIRStorageHandle 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 المرجع الذي جاءت منه هذه المهمة.

يمكنك أيضًا إزالة المراقبين، إما بشكل فردي، أو حسب الحالة، أو عن طريق إزالة كل منهم.

سويفت

// 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()
    

ج موضوعية

// Create a task listener handle
FIRStorageHandle 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 .

التعامل مع الأخطاء

هناك عدد من الأسباب التي قد تؤدي إلى حدوث أخطاء عند التنزيل، بما في ذلك الملف غير موجود، أو عدم حصول المستخدم على إذن للوصول إلى الملف المطلوب. يمكن العثور على مزيد من المعلومات حول الأخطاء في قسم التعامل مع الأخطاء في المستندات.

مثال كامل

يظهر أدناه مثال كامل للتنزيل إلى ملف محلي مع معالجة الأخطاء:

سويفت

// 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
  }
}
    

ج موضوعية

// 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 وتحديثها .