Baixe arquivos com Cloud Storage em plataformas Apple

O Cloud Storage para Firebase permite fazer download de arquivos de forma rápida e fácil de um bucket do Cloud Storage fornecido e gerenciado pelo Firebase.

Observação: por padrão, um bucket do Cloud Storage requer o Firebase Authentication para executar qualquer ação nos dados ou arquivos do bucket. Você pode alterar as regras de segurança do Firebase para Cloud Storage para permitir acesso não autenticado. Como o Firebase e o aplicativo padrão do App Engine do seu projeto compartilham esse intervalo, configurar o acesso público também pode tornar os arquivos do App Engine recém-carregados acessíveis ao público também. Certifique-se de restringir o acesso ao seu bucket do Cloud Storage novamente ao configurar a autenticação.

Crie uma referência

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

Você pode criar uma referência anexando caminhos secundários à raiz do bucket do Cloud Storage ou pode criar uma referência a partir de um URL gs:// ou https:// existente que faz referência a um objeto no Cloud Storage.

Rápido

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

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

Baixar arquivos

Depois de ter uma referência, você poderá baixar arquivos do Cloud Storage de três maneiras:

1. Baixe para NSData na memória
2. Faça download para um NSURL que representa um arquivo no dispositivo
3. Gere um NSURL representando o arquivo online

Baixar na memória

Baixe o arquivo para um objeto NSData na memória usando o método dataWithMaxSize:completion: Esta é a maneira mais fácil de baixar um arquivo rapidamente, mas deve carregar todo o conteúdo do arquivo na memória. Se você solicitar um arquivo maior que a memória disponível do seu aplicativo, ele irá travar. Para se proteger contra problemas de memória, defina o tamanho máximo para algo que você sabe que seu aplicativo pode suportar ou use outro método de download.

Rápido

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

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

Baixar para um arquivo local

O método writeToFile:completion: baixa um arquivo diretamente para um dispositivo local. Use isto se seus usuários quiserem ter acesso ao arquivo off-line ou compartilhar em um aplicativo diferente. writeToFile:completion: retorna um FIRStorageDownloadTask que você pode usar para gerenciar seu download e monitorar o status do upload.

Rápido

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

Objetivo-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 quiser gerenciar ativamente seu download, você pode usar o método writeToFile: e observar a tarefa de download, em vez de usar o manipulador de conclusão. Consulte Gerenciar downloads para obter mais informações.

Gere um URL de download

Se você já tem uma infraestrutura de download baseada em URLs ou apenas deseja compartilhar um URL, poderá obter o URL de download de um arquivo chamando o método downloadURLWithCompletion: em uma referência do Cloud Storage.

Rápido

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

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

Baixando imagens com FirebaseUI

O FirebaseUI fornece vinculações móveis nativas simples, personalizáveis ​​e prontas para produção para eliminar códigos clichê e promover as práticas recomendadas do Google. Usando o FirebaseUI, você pode baixar, armazenar em cache e exibir imagens do Cloud Storage de maneira rápida e fácil usando nossa integração com SDWebImage .

Primeiro, adicione FirebaseUI ao seu Podfile :

pod 'FirebaseStorageUI'

Depois, você pode carregar imagens diretamente do Cloud Storage em um UIImageView :

Rápido

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

Objetivo-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 pause , resume e cancel que você pode observar.

Rápido

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

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

Monitore o progresso do download

Você pode anexar observadores a FIRStorageDownloadTask s para monitorar o progresso do download. Adicionar um observador retorna um FIRStorageHandle que pode ser usado para remover o observador.

Rápido

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

Objetivo-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	Esse evento é acionado quando a tarefa inicia ou retoma o download e geralmente é usado em conjunto com o evento FIRStorageTaskStatusPause .
FIRStorageTaskStatusProgress	Esse evento é acionado sempre que os dados são baixados do Cloud Storage e pode ser usado para preencher um indicador de progresso do download.
FIRStorageTaskStatusPause	Esse evento é acionado sempre que o download é pausado e geralmente é usado em conjunto com o evento FIRStorageTaskStatusResume .
FIRStorageTaskStatusSuccess	Este evento é acionado quando um download é concluído com êxito.
FIRStorageTaskStatusFailure	Este evento é acionado quando um download falha. Inspecione o erro para determinar o motivo da falha.

Quando ocorre um evento, um objeto FIRStorageTaskSnapshot é passado de volta. Este instantâneo é uma visão imutável da tarefa no momento em que o evento ocorreu. Este 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 que ocorreu durante o download, se houver.
metadata	FIRStorageMetadata	nil em downloads.
task	FIRStorageDownloadTask	A tarefa da qual este é um instantâneo, que pode ser usado para gerenciar ( pause , resume , cancel ) a tarefa.
reference	FIRStorageReference	A referência de onde veio esta tarefa.

Você também pode remover observadores, individualmente, por status ou removendo todos eles.

Rápido

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

Objetivo-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 após a ocorrência de um FIRStorageTaskStatusSuccess ou FIRStorageTaskStatusFailure .

Lidar com erros

Existem vários motivos pelos quais podem ocorrer erros no download, incluindo o arquivo não existir ou o usuário não ter permissão para acessar o arquivo desejado. Mais informações sobre erros podem ser encontradas na seção Tratar erros da documentação.

Exemplo completo

Um exemplo completo de download para um arquivo local com tratamento de erros é mostrado abaixo:

Rápido

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

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

Você também pode receber e atualizar metadados de arquivos armazenados no Cloud Storage.