فایل‌ها را با فضای ذخیره‌سازی ابری در پلتفرم‌های اپل آپلود کنید

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

ایجاد یک مرجع

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

شما می‌توانید با اضافه کردن مسیرهای فرزند به ریشه‌ی مخزن Cloud Storage خود، یک مرجع ایجاد کنید:

سویفت

// Create a root reference
let storageRef = storage.reference()

// Create a reference to "mountains.jpg"
let mountainsRef = storageRef.child("mountains.jpg")

// Create a reference to 'images/mountains.jpg'
let 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
    

هدف-سی

// Create a root reference
FIRStorageReference *storageRef = [storage reference];

// Create a reference to "mountains.jpg"
FIRStorageReference *mountainsRef = [storageRef child:@"mountains.jpg"];

// Create a reference to 'images/mountains.jpg'
FIRStorageReference *mountainImagesRef = [storageRef child:@"images/mountains.jpg"];

// While the file names are the same, the references point to different files
[mountainsRef.name isEqualToString:mountainImagesRef.name];         // true
[mountainsRef.fullPath isEqualToString:mountainImagesRef.fullPath]; // false
  

شما نمی‌توانید داده‌ها را با ارجاع به ریشه‌ی مخزن Cloud Storage خود آپلود کنید. ارجاع شما باید به یک URL فرزند اشاره کند.

آپلود فایل‌ها

وقتی مرجع را پیدا کردید، می‌توانید فایل‌ها را به دو روش در Cloud Storage آپلود کنید:

  1. آپلود از داده‌های موجود در حافظه
  2. آپلود از یک URL که نشان‌دهنده‌ی یک فایل روی دستگاه است

آپلود از داده‌های موجود در حافظه

putData:metadata:completion: ساده‌ترین روش برای آپلود یک فایل در Cloud Storage است. putData:metadata:completion: یک شیء NSData می‌گیرد و یک FIRStorageUploadTask برمی‌گرداند که می‌توانید از آن برای مدیریت آپلود و نظارت بر وضعیت آن استفاده کنید.

سویفت

// Data in memory
let data = Data()

// Create a reference to the file you want to upload
let riversRef = storageRef.child("images/rivers.jpg")

// Upload the file to the path "images/rivers.jpg"
let uploadTask = riversRef.putData(data, metadata: nil) { (metadata, error) in
  guard let metadata = metadata else {
    // Uh-oh, an error occurred!
    return
  }
  // Metadata contains file metadata such as size, content-type.
  let size = metadata.size
  // You can also access to download URL after upload.
  riversRef.downloadURL { (url, error) in
    guard let downloadURL = url else {
      // Uh-oh, an error occurred!
      return
    }
  }
}
    

هدف-سی

// Data in memory
NSData *data = [NSData dataWithContentsOfFile:@"rivers.jpg"];

// Create a reference to the file you want to upload
FIRStorageReference *riversRef = [storageRef child:@"images/rivers.jpg"];

// Upload the file to the path "images/rivers.jpg"
FIRStorageUploadTask *uploadTask = [riversRef putData:data
                                             metadata:nil
                                           completion:^(FIRStorageMetadata *metadata,
                                                        NSError *error) {
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // Metadata contains file metadata such as size, content-type, and download URL.
    int size = metadata.size;
    // You can also access to download URL after upload.
    [riversRef downloadURLWithCompletion:^(NSURL * _Nullable URL, NSError * _Nullable error) {
      if (error != nil) {
        // Uh-oh, an error occurred!
      } else {
        NSURL *downloadURL = URL;
      }
    }];
  }
}];
  

آپلود از یک فایل محلی

شما می‌توانید فایل‌های محلی روی دستگاه‌ها، مانند عکس‌ها و ویدیوهای دوربین، را با متد putFile:metadata:completion: آپلود کنید. putFile:metadata:completion: یک NSURL می‌گیرد و یک FIRStorageUploadTask برمی‌گرداند که می‌توانید از آن برای مدیریت آپلود و نظارت بر وضعیت آن استفاده کنید.

