Fazer o download de arquivos com o Cloud Storage em plataformas da Apple

Com o Cloud Storage para Firebase, é possível fazer o download de maneira rápida e fácil de arquivos de um bucket do Cloud Storage fornecido e gerenciado pelo Firebase.

Observação: por padrão, para executar qualquer ação nos dados ou arquivos de um bucket do Cloud Storage, o Firebase Authentication é exigido. Para permitir o acesso não autenticado, altere as regras de segurança do Firebase para o Cloud Storage. Como o Firebase e o app padrão do App Engine do seu projeto compartilham esse bucket, a configuração do acesso público também pode afetar arquivos do App Engine enviados recentemente. Restrinja novamente o acesso ao bucket do Cloud Storage quando configurar o Authentication.

Criar uma referência

Para fazer o download de um arquivo, primeiro crie uma referência do Cloud Storage para o arquivo que você quer transferir.

Crie uma referência anexando caminhos filhos à raiz do bucket do Cloud Storage ou crie uma referência usando um URL gs:// ou https:// ao referenciar um objeto no 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"];
  

Fazer o download de arquivos

Com uma referência, é possível fazer o download de arquivos do Cloud Storage de três maneiras:

1. Fazer o download para NSData na memória
2. Fazer o download para um NSURL que representa um arquivo no dispositivo.
3. Gerar um NSURL que represente o arquivo on-line.

Fazer download em memória

Faça o download do arquivo para um objeto NSData na memória usando o método dataWithMaxSize:completion:. Essa é a forma mais fácil e rápida de fazer isso, mas exige o carregamento de todo o conteúdo desse arquivo para a memória. Se o arquivo solicitado for maior do que a memória disponível do seu app, ocorrerá uma falha. Para evitar esse problema, configure um tamanho máximo que possa ser processado pelo app ou use outro método de download.

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

Fazer o download para um arquivo local

O método writeToFile:completion: faz o download de um arquivo diretamente para um dispositivo local. Use essa opção se os usuários quiserem acessar o arquivo off-line ou compartilhar em outro aplicativo. O writeToFile:completion: retorna um FIRStorageDownloadTask que você pode usar para gerenciar o download e monitorar o status do 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
  }
}];
    

Se você quiser gerenciar o download ativamente, use o método writeToFile: e observe a tarefa de download em vez de usar o gerenciador de conclusão. Saiba mais em Gerenciar downloads.

Gerar um URL de download

Se você já tiver uma infraestrutura de download com base em URLs ou apenas quiser um URL para compartilhar, você poderá obter o URL de download de um arquivo chamando o método downloadURLWithCompletion: em uma referência do 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'
  }
}];
    

Como fazer download de imagens com a FirebaseUI

A FirebaseUI fornece vinculações simples, personalizáveis e prontas para produção com dispositivos móveis nativos, que ajudam a eliminar o código boilerplate e incentivam o uso das práticas recomendadas do Google. Com a FirebaseUI, é possível fazer o download, armazenar em cache e exibir imagens de maneira rápida e fácil a partir do Cloud Storage usando nossa integração com o SDWebImage.

Primeiro, adicione o FirebaseUI ao seu Podfile:

pod 'FirebaseStorageUI'

Em seguida, é possível carregar as imagens diretamente do Cloud Storage para uma 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];
    

Gerenciar downloads

Além de iniciar downloads, você pode pausar, retomar e cancelar downloads usando os métodos pause, resume e cancel. Esses métodos geram eventos pause, resume e cancel que você pode 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];
    

Monitorar o andamento de downloads

Você pode anexar observadores a FIRStorageDownloadTasks para monitorar o progresso do download. Adicionar um observador retorna um FIRStorageHandle que pode ser usado para remover o 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
                                                }];
    

Esses observadores podem ser registrados em um evento FIRStorageTaskStatus:

Evento "FIRStorageTaskStatus"	Uso típico
FIRStorageTaskStatusResume	Este evento é disparado quando a tarefa inicia ou retoma o download e geralmente é usado junto com o evento FIRStorageTaskStatusPause.
FIRStorageTaskStatusProgress	Este evento é disparado quando ocorre um download de dados do Cloud Storage e pode ser usado para preencher um indicador de andamento de download.
FIRStorageTaskStatusPause	Este evento é disparado sempre que o download é pausado e geralmente é usado junto com o evento FIRStorageTaskStatusResume.
FIRStorageTaskStatusSuccess	Acionado quando um download é concluído com sucesso.
FIRStorageTaskStatusFailure	Este evento é disparado quando ocorre uma falha de download. Examine o erro para determinar o motivo dessa falha.

Quando ocorre um evento, um objeto FIRStorageTaskSnapshot é retornado. O snapshot é uma visualização imutável da tarefa no momento em que esse evento ocorreu. Esse objeto contém as seguintes propriedades:

Propriedade	Tipo	Descrição
progress	NSProgress	Um objeto NSProgress que contém o progresso do download.
error	NSError	Um erro ocorrido durante o download, se houver.
metadata	FIRStorageMetadata	nil em downloads.
task	FIRStorageDownloadTask	A tarefa a que se refere o instantâneo, que pode ser usada para gerenciar (pause, resume, cancel) a tarefa.
reference	FIRStorageReference	A referência de onde veio essa tarefa.

Os observadores também podem ser removidos individualmente, por status ou todos de uma vez.

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 vazamentos de memória, todos os observadores são removidos depois que ocorre um FIRStorageTaskStatusSuccess ou FIRStorageTaskStatusFailure.

Lidar com erros

Durante os downloads, é possível que erros ocorram por vários motivos. Por exemplo, o arquivo não existe ou o usuário não tem permissão para acessá-lo. Saiba mais sobre erros na seção Tratar erros.

Exemplo completo

Um exemplo completo de download para um arquivo local com a resolução de um erro é mostrado a seguir:

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

Também é possível receber e atualizar metadados de arquivos armazenados no Cloud Storage.