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

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

ملاحظة: يتطلّب Cloud Storage for Firebase تلقائيًا Firebase Authentication لتنفيذ أي إجراء على بيانات الحزمة أو ملفاتها. يمكنك تغيير Firebase Security Rules Cloud Storage إلى السماح بالوصول بدون مصادقة في حالات معيّنة. ومع ذلك، ننصحك بشدة في معظم الحالات بتقييد الوصول وإعداد قواعد أمان قوية (خاصةً للتطبيقات المتاحة للجميع). يُرجى العِلم أنّه في حال استخدامك Google App Engine وكان لديك حزمة Cloud Storage تلقائية بتنسيق اسم *.appspot.com، قد تحتاج إلى التفكير في تأثير قواعد الأمان على إمكانية الوصول إلى ملفات App Engine.

ملاحظة: بالنسبة إلى المشاريع التي تستخدم خطة Spark، تحظر Firebase تحميل واستضافة أنواع معيّنة من الملفات التنفيذية لنظام التشغيل Windows (الملفات التي تتضمّن الامتدادات .exe و.dll و.bat) وAndroid (الامتداد .apk) وApple (الامتداد .ipa) من خلال Cloud Storage for Firebase وFirebase Hosting. تهدف هذه السياسة إلى منع إساءة الاستخدام على منصتنا. لا تتأثر المشاريع في خطة Blaze. لمزيد من المعلومات، يُرجى الاطّلاع على هذه الأسئلة الشائعة.

إنشاء مرجع

لتحميل ملف، عليك أولاً إنشاء مرجع 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
NSString *observer = [uploadTask 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	أثناء التحميل، يحتوي على البيانات الوصفية التي يتم تحميلها. بعد حدث 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
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.

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

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

مثال كامل

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

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.