Dosyaları Apple platformlarında Cloud Storage ile indirin

Firebase için Cloud Storage, Firebase tarafından sağlanan ve yönetilen bir Cloud Storage paketinden dosyaları hızlı ve kolay bir şekilde indirmenize olanak tanır.

Referans Oluştur

Bir dosyayı indirmek için öncelikle indirmek istediğiniz dosyaya yönelik bir Cloud Storage referansı oluşturun .

Cloud Storage paketinizin köküne alt yollar ekleyerek bir referans oluşturabilir veya Cloud Storage'daki bir nesneye referans veren mevcut bir gs:// veya https:// URL'sinden bir referans oluşturabilirsiniz.

Süratli

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

Amaç-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"];
  

Dosyaları indir

Referansınız olduğunda Cloud Storage'dan dosyaları üç şekilde indirebilirsiniz:

  1. Bellekteki NSData indirme
  2. Cihazdaki bir dosyayı temsil eden bir NSURL indirme
  3. Dosyayı çevrimiçi olarak temsil eden bir NSURL oluşturun

Belleğe indir

dataWithMaxSize:completion: yöntemini kullanarak dosyayı bellekteki bir NSData nesnesine indirin. Bu, bir dosyayı hızlı bir şekilde indirmenin en kolay yoludur, ancak dosyanızın tüm içeriğini belleğe yüklemesi gerekir. Uygulamanızın kullanılabilir belleğinden daha büyük bir dosya talep ederseniz uygulamanız çökecektir. Bellek sorunlarına karşı koruma sağlamak için maksimum boyutu, uygulamanızın işleyebileceğini bildiğiniz bir boyuta ayarladığınızdan emin olun veya başka bir indirme yöntemi kullanın.

Süratli

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

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

Yerel bir dosyaya indirin

writeToFile:completion: yöntemi, dosyayı doğrudan yerel bir aygıta indirir. Kullanıcılarınız dosyaya çevrimdışıyken erişmek veya farklı bir uygulamada paylaşmak istiyorsa bunu kullanın. writeToFile:completion: indirme işleminizi yönetmek ve yükleme durumunu izlemek için kullanabileceğiniz bir FIRStorageDownloadTask döndürür.

Süratli

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

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

İndirme işleminizi aktif olarak yönetmek istiyorsanız tamamlama işleyicisini kullanmak yerine writeToFile: yöntemini kullanabilir ve indirme görevini gözlemleyebilirsiniz. Daha fazla bilgi için İndirmeleri Yönetme konusuna bakın.

Bir indirme URL'si oluşturun

Zaten URL'lere dayalı bir indirme altyapınız varsa veya yalnızca bir URL'nin paylaşılmasını istiyorsanız, bir Cloud Storage referansında downloadURLWithCompletion: yöntemini çağırarak bir dosyanın indirme URL'sini alabilirsiniz.

Süratli

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

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

FirebaseUI ile Görsellerin İndirilmesi

FirebaseUI , standart kodları ortadan kaldırmak ve Google'ın en iyi uygulamalarını tanıtmak için basit, özelleştirilebilir ve üretime hazır yerel mobil bağlamalar sağlar. FirebaseUI'yi kullanarak SDWebImage entegrasyonumuzu kullanarak Cloud Storage'daki görüntüleri hızlı ve kolay bir şekilde indirebilir, önbelleğe alabilir ve görüntüleyebilirsiniz.

Öncelikle FirebaseUI'yi Podfile ekleyin:

pod 'FirebaseStorageUI'

Daha sonra görüntüleri doğrudan Cloud Storage'dan bir UIImageView yükleyebilirsiniz:

Süratli

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

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

İndirmeleri Yönet

İndirme işlemlerini başlatmanın yanı sıra pause , devam resume ve cancel yöntemlerini kullanarak indirme işlemlerini duraklatabilir, devam ettirebilir ve iptal edebilirsiniz. Bu yöntemler gözlemleyebileceğiniz pause , resume ve cancel olaylarını artırır.

Süratli

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

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

İndirme İlerlemesini İzleyin

İndirme işleminin ilerlemesini izlemek için FIRStorageDownloadTask gözlemciler ekleyebilirsiniz. Bir gözlemci eklemek, gözlemciyi kaldırmak için kullanılabilecek bir FIRStorageHandle döndürür.

Süratli

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

Amaç-C

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

Bu gözlemciler bir FIRStorageTaskStatus olayına kaydedilebilir:

FIRStorageTaskStatus Etkinliği Tipik Kullanım
FIRStorageTaskStatusResume Bu olay, görev indirmeyi başlattığında veya devam ettirdiğinde tetiklenir ve genellikle FIRStorageTaskStatusPause olayıyla birlikte kullanılır.
FIRStorageTaskStatusProgress Bu etkinlik, Cloud Storage'dan veri indirildiğinde her zaman tetiklenir ve indirme ilerleme durumu göstergesini doldurmak için kullanılabilir.
FIRStorageTaskStatusPause Bu olay, indirme işlemi duraklatıldığında her zaman tetiklenir ve genellikle FIRStorageTaskStatusResume olayıyla birlikte kullanılır.
FIRStorageTaskStatusSuccess Bu olay, bir indirme başarıyla tamamlandığında tetiklenir.
FIRStorageTaskStatusFailure Bu olay, bir indirme başarısız olduğunda tetiklenir. Arıza nedenini belirlemek için hatayı inceleyin.

Bir olay meydana geldiğinde FIRStorageTaskSnapshot nesnesi geri iletilir. Bu anlık görüntü, olayın gerçekleştiği andaki görevin değişmez bir görünümüdür. Bu nesne aşağıdaki özellikleri içerir:

Mülk Tip Tanım
progress NSProgress İndirme işleminin ilerlemesini içeren bir NSProgress nesnesi.
error NSError Varsa indirme sırasında oluşan bir hata.
metadata FIRStorageMetadata indirmelerde nil .
task FIRStorageDownloadTask Bu görevin anlık görüntüsüdür ve görevi yönetmek ( pause , resume , cancel ) için kullanılabilir.
reference FIRStorageReference Bu görevin geldiği referans.

Ayrıca gözlemcileri tek tek, durumlarına göre veya hepsini kaldırarak da kaldırabilirsiniz.

Süratli

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

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

Bellek sızıntılarını önlemek için, bir FIRStorageTaskStatusSuccess veya FIRStorageTaskStatusFailure meydana geldikten sonra tüm gözlemciler kaldırılır.

Hataları İşle

Dosyanın mevcut olmaması veya kullanıcının istenen dosyaya erişim iznine sahip olmaması da dahil olmak üzere indirme sırasında hataların ortaya çıkmasının çeşitli nedenleri vardır. Hatalarla ilgili daha fazla bilgiyi dokümanların Hataları İşleme bölümünde bulabilirsiniz.

Tam Örnek

Hata işlemeyle birlikte yerel bir dosyaya indirmenin tam bir örneği aşağıda gösterilmektedir:

Süratli

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

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

Ayrıca Cloud Storage'da depolanan dosyalara ilişkin meta verileri alabilir ve güncelleyebilirsiniz .