سویفت

// File located on disk
let localFile = URL(string: "path/to/image")!

// Create a reference to the file you want to upload
let riversRef = storageRef.child("images/rivers.jpg")

// Upload the file to the path "images/rivers.jpg"
let uploadTask = riversRef.putFile(from: localFile, metadata: nil) { metadata, error in
  guard let metadata = metadata else {
    // Uh-oh, an error occurred!
    return
  }
  // Metadata contains file metadata such as size, content-type.
  let size = metadata.size
  // You can also access to download URL after upload.
  riversRef.downloadURL { (url, error) in
    guard let downloadURL = url else {
      // Uh-oh, an error occurred!
      return
    }
  }
}
    

هدف-سی

// File located on disk
NSURL *localFile = [NSURL URLWithString:@"path/to/image"];

// Create a reference to the file you want to upload
FIRStorageReference *riversRef = [storageRef child:@"images/rivers.jpg"];

// Upload the file to the path "images/rivers.jpg"
FIRStorageUploadTask *uploadTask = [riversRef putFile:localFile metadata:nil completion:^(FIRStorageMetadata *metadata, NSError *error) {
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // Metadata contains file metadata such as size, content-type, and download URL.
    int size = metadata.size;
    // You can also access to download URL after upload.
    [riversRef downloadURLWithCompletion:^(NSURL * _Nullable URL, NSError * _Nullable error) {
      if (error != nil) {
        // Uh-oh, an error occurred!
      } else {
        NSURL *downloadURL = URL;
      }
    }];
  }
}];
  

اگر می‌خواهید آپلود خود را به طور فعال مدیریت کنید، می‌توانید از متدهای putData: یا putFile: استفاده کنید و به جای استفاده از completion handler، وظیفه آپلود را مشاهده کنید. برای اطلاعات بیشتر به بخش مدیریت آپلودها مراجعه کنید.

افزودن متادیتای فایل

همچنین می‌توانید هنگام آپلود فایل‌ها، فراداده (metadata) را نیز اضافه کنید. این فراداده شامل ویژگی‌های معمول فراداده فایل مانند name ، size و contentType (که معمولاً به عنوان نوع MIME شناخته می‌شود) است. متد putFile: به طور خودکار نوع محتوا را از پسوند نام فایل NSURL استنباط می‌کند، اما می‌توانید با مشخص کردن contentType در فراداده، نوع شناسایی‌شده خودکار را لغو کنید. اگر contentType مشخص نکنید و Cloud Storage نتواند پیش‌فرض را از پسوند فایل استنباط کند، Cloud Storage از application/octet-stream استفاده می‌کند. برای اطلاعات بیشتر در مورد فراداده فایل، به بخش استفاده از فراداده فایل مراجعه کنید.

سویفت

// Create storage reference
let mountainsRef = storageRef.child("images/mountains.jpg")

// Create file metadata including the content type
let metadata = StorageMetadata()
metadata.contentType = "image/jpeg"

// Upload data and metadata
mountainsRef.putData(data, metadata: metadata)

// Upload file and metadata
mountainsRef.putFile(from: localFile, metadata: metadata)
    

هدف-سی

// Create storage reference
FIRStorageReference *mountainsRef = [storageRef child:@"images/mountains.jpg"];

// Create file metadata including the content type
FIRStorageMetadata *metadata = [[FIRStorageMetadata alloc] init];
metadata.contentType = @"image/jpeg";

// Upload data and metadata
FIRStorageUploadTask *uploadTask = [mountainsRef putData:data metadata:metadata];

// Upload file and metadata
uploadTask = [mountainsRef putFile:localFile metadata:metadata];
  

مدیریت آپلودها

