อัปโหลดไฟล์ด้วย 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 ได้ ใน 2 วิธี ได้แก่

  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 ช่วงเวลานี้ คือมุมมองงานที่เปลี่ยนแปลงไม่ได้ในขณะที่เกิดเหตุการณ์ขึ้น ออบเจ็กต์นี้มีพร็อพเพอร์ตี้ต่อไปนี้

พร็อพเพอร์ตี้ ประเภท คำอธิบาย
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 กัน