Criar uma referência do Cloud Storage no Flutter

Seus arquivos são armazenados em um bucket do Cloud Storage. Eles são apresentados em uma estrutura hierárquica, exatamente como o sistema de arquivos no seu 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, talvez os caminhos pareçam familiares. Porém, os dados dos arquivos são armazenados no Cloud Storage, e 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 ref().

final storageRef = FirebaseStorage.instance.ref();

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.

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

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

Você também pode usar as propriedades parent e root para navegar até uma posição superior da hierarquia de arquivos. O método parent navega até um nível acima, enquanto que root navega até o topo.

// parent allows us to move our reference to a parent node
// imagesRef2 now points to 'images'
final imagesRef2 = spaceRef.parent;

// root allows us to move all the way back to the top of our bucket
// rootRef now points to the root
final rootRef = spaceRef.root;

Como cada um desses métodos é uma referência, child(), parent e root podem ser chamados um sobre o outro várias vezes. Mas acessar root.parent resulta em null.

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

// nullRef is null, since the parent of root is null
final nullRef = 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 bucket do arquivo.

// 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 that the files are stored in
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. Não pode haver nenhum caractere de retorno de carro ou nova linha.
  3. Evite usar #, [, ], * ou ?. Esses caracteres não funcionam bem com outras ferramentas, como o Firebase Realtime Database ou a gsutil.

Exemplo completo

// Points to the root reference
final storageRef = FirebaseStorage.instance.ref();

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

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

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

// File name is "space.jpg"
final name = spaceRef.name;

// Points to "images"
imagesRef = spaceRef.parent;

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