دانلود فایل ها با Cloud Storage در پلتفرم های اپل

Cloud Storage for Firebase به شما این امکان را می دهد که به سرعت و به راحتی فایل ها را از یک سطل Cloud Storage که توسط Firebase تهیه و مدیریت می شود دانلود کنید.

یک مرجع ایجاد کنید

برای دانلود یک فایل، ابتدا یک مرجع Cloud Storage برای فایلی که می خواهید دانلود کنید ایجاد کنید .

می‌توانید با اضافه کردن مسیرهای فرزند به ریشه سطل Cloud Storage خود، یک مرجع ایجاد کنید، یا می‌توانید یک مرجع از یک نشانی اینترنتی 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")

هدف-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 به سه روش دانلود کنید:

  1. دانلود به NSData در حافظه
  2. دانلود در NSURL نشان دهنده یک فایل در دستگاه
  3. یک NSURL به نمایندگی از فایل به صورت آنلاین ایجاد کنید

دانلود در حافظه

با استفاده از روش dataWithMaxSize:completion: فایل را در یک شی NSData در حافظه دانلود کنید. این ساده ترین راه برای دانلود سریع یک فایل است، اما باید کل محتوای فایل شما را در حافظه بارگیری کند. اگر فایلی بزرگتر از حافظه موجود برنامه خود درخواست کنید، برنامه شما خراب می شود. برای محافظت در برابر مشکلات حافظه، مطمئن شوید که حداکثر اندازه را روی چیزی تنظیم کنید که می‌دانید برنامه شما می‌تواند از پس آن برآید، یا از روش دانلود دیگری استفاده کنید.

سویفت 

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

هدف-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 را برمی گرداند که می توانید از آن برای مدیریت دانلود و نظارت بر وضعیت آپلود استفاده کنید.

سویفت 

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

هدف-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 دریافت کنید.

سویفت 

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

هدف-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 می‌توانید با استفاده از ادغام ما با SDWebImage، به سرعت و به راحتی تصاویر را از Cloud Storage دانلود، ذخیره و نمایش دهید.

ابتدا 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)

هدف-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 رویدادهایی می‌شوند که می‌توانید مشاهده کنید.

سویفت 

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

هدف-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 را برمی‌گرداند که می‌توان از آن برای حذف ناظر استفاده کرد.

سویفت 

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

هدف-C 

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

هدف-C 

// 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 ، همه مشاهدهگرها حذف می شوند.

رسیدگی به خطاها

دلایل متعددی وجود دارد که ممکن است هنگام دانلود خطا رخ دهد، از جمله اینکه فایل موجود نیست یا کاربر اجازه دسترسی به فایل مورد نظر را ندارد. اطلاعات بیشتر در مورد خطاها را می توانید در بخش Handle Errors در اسناد پیدا کنید.

مثال کامل

یک مثال کامل از بارگیری در یک فایل محلی با مدیریت خطا در زیر نشان داده شده است:

سویفت 

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

هدف-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 ذخیره می‌شوند دریافت و به‌روزرسانی کنید .