تحميل الملفات باستخدام Cloud Storage على أنظمة Apple الأساسية

تتيح لك خدمة Cloud Storage for Firebase تحميل الملفات بسرعة وسهولة إلى حزمة Cloud Storage التي توفّرها منصة Firebase وتديرها.

إنشاء مرجع

لتحميل ملف، عليك أولاً إنشاء مرجع Cloud Storage إلى الموقع المطلوب تحميل الملف إليه في Cloud Storage.

يمكنك إنشاء مرجع من خلال إلحاق مسارات فرعية بجذر حزمة Cloud Storage:

Swift

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

Objective-C

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

Swift

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

Objective-C

// 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، ويمكنك استخدامها لإدارة عملية التحميل وتتبُّع حالتها.

Swift

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

Objective-C

// 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: ومراقبة مهمة التحميل بدلاً من استخدام معالِج الإكمال. راجِع إدارة عمليات التحميل للحصول على مزيد من المعلومات.

إضافة البيانات الوصفية للملف

يمكنك أيضًا تضمين البيانات الوصفية عند تحميل الملفات. تحتوي هذه البيانات الوصفية على سمات نموذجية للبيانات الوصفية، مثل name وsize وcontentType (يُشار إليها عادةً باسم نوع MIME). تستنتج الطريقة putFile: تلقائيًا نوع المحتوى من امتداد اسم الملف NSURL، ولكن يمكنك إلغاء النوع الذي تم اكتشافه تلقائيًا من خلال تحديد contentType في البيانات الوصفية. إذا لم توفّر contentType ولم يكن بإمكان Cloud Storage استنتاج قيمة تلقائية من امتداد الملف، ستستخدم Cloud Storage application/octet-stream. راجِع قسم استخدام البيانات الوصفية للملفات للحصول على مزيد من المعلومات حول البيانات الوصفية للملفات.

Swift

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

Objective-C

// 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. يؤدي إلغاء التحميل إلى إخفاق التحميل مع عرض رسالة خطأ تشير إلى أنه تم إلغاء التحميل.

Swift

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

Objective-C

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

Swift

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

Objective-C

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

يمكن إضافة هؤلاء المراقبين إلى حدث FIRStorageTaskStatus:

حدث واحد (FIRStorageTaskStatus) معدّل الاستخدام
FIRStorageTaskStatusResume يتم تنشيط هذا الحدث عند بدء المهمة أو استئناف تحميلها، وغالبًا ما يستخدم مع حدث FIRStorageTaskStatusPause.
FIRStorageTaskStatusProgress ويتم تنشيط هذا الحدث في أي وقت يتم فيه تحميل بيانات إلى Cloud Storage، ويمكن استخدامه لتعبئة مؤشر تقدّم التحميل.
FIRStorageTaskStatusPause يتم تنشيط هذا الحدث في أي وقت يتم فيه إيقاف التحميل مؤقتًا، وغالبًا ما يُستخدم مع حدث FIRStorageTaskStatusResume.
FIRStorageTaskStatusSuccess يتم تنشيط هذا الحدث عند اكتمال عملية التحميل بنجاح.
FIRStorageTaskStatusFailure يتم تنشيط هذا الحدث عند تعذُّر عملية التحميل. افحص الخطأ لتحديد سبب الإخفاق.

عند وقوع حدث، يتم تمرير كائن FIRStorageTaskSnapshot مرة أخرى. هذه اللقطة هي عرض غير قابل للتغيير للمهمة، في وقت وقوع الحدث. يحتوي هذا الكائن على السمات التالية:

الموقع Type الوصف
progress NSProgress عنصر NSProgress يحتوي على مستوى تقدّم التحميل.
error NSError حدث خطأ أثناء التحميل، إن وُجد.
metadata FIRStorageMetadata يحتوي التحميل أثناء التحميل على بيانات وصفية يتم تحميلها. بعد حدث FIRTaskStatusSuccess، يحتوي هذا الحقل على البيانات الوصفية للملف الذي تم تحميله.
task FIRStorageUploadTask المهمة التي هذه نبذة عنها يمكن استخدامها لإدارة المهمة (pause، resume، cancel).
reference FIRStorageReference المرجع الذي وردت منه هذه المهمة.

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

Swift

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

Objective-C

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

خطأ أثناء المعالجة

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

مثال كامل

في ما يلي مثال كامل لعملية تحميل تتضمّن مراقبة مستوى التقدّم ومعالجة الأخطاء:

Swift

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

Objective-C

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