Как скачивать файлы с помощью Cloud Storage на платформах Apple

Cloud Storage for Firebase позволяет быстро и легко скачивать файлы из предоставленного и управляемого Firebase сегмента 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 тремя способами:

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

Как скачивать изображения с помощью FirebaseUI

FirebaseUI предоставляет простые, настраиваемые и готовые к использованию нативные мобильные привязки, которые позволяют избежать шаблонного кода и следовать рекомендациям 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
NSString *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
NSString *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.