علاوه بر شروع آپلود، می‌توانید با استفاده از متدهای pause ، resume و cancel آپلودها را متوقف، از سر بگیرید و لغو کنید. این متدها رویدادهای pause ، resume و cancel را فعال می‌کنند. لغو آپلود باعث می‌شود آپلود با خطایی مبنی بر لغو آپلود، با شکست مواجه شود.

سویفت

// Start uploading a file
let uploadTask = storageRef.putFile(from: localFile)

// Pause the upload
uploadTask.pause()

// Resume the upload
uploadTask.resume()

// Cancel the upload
uploadTask.cancel()
    

هدف-سی

// Start uploading a file
FIRStorageUploadTask *uploadTask = [storageRef putFile:localFile];

// Pause the upload
[uploadTask pause];

// Resume the upload
[uploadTask resume];

// Cancel the upload
[uploadTask cancel];
  

نظارت بر پیشرفت آپلود

شما می‌توانید ناظرها را به FIRStorageUploadTask ها متصل کنید تا پیشرفت آپلود را زیر نظر داشته باشید. اضافه کردن یک ناظر، یک FIRStorageHandle برمی‌گرداند که می‌توان از آن برای حذف ناظر استفاده کرد.

سویفت

// Add a progress observer to an upload task
let observer = uploadTask.observe(.progress) { snapshot in
  // A progress event occured
}
    

هدف-سی

// Add a progress observer to an upload task
NSString *observer = [uploadTask observeStatus:FIRStorageTaskStatusProgress
                                        handler:^(FIRStorageTaskSnapshot *snapshot) {
  // A progress event occurred
}];
  

این ناظران می‌توانند به یک رویداد FIRStorageTaskStatus اضافه شوند:

رویداد FIRStorageTaskStatus کاربرد معمول
FIRStorageTaskStatusResume این رویداد زمانی فعال می‌شود که وظیفه شروع به کار کند یا آپلود را از سر بگیرد و اغلب همراه با رویداد FIRStorageTaskStatusPause استفاده می‌شود.
FIRStorageTaskStatusProgress این رویداد هر زمان که داده‌ها در Cloud Storage آپلود می‌شوند، فعال می‌شود و می‌تواند برای نمایش نشانگر پیشرفت آپلود استفاده شود.
FIRStorageTaskStatusPause این رویداد هر زمان که آپلود متوقف شود، اجرا می‌شود و اغلب همراه با رویداد FIRStorageTaskStatusResume استفاده می‌شود.
FIRStorageTaskStatusSuccess این رویداد زمانی فعال می‌شود که آپلود با موفقیت انجام شود.
FIRStorageTaskStatusFailure این رویداد زمانی رخ می‌دهد که آپلود با شکست مواجه شود. برای تعیین دلیل شکست، خطا را بررسی کنید.

وقتی یک رویداد رخ می‌دهد، یک شیء FIRStorageTaskSnapshot برگردانده می‌شود. این snapshot یک نمای تغییرناپذیر از وظیفه، در زمان وقوع رویداد است. این شیء شامل ویژگی‌های زیر است:

ملک نوع توضیحات
progress NSProgress یک شیء NSProgress که شامل پیشرفت آپلود است.
error NSError خطایی که هنگام آپلود رخ داده است، در صورت وجود.
metadata FIRStorageMetadata در طول آپلود، شامل فراداده‌هایی است که آپلود می‌شوند. پس از رویداد FIRTaskStatusSuccess ، شامل فراداده‌های فایل آپلود شده می‌شود.
task FIRStorageUploadTask این یک تصویر لحظه‌ای از وظیفه است که می‌تواند برای مدیریت ( pause ، resume ، cancel ) وظیفه استفاده شود.
reference FIRStorageReference مرجعی که این وظیفه از آن آمده است.

همچنین می‌توانید ناظران را به صورت جداگانه، بر اساس وضعیت یا با حذف همه آنها حذف کنید.

سویفت

// Create a task listener handle
let observer = uploadTask.observe(.progress) { snapshot in
  // A progress event occurred
}

