Crie uma referência do Cloud Storage na Web

Seus arquivos são armazenados em um bucket do Cloud Storage . Os arquivos neste bucket são apresentados em uma estrutura hierárquica, assim como o sistema de arquivos no disco rígido local ou os dados no Firebase Realtime Database. Ao criar uma referência a um arquivo, seu aplicativo ganha acesso a ele. Essas referências podem então ser usadas para fazer upload ou download de dados, obter 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ê usou o Firebase Realtime Database , esses caminhos devem parecer muito familiares para você. No entanto, os dados do seu arquivo são armazenados no Cloud Storage, e não no Realtime Database.

Crie uma referência

Para fazer upload ou download de arquivos, excluir arquivos ou obter ou atualizar metadados, você deve criar uma referência ao arquivo no qual deseja operar. Uma referência pode ser considerada um ponteiro para um arquivo na nuvem. As referências são leves, então você pode criar quantas precisar, e também são reutilizáveis ​​para múltiplas operações.

Para criar uma referência, obtenha uma instância do serviço Storage usando getStorage() e chame ref() com o serviço como argumento. Esta referência aponta para a raiz do seu intervalo do Cloud Storage.

Web modular API

import { getStorage, ref } from "firebase/storage";

// Get a reference to the storage service, which is used to create references in your storage bucket
const storage = getStorage();

// Create a storage reference from our storage service
const storageRef = ref(storage);
storage_create_ref.js

Web namespaced API

// Get a reference to the storage service, which is used to create references in your storage bucket
var storage = firebase.storage();

// Create a storage reference from our storage service
var storageRef = storage.ref();
create-reference.js

Você pode criar uma referência para um local mais abaixo na árvore, digamos 'images/space.jpg' passando esse caminho como um segundo argumento ao chamar ref() .

Web modular API

import { getStorage, ref } from "firebase/storage";

const storage = getStorage();

// Create a child reference
const imagesRef = ref(storage, 'images');
// imagesRef now points to 'images'

// Child references can also take paths delimited by '/'
const spaceRef = ref(storage, 'images/space.jpg');
// spaceRef now points to "images/space.jpg"
// imagesRef still points to "images"
storage_create_ref_child.js

Web namespaced API

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

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

Você também pode usar as propriedades parent e root para navegar na hierarquia de arquivos. parent navega um nível acima, enquanto root navega até o topo.

Web modular API

import { getStorage, ref } from "firebase/storage";

const storage = getStorage();
const spaceRef = ref(storage, 'images/space.jpg');

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

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

Web namespaced API

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

// Root allows us to move all the way back to the top of our bucket
var rootRef = spaceRef.root;
// rootRef now points to the root
create-reference.js

child() , parent e root podem ser encadeados várias vezes, pois cada um retorna uma referência. A exceção é o parent de root , que é null .

Web modular API

import { getStorage, ref } from "firebase/storage";

const storage = getStorage();
const spaceRef = ref(storage, 'images/space.jpg');

// References can be chained together multiple times
const earthRef = ref(spaceRef.parent, 'earth.jpg');
// earthRef points to 'images/earth.jpg'

// nullRef is null, since the parent of root is null
const nullRef = spaceRef.root.parent;
storage_navigate_ref_chain.js

Web namespaced API

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

// nullRef is null, since the parent of root is null
var nullRef = spaceRef.root.parent;
create-reference.js

Propriedades de referência

Você pode inspecionar as referências para entender melhor os arquivos para os quais elas apontam usando as propriedades fullPath , name e bucket . Essas propriedades obtêm o caminho completo do arquivo, o nome do arquivo e o bucket em que o arquivo está armazenado.

Web modular API

import { getStorage, ref } from "firebase/storage";

const storage = getStorage();
const spaceRef = ref(storage, 'images/space.jpg');

// 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;
storage_ref_properties.js

Web namespaced API

// 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;
create-reference.js

Limitações nas referências

Os caminhos e nomes de referência podem conter qualquer sequência de caracteres Unicode válidos, mas certas restrições são impostas, incluindo:

  1. O comprimento total de reference.fullPath deve estar entre 1 e 1.024 bytes quando codificado em UTF-8.
  2. Nenhum caractere de retorno de carro ou alimentação de linha.
  3. Evite usar # , [ , ] , * ou ? , pois não funcionam bem com outras ferramentas, como Firebase Realtime Database ou gsutil .

Exemplo completo

Web modular API

import { getStorage, ref } from "firebase/storage";

const storage = getStorage();

// Points to the root reference
const storageRef = ref(storage);

// Points to 'images'
const imagesRef = ref(storageRef, 'images');

// Points to 'images/space.jpg'
// Note that you can use variables to create child values
const fileName = 'space.jpg';
const spaceRef = ref(imagesRef, fileName);

// File path is 'images/space.jpg'
const path = spaceRef.fullPath;

// File name is 'space.jpg'
const name = spaceRef.name;

// Points to 'images'
const imagesRefAgain = spaceRef.parent;
storage_ref_full_example.js

Web namespaced API

// Points to the root reference
var storageRef = firebase.storage().ref();

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

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

// File path is 'images/space.jpg'
var path = spaceRef.fullPath;

// File name is 'space.jpg'
var name = spaceRef.name;

// Points to 'images'
var imagesRef = spaceRef.parent;
create-reference.js

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