Criar uma referência do Cloud Storage no Android

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. Além disso, são reutilizáveis em diversas operações.

Crie uma referência usando a instância singleton FirebaseStorage e chamando o método getReference().

Kotlin+KTX

// Create a storage reference from our app
var storageRef = storage.reference
StorageActivity.kt

Java

// Create a storage reference from our app
StorageReference storageRef = storage.getReference();
StorageActivity.java

A seguir, é possível criar uma referência a um local inferior da árvore, como "images/space.jpg" ao usar o método child() em uma referência já existente.

Kotlin+KTX

// Create a child reference
// imagesRef now points to "images"
var imagesRef: StorageReference? = storageRef.child("images")

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

Java

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

// Child references can also take paths
// spaceRef now points to "images/space.jpg
// imagesRef still points to "images"
StorageReference spaceRef = storageRef.child("images/space.jpg");
StorageActivity.java

Você também pode usar os métodos getParent() e getRoot() para navegar até uma posição superior da sua hierarquia de arquivos. O método getParent() navega até um nível acima, enquanto que getRoot() navega até o topo.

Kotlin+KTX

// parent allows us to move our reference to a parent node
// 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
val rootRef = spaceRef.root
StorageActivity.kt

Java

// getParent allows us to move our reference to a parent node
// imagesRef now points to 'images'
imagesRef = spaceRef.getParent();

// getRoot allows us to move all the way back to the top of our bucket
// rootRef now points to the root
StorageReference rootRef = spaceRef.getRoot();
StorageActivity.java

Como cada um desses métodos retorna uma referência, child(), getParent() e getRoot() podem ser chamados um sobre o outro várias vezes. Porém, chamar getRoot().getParent() retorna null.

Kotlin+KTX

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

// nullRef is null, since the parent of root is null
val nullRef = spaceRef.root.parent
StorageActivity.kt

Java

// References can be chained together multiple times
// earthRef points to 'images/earth.jpg'
StorageReference earthRef = spaceRef.getParent().child("earth.jpg");

// nullRef is null, since the parent of root is null
StorageReference nullRef = spaceRef.getRoot().getParent();
StorageActivity.java

Propriedades de referência

É possível inspecionar referências para entender melhor os arquivos aos quais elas apontam usando os métodos getPath(), getName() e getBucket(). Esses métodos retornam o caminho completo, o nome e o bucket do arquivo.

Kotlin+KTX

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

// 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 that the files are stored in
spaceRef.bucket
StorageActivity.kt

Java

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

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

// Reference's bucket is the name of the storage bucket that the files are stored in
spaceRef.getBucket();
StorageActivity.java

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

Kotlin+KTX

// Points to the root reference
storageRef = storage.reference

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

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

// File path is "images/space.jpg"
val path = spaceRef.path

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

// Points to "images"
imagesRef = spaceRef.parent
StorageActivity.kt

Java

// Points to the root reference
storageRef = storage.getReference();

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

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

// File path is "images/space.jpg"
String path = spaceRef.getPath();

// File name is "space.jpg"
String name = spaceRef.getName();

// Points to "images"
imagesRef = spaceRef.getParent();
StorageActivity.java

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