// Remove an individual observer
uploadTask.removeObserver(withHandle: observer)

// Remove all observers of a particular status
uploadTask.removeAllObservers(for: .progress)

// Remove all observers
uploadTask.removeAllObservers()
    

هدف-سی

// Create a task listener handle
NSString *observer = [uploadTask observeStatus:FIRStorageTaskStatusProgress
                                       handler:^(FIRStorageTaskSnapshot *snapshot) {
  // A progress event occurred
}];

// Remove an individual observer
[uploadTask removeObserverWithHandle:observer];

// Remove all observers of a particular status
[uploadTask removeAllObserversForStatus:FIRStorageTaskStatusProgress];

// Remove all observers
[uploadTask removeAllObservers];
  

برای جلوگیری از نشت حافظه، تمام مشاهده‌گرها پس از وقوع FIRStorageTaskStatusSuccess یا FIRStorageTaskStatusFailure حذف می‌شوند.

مدیریت خطا

دلایل مختلفی برای بروز خطا در هنگام آپلود وجود دارد، از جمله عدم وجود فایل محلی یا عدم دسترسی کاربر برای آپلود فایل مورد نظر. می‌توانید اطلاعات بیشتر در مورد خطاها را در بخش «مدیریت خطاها» در مستندات بیابید.

مثال کامل

یک مثال کامل از آپلود با قابلیت نظارت بر پیشرفت و مدیریت خطا در زیر نشان داده شده است:

سویفت

// Local file you want to upload
let localFile = URL(string: "path/to/image")!

// Create the file metadata
let metadata = StorageMetadata()
metadata.contentType = "image/jpeg"

// Upload file and metadata to the object 'images/mountains.jpg'
let uploadTask = storageRef.putFile(from: localFile, metadata: metadata)

// Listen for state changes, errors, and completion of the upload.
uploadTask.observe(.resume) { snapshot in
  // Upload resumed, also fires when the upload starts
}

uploadTask.observe(.pause) { snapshot in
  // Upload paused
}

uploadTask.observe(.progress) { snapshot in
  // Upload reported progress
  let percentComplete = 100.0 * Double(snapshot.progress!.completedUnitCount)
    / Double(snapshot.progress!.totalUnitCount)
}

uploadTask.observe(.success) { snapshot in
  // Upload completed successfully
}

uploadTask.observe(.failure) { snapshot in
  if let error = snapshot.error as? NSError {
    switch (StorageErrorCode(rawValue: error.code)!) {
    case .objectNotFound:
      // File doesn't exist
      break
    case .unauthorized:
      // User doesn't have permission to access file
      break
    case .cancelled:
      // User canceled the upload
      break

    /* ... */

    case .unknown:
      // Unknown error occurred, inspect the server response
      break
    default:
      // A separate error occurred. This is a good place to retry the upload.
      break
    }
  }
}
    

هدف-سی

// Local file you want to upload
NSURL *localFile = [NSURL URLWithString:@"path/to/image"];

// Create the file metadata
FIRStorageMetadata *metadata = [[FIRStorageMetadata alloc] init];
metadata.contentType = @"image/jpeg";

// Upload file and metadata to the object 'images/mountains.jpg'
FIRStorageUploadTask *uploadTask = [storageRef putFile:localFile metadata:metadata];

// Listen for state changes, errors, and completion of the upload.
[uploadTask observeStatus:FIRStorageTaskStatusResume handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Upload resumed, also fires when the upload starts
}];

[uploadTask observeStatus:FIRStorageTaskStatusPause handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Upload paused
}];

[uploadTask observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Upload reported progress
  double percentComplete = 100.0 * (snapshot.progress.completedUnitCount) / (snapshot.progress.totalUnitCount);
}];

[uploadTask observeStatus:FIRStorageTaskStatusSuccess handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Upload completed successfully
}];

// Errors only occur in the "Failure" case
[uploadTask 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 دانلود کنیم.