Mendownload file dengan Cloud Storage di platform Apple

Dengan Cloud Storage for Firebase, Anda dapat mendownload file dengan cepat dan mudah dari bucket Cloud Storage yang disediakan dan dikelola oleh Firebase.

Membuat Referensi

Untuk mendownload file, buat referensi Cloud Storage terlebih dahulu ke file yang ingin didownload.

Anda dapat membuat referensi dengan menambahkan jalur turunan ke root bucket Cloud Storage, atau membuat referensi dari URL gs:// atau https:// yang sudah ada, yang mereferensikan suatu objek di 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"];

Mendownload File

Setelah memiliki referensi, Anda dapat mendownload file dari Cloud Storage dengan 3 cara:

  1. Mendonwload ke NSData di memori
  2. Mendownload ke NSURL yang mewakili file di perangkat
  3. Membuat NSURL yang mewakili file online

Mendownload di memori

Download file ke objek NSData di memori menggunakan metode dataWithMaxSize:completion:. Ini adalah cara termudah untuk mendownload file dengan cepat, tetapi cara ini harus memuat seluruh konten file Anda ke dalam memori. Jika Anda meminta file yang lebih besar dari memori aplikasi yang tersedia, maka aplikasi akan error. Agar tidak terjadi masalah pada memori, pastikan untuk menyetel ukuran maksimum ke nilai yang Anda tahu bisa ditangani oleh aplikasi, atau gunakan metode download lainnya.

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

Mendownload ke file lokal

Metode writeToFile:completion: akan mendownload file secara langsung ke perangkat lokal. Gunakan metode ini jika pengguna ingin memiliki akses ke file saat offline atau membagikan file di aplikasi lain. writeToFile:completion: menampilkan FIRStorageDownloadTask yang dapat Anda gunakan untuk mengelola download dan memantau status upload.

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

Jika ingin mengelola download secara aktif, Anda dapat menggunakan metode writeToFile: dan mengamati tugas download, bukan menggunakan pengendali penyelesaian. Baca bagian Mengelola Download untuk mengetahui informasi lebih lanjut.

Membuat URL download

Jika Anda sudah memiliki infrastruktur download berdasarkan URL, atau hanya ingin memiliki URL untuk dibagikan, Anda dapat memperoleh URL download untuk suatu file dengan memanggil metode downloadURLWithCompletion: pada referensi 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'
  }
}];

Mendownload Gambar dengan FirebaseUI

FirebaseUI menyediakan binding seluler native yang sederhana, dapat disesuaikan, dan siap produksi untuk menghilangkan kode boilerplate dan mendorong praktik terbaik Google. Dengan FirebaseUI, Anda dapat mendownload, membuat cache, dan menampilkan gambar dengan cepat dan mudah dari Cloud Storage menggunakan integrasi kami dengan SDWebImage.

Pertama, tambahkan FirebaseUI ke Podfile:

pod 'FirebaseStorageUI'

Anda dapat langsung memuat gambar dari Cloud Storage ke 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];

Mengelola Download

Selain memulai download, Anda dapat menjeda, melanjutkan, dan membatalkan download menggunakan metode pause, resume, dan cancel. Metode ini menghasilkan peristiwa pause, resume, dan cancel yang dapat Anda amati.

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];

Memantau Progres Download

Anda dapat memasang observer ke FIRStorageDownloadTask untuk memantau progres download. Jika observer ditambahkan, FIRStorageHandle akan ditampilkan, yang dapat digunakan untuk menghapus observer.

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

Observer ini dapat didaftarkan ke peristiwa FIRStorageTaskStatus:

Peristiwa `FIRStorageTaskStatus` Penggunaan Standar
FIRStorageTaskStatusResume Peristiwa ini aktif saat memulai tugas atau melanjutkan download, dan sering digunakan bersamaan dengan peristiwa FIRStorageTaskStatusPause .
FIRStorageTaskStatusProgress Peristiwa ini aktif setiap kali data didownload dari Cloud Storage, dan dapat digunakan untuk mengisi indikator progres download.
FIRStorageTaskStatusPause Peristiwa ini aktif setiap kali download dijeda, dan sering digunakan bersamaan dengan peristiwa FIRStorageTaskStatusResume.
FIRStorageTaskStatusSuccess Peristiwa ini aktif ketika download berhasil diselesaikan.
FIRStorageTaskStatusFailure Peristiwa ini aktif ketika download gagal. Periksa error untuk mengetahui alasan kegagalan.

Ketika terjadi suatu peristiwa, objek FIRStorageTaskSnapshot akan diterima. Snapshot ini adalah tampilan tetap dari tugas pada saat peristiwa tersebut terjadi. Objek ini berisi properti berikut:

Properti Jenis Deskripsi
progress NSProgress Objek NSProgress yang berisi progres download.
error NSError Error yang terjadi ketika mendownload, jika ada.
metadata FIRStorageMetadata nil pada download.
task FIRStorageDownloadTask Tugas yang menghasilkan snapshot ini, yang dapat digunakan untuk mengelola (pause, resume, cancel) tugas.
reference FIRStorageReference Referensi tempat tugas ini berasal.

Anda juga dapat menghapus observer, baik satu per satu, berdasarkan status, atau menghapus semuanya.

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];

Untuk mencegah kebocoran memori, semua observer dihapus setelah FIRStorageTaskStatusSuccess atau FIRStorageTaskStatusFailure terjadi.

Menangani Error

Ada sejumlah penyebab terjadinya error pada download, termasuk tidak adanya file atau pengguna tidak memiliki izin untuk mengakses file yang diinginkan. Informasi lebih lanjut mengenai error bisa dilihat di bagian Menangani Error pada dokumentasi.

Contoh Lengkap

Contoh lengkap proses download ke file lokal dengan penanganan error ditampilkan di bawah ini:

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

Anda juga dapat mengambil dan memperbarui metadata untuk file yang disimpan di Cloud Storage.