Descarga archivos con Cloud Storage en plataformas de Apple

Cloud Storage for Firebase te permite descargar contenido de forma rápida y sencilla archivos de un bucket de Cloud Storage que proporciona y administra Firebase.

Crea una referencia

Para descargar un archivo, primero crea una referencia de Cloud Storage al archivo que deseas descargar.

Para ello, puedes anexar rutas de acceso secundarias a la raíz de tu bucket de Cloud Storage, o bien crear una referencia a partir de una URL gs:// o https:// existente que haga referencia a un objeto en 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"];

Descarga archivos

Cuando tengas una referencia, podrás descargar archivos de Cloud Storage de tres maneras:

Descarga a NSData en la memoria.
Descarga a una NSURL que represente a un archivo en el dispositivo.
Genera una NSURL que represente al archivo en línea.

Descarga en la memoria

Descarga el archivo a un objeto NSData en la memoria con el método dataWithMaxSize:completion:. Esta es la forma más fácil de descargar un archivo con rapidez, pero debe cargar todo el contenido del archivo en la memoria. Si solicitas un archivo más grande que la memoria disponible en tu app, esta fallará. Para brindar protección contra problemas de memoria, asegúrate de configurar el tamaño máximo en un valor que sepas que tu app puede manejar o usa otro método de descarga.

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

Descarga en un archivo local

El método writeToFile:completion: permite descargar un archivo directamente en un dispositivo local. Úsalo si tus usuarios quieren acceder al archivo mientras están sin conexión o compartirlo en una app diferente. writeToFile:completion: muestra un FIRStorageDownloadTask que puedes usar para administrar la descarga y supervisar el estado de la carga.

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

Si deseas administrar la descarga de forma activa, puedes usar el método writeToFile: y observar esa tarea en lugar de usar el controlador de finalización. Consulta cómo administrar descargas para obtener más información.

Genera una URL de descarga

Si ya tienes una infraestructura de descarga basada en URLs o simplemente quieres una URL para compartir, puedes llamar al método downloadURLWithCompletion: en una referencia de Cloud Storage a fin de obtener la URL de descarga de un archivo.

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

Descarga imágenes con FirebaseUI

FirebaseUI proporciona vínculos nativos para dispositivos móviles que son simples, personalizables y listos para la producción con el objetivo de eliminar el código estándar y promover las prácticas recomendadas de Google. Con FirebaseUI puedes descargar, almacenar en caché y mostrar imágenes de forma rápida y fácil desde Cloud Storage, gracias a nuestra integración en SDWebImage.

Primero, agrega FirebaseUI a Podfile, como se indica a continuación:

pod 'FirebaseStorageUI'

Luego, puedes cargar imágenes directamente desde Cloud Storage a un 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];

Administra descargas

Además de iniciar descargas, puedes detener, reanudar y cancelarlas con los métodos pause, resume y cancel. Estos métodos generan eventos pause, resume y cancel que puedes observar.

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

Controla el progreso de la descarga

Puedes adjuntar observadores a FIRStorageDownloadTask para supervisar el progreso de la descarga. Si agregas un observador, se muestra un FIRStorageHandle que se puede usar para quitar el observador.

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

Estos observadores pueden estar registrados en un evento FIRStorageTaskStatus:

Evento `FIRStorageTaskStatus`	Uso común
`FIRStorageTaskStatusResume`	Este evento se activa cuando la tarea inicia o reanuda la descarga. A menudo, se usa en combinación con el evento `FIRStorageTaskStatusPause`.
`FIRStorageTaskStatusProgress`	Este evento se activa en cualquier momento cuando se descargan datos de Cloud Storage y se puede usar para propagar un indicador de progreso de descarga.
`FIRStorageTaskStatusPause`	Este evento se activa cuando se detiene la descarga. A menudo, se usa en combinación con el evento `FIRStorageTaskStatusResume`.
`FIRStorageTaskStatusSuccess`	Este evento se activa cuando se completa correctamente una descarga.
`FIRStorageTaskStatusFailure`	Este evento se activa cuando falla una descarga. Inspecciona el error para determinar el motivo de la falla.

Cuando ocurre un evento, se envía un objeto FIRStorageTaskSnapshot. Esta instantánea es una vista inmutable de la tarea en el momento en que ocurrió el evento. Este objeto contiene las siguientes propiedades:

Propiedad	Tipo	Descripción
`progress`	`NSProgress`	Un objeto `NSProgress` que contiene el progreso de la descarga.
`error`	`NSError`	Un error que ocurrió durante la descarga, si lo hubo.
`metadata`	`FIRStorageMetadata`	`nil` en las descargas.
`task`	`FIRStorageDownloadTask`	La tarea a la que corresponde esta instantánea, que se puede utilizar para administrar la tarea (`pause`, `resume` y `cancel`).
`reference`	`FIRStorageReference`	La referencia de la que provino la tarea.

También puedes quitar observadores, ya sea individualmente, por estado o quitarlos todos.

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

Para evitar fugas de memoria, todos los observadores se quitan después de que ocurre un FIRStorageTaskStatusSuccess o un FIRStorageTaskStatusFailure.

Soluciona errores

Existen varios motivos por los cuales se pueden producir errores en una descarga: por ejemplo, es posible que el archivo no exista o que el usuario no tenga permiso para acceder al archivo deseado. Para obtener más información sobre los errores, consulta la sección de los documentos denominada Soluciona errores.

Ejemplo completo

A continuación, se muestra un ejemplo completo de descarga a un archivo local con manejo de errores:

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

También puedes obtener y actualizar metadatos para los archivos almacenados en Cloud Storage.