Criar uma referência do Cloud Storage nas plataformas da Apple

Seus arquivos são armazenados em um bucket do Cloud Storage. Os arquivo nesse bucket são apresentados em uma estrutura hierárquica, exatamente como o sistema de arquivos no disco rígido local ou como os dados no Firebase Realtime Database. Quando você cria uma referência a um arquivo, seu app ganha acesso a ele. Essas referências podem ser usadas para fazer upload ou download de dados, receber ou atualizar metadados ou excluir o arquivo. Uma referência pode apontar para um arquivo específico ou para um nó de nível superior na hierarquia.

Se você já usou o Firebase Realtime Database, esses caminhos devem parecer familiares. No entanto, os dados dos arquivos são armazenados no Cloud Storage, não no Realtime Database.

Criar uma referência

Crie uma referência para fazer upload, download ou excluir um arquivo, ou para acessar ou atualizar os metadados dele. Podemos pensar nas referências como indicadores para um arquivo na nuvem. Como elas são leves, você pode criar quantas precisar. e reutilizá-las em diversas operações.

As referências são criadas usando o serviço FirebaseStorage e chamando o método reference.

Swift

// Get a reference to the storage service using the default Firebase App
let storage = Storage.storage()

// Create a storage reference from our storage service
let storageRef = storage.reference()

Objective-C

// Get a reference to the storage service using the default Firebase App
FIRStorage *storage = [FIRStorage storage];

// Create a storage reference from our storage service
FIRStorageReference *storageRef = [storage reference];

Para criar uma referência a um local inferior da árvore, como 'images/space.jpg', use o método child em uma referência existente.

Swift

// Create a child reference
// imagesRef now points to "images"
let imagesRef = storageRef.child("images")

// Child references can also take paths delimited by '/'
// spaceRef now points to "images/space.jpg"
// imagesRef still points to "images"
var spaceRef = storageRef.child("images/space.jpg")

// This is equivalent to creating the full reference
let storagePath = "\(your_firebase_storage_bucket)/images/space.jpg"
spaceRef = storage.reference(forURL: storagePath)

Objective-C

// Create a child reference
// imagesRef now points to "images"
FIRStorageReference *imagesRef = [storageRef child:@"images"];

// Child references can also take paths delimited by '/'
// spaceRef now points to "images/space.jpg"
// imagesRef still points to "images"
FIRStorageReference *spaceRef = [storageRef child:@"images/space.jpg"];

// This is equivalent to creating the full reference
spaceRef = [storage referenceForURL:@"gs://<your-firebase-storage-bucket>/images/space.jpg"];

Você também pode usar os métodos parent e root para navegar até uma posição superior da sua hierarquia de arquivos. O método parent navega até um nível acima e root navega diretamente para o topo.

Swift

// Parent allows us to move to the parent of a reference
// imagesRef now points to 'images'
let imagesRef = spaceRef.parent()

// Root allows us to move all the way back to the top of our bucket
// rootRef now points to the root
let rootRef = spaceRef.root()

Objective-C

// Parent allows us to move to the parent of a reference
// imagesRef now points to 'images'
imagesRef = [spaceRef parent];

// Root allows us to move all the way back to the top of our bucket
// rootRef now points to the root
FIRStorageReference *rootRef = [spaceRef root];

Como cada um desses métodos retorna uma referência, child, parent e root podem ser chamados de maneira concatenada várias vezes. A exceção é o parent do root, que é nil.

Swift

// References can be chained together multiple times
// earthRef points to "images/earth.jpg"
let earthRef = spaceRef.parent()?.child("earth.jpg")

// nilRef is nil, since the parent of root is nil
let nilRef = spaceRef.root().parent()

Objective-C

// References can be chained together multiple times
// earthRef points to "images/earth.jpg"
FIRStorageReference *earthRef = [[spaceRef parent] child:@"earth.jpg"];

// nilRef is nil, since the parent of root is nil
FIRStorageReference *nilRef = [[spaceRef root] parent];

Propriedades de referência

Você pode inspecionar referências para entender melhor os arquivos aos quais elas apontam usando as propriedades fullPath, name e bucket. Essas propriedades recebem o caminho completo, o nome e o intervalo do arquivo.

Swift

// Reference's path is: "images/space.jpg"
// This is analogous to a file path on disk
spaceRef.fullPath

// Reference's name is the last segment of the full path: "space.jpg"
// This is analogous to the file name
spaceRef.name

// Reference's bucket is the name of the storage bucket where files are stored
spaceRef.bucket

Objective-C

// Reference's path is: "images/space.jpg"
// This is analogous to a file path on disk
spaceRef.fullPath;

// Reference's name is the last segment of the full path: "space.jpg"
// This is analogous to the file name
spaceRef.name;

// Reference's bucket is the name of the storage bucket where files are stored
spaceRef.bucket;

Limitações das referências

Os caminhos e os nomes das referências podem conter qualquer sequência de caracteres válidos Unicode, mas com algumas restrições como:

  1. O tamanho total do reference.fullPath precisará ser de 1 a 1.024 bytes quando estiver codificado em UTF-8.
  2. Nenhum caractere de retorno de carro ou nova linha.
  3. Evite usar #, [, ], * ou ?, já que não funcionam bem com outras ferramentas, como o Firebase Realtime Database ou a gsutil.

Exemplo completo

Swift

// Points to the root reference
let storageRef = Storage.storage().reference()

// Points to "images"
let imagesRef = storageRef.child("images")

// Points to "images/space.jpg"
// Note that you can use variables to create child values
let fileName = "space.jpg"
let spaceRef = imagesRef.child(fileName)

// File path is "images/space.jpg"
let path = spaceRef.fullPath

// File name is "space.jpg"
let name = spaceRef.name

// Points to "images"
let images = spaceRef.parent()

Objective-C

// Points to the root reference
FIRStorageReference *storageRef = [[FIRStorage storage] reference];

// Points to "images"
FIRStorageReference *imagesRef = [storageRef child:@"images"];

// Points to "images/space.jpg"
// Note that you can use variables to create child values
NSString *fileName = @"space.jpg";
FIRStorageReference *spaceRef = [imagesRef child:fileName];

// File path is "images/space.jpg"
NSString *path = spaceRef.fullPath;

// File name is "space.jpg"
NSString *name = spaceRef.name;

// Points to "images"
imagesRef = [spaceRef parent];

A seguir, veja como fazer upload de arquivos para o Cloud Storage.