Crea una referencia de Cloud Storage en Android

Tus archivos se almacenan en un bucket de Cloud Storage. Los archivos que se encuentran en este bucket se presentan en una estructura jerárquica, al igual que el sistema de archivos de tu disco duro local o los datos de Firebase Realtime Database. Cuando creas una referencia a un archivo, tu app obtiene acceso a él. Estas referencias se pueden usar para subir o descargar datos, obtener o actualizar metadatos, o borrar el archivo. Una referencia puede apuntar a un archivo específico o a un nodo de nivel superior de la jerarquía.

Si usaste Firebase Realtime Database, seguramente ya conoces estas rutas. Sin embargo, los datos de tus archivos se almacenan en Cloud Storage, no en Realtime Database.

Crea una referencia

Crea una referencia para subir, descargar o borrar un archivo, o para obtener o actualizar sus metadatos. Se puede decir que una referencia es un indicador que apunta a un archivo en la nube. Las referencias son livianas, por lo que puedes crear todas las que necesites. También se pueden reutilizar en varias operaciones.

Crea una referencia con la instancia singleton FirebaseStorage y con una llamada al método getReference().

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

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

Luego, puedes crear una referencia para una ubicación de un nivel más bajo en el árbol, como "images/space.jpg", mediante el método child() en una referencia existente.

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

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

Navega con referencias

También puedes usar los métodos getParent() y getRoot() para navegar en nuestra jerarquía de archivos. getParent() te permite subir un nivel y getRoot() te permite ir al nivel más alto.

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

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

child(), getParent() y getRoot() se pueden articular en conjunto varias veces, ya que cada uno muestra una referencia. Sin embargo, si se llama a getRoot().getParent(), se muestra null.

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

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

Propiedades de las referencias

Para revisar las referencias y comprender mejor los archivos a los que dirigen, puedes usar los métodos getPath(), getName() y getBucket(). Estos obtienen la ruta de acceso completa, el nombre y el bucket del archivo.

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

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

Limitaciones para las referencias

Las rutas de acceso y los nombres de las referencias pueden contener cualquier secuencia de caracteres Unicode válidos, pero se aplican algunas restricciones, como las siguientes:

1. La longitud total de reference.fullPath debe ser de entre 1 y 1,024 bytes con codificación UTF-8.
2. No se permiten los caracteres de retorno de carro ni de salto de línea.
3. No uses #, [, ], * ni ?, ya que no funcionan correctamente con otras herramientas, como Firebase Realtime Database o gsutil.

Ejemplo completo

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

// 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 continuación, veamos cómo subir archivos a Cloud Storage.