ดาวน์โหลดไฟล์ด้วย Cloud Storage บนแพลตฟอร์ม Apple

Cloud Storage for Firebase ช่วยให้คุณดาวน์โหลดได้อย่างรวดเร็วและง่ายดาย ไฟล์จาก Cloud Storage ระบุและจัดการโดย Firebase

หมายเหตุ: โดยค่าเริ่มต้น ที่เก็บข้อมูล Cloud Storage ต้องมีการตรวจสอบสิทธิ์ Firebase ดำเนินการใดๆ กับข้อมูลหรือไฟล์ของที่เก็บข้อมูล คุณสามารถ เปลี่ยนกฎการรักษาความปลอดภัยของ Firebase สำหรับ Cloud Storage เพื่ออนุญาตการเข้าถึงที่ไม่ผ่านการตรวจสอบสิทธิ์ เนื่องจาก Firebase และค่าเริ่มต้นของโปรเจ็กต์ แอป App Engine จะแชร์ที่เก็บข้อมูลนี้ ดังนั้นการกำหนดค่าการเข้าถึงแบบสาธารณะอาจทำให้ ไฟล์ App Engine ที่อัปโหลดซึ่งเข้าถึงได้แบบสาธารณะเช่นกัน อย่าลืมจำกัด สิทธิ์เข้าถึงที่เก็บข้อมูล Cloud Storage อีกครั้งเมื่อคุณตั้งค่าการตรวจสอบสิทธิ์

สร้างการอ้างอิง

หากต้องการดาวน์โหลดไฟล์ ก่อนอื่นให้ สร้างข้อมูลอ้างอิง Cloud Storage ลงในไฟล์ที่คุณต้องการดาวน์โหลด

คุณสามารถสร้างข้อมูลอ้างอิงได้โดยต่อท้ายเส้นทางย่อยที่ราก ที่เก็บข้อมูล Cloud Storage หรือสร้างข้อมูลอ้างอิงจากที่เก็บข้อมูลที่มีอยู่ URL gs:// หรือ https:// กำลังอ้างอิงออบเจ็กต์ใน Cloud Storage

Swift

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

Objective-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 ได้ ใน 3 วิธี ได้แก่

1. ดาวน์โหลดไปยัง NSData ในหน่วยความจำ
2. ดาวน์โหลดเป็น NSURL ที่แสดงถึงไฟล์ในอุปกรณ์
3. สร้าง NSURL ที่แสดงถึงไฟล์แบบออนไลน์

ดาวน์โหลดในหน่วยความจำ

ดาวน์โหลดไฟล์ไปยังออบเจ็กต์ NSData ในหน่วยความจำโดยใช้ dataWithMaxSize:completion: วิธี นี่เป็นวิธีที่ง่ายที่สุดในการ ดาวน์โหลดไฟล์ แต่ต้องโหลดเนื้อหาทั้งหมดของไฟล์ลงในหน่วยความจำ หากคุณขอไฟล์ที่มีขนาดใหญ่กว่าหน่วยความจำที่เหลืออยู่ของแอป แอปของคุณจะ ขัดข้อง ตั้งค่าขนาดสูงสุดเพื่อป้องกันปัญหาเกี่ยวกับหน่วยความจำ กับสิ่งที่คุณทราบว่าแอปของคุณสามารถจัดการได้ หรือใช้เครื่องมืออื่น วิธีการดาวน์โหลด

Swift

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

Objective-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 ซึ่งคุณสามารถใช้ในการจัดการการดาวน์โหลดและตรวจสอบ สถานะของการอัปโหลด

Swift

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

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

Swift

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

Objective-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'
  }
}];
    

การดาวน์โหลดรูปภาพด้วย Firebase UI

FirebaseUI นำเสนอ การเชื่อมโยงอุปกรณ์เคลื่อนที่ซึ่งปรับแต่งได้และพร้อมใช้งานจริงเพื่อกำจัด Boilerplate และโปรโมตแนวทางปฏิบัติแนะนำของ Google เมื่อใช้ FirebaseUI คุณสามารถ ดาวน์โหลด แคช และแสดงรูปภาพได้อย่างรวดเร็วและง่ายดาย จาก Cloud Storage โดยใช้การผสานรวมกับ SDWebImage

ขั้นแรก ให้เพิ่ม FirebaseUI ไปยัง Podfile ดังนี้

pod 'FirebaseStorageUI'

จากนั้นคุณจะโหลดรูปภาพจาก Cloud Storage ไปยังไฟล์ UIImageView:

Swift

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

Objective-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 เหตุการณ์ที่คุณสังเกตได้

Swift

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

Objective-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 ที่สามารถใช้เพื่อนำผู้สังเกตการณ์ออกได้

Swift

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

Objective-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	แหล่งที่มาของงานนี้

นอกจากนี้ คุณยังสามารถนำผู้สังเกตการณ์ออกเป็นรายบุคคล ตามสถานะ หรือโดยการลบออก ทั้งหมดเลย

Swift

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

Objective-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 เกิดขึ้น

จัดการข้อผิดพลาด

มีหลายสาเหตุที่เกิดข้อผิดพลาดขณะดาวน์โหลด เช่น ไฟล์ที่ไม่มีอยู่ หรือผู้ใช้ไม่มีสิทธิ์เข้าถึงไฟล์ที่ต้องการ ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดได้ใน จัดการข้อผิดพลาด ของเอกสาร

ตัวอย่างแบบเต็ม

ตัวอย่างแบบเต็มของการดาวน์โหลดไปยังไฟล์ในเครื่องที่มีการจัดการข้อผิดพลาดมีดังนี้

Swift

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

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