Créer une référence Cloud Storage sur Android

Vos fichiers sont stockés dans un bucket Cloud Storage. Les fichiers de ce bucket sont présentés dans une structure hiérarchique, comme le système de fichiers de votre disque dur local ou les données dans le Firebase Realtime Database. En créant une référence à un fichier, votre application y a accès. Ces références peuvent ensuite être utilisées pour importer ou télécharger des données, obtenir ou mettre à jour des métadonnées, ou supprimer le fichier. Une référence peut désigner un fichier spécifique ou un nœud de niveau supérieur dans la hiérarchie.

Si vous avez utilisé Firebase Realtime Database, ces chemins vous sembleront très familiers. Toutefois, vos données de fichier sont stockées dans Cloud Storage, et non dans Realtime Database.

Créer une référence

Créez une référence pour importer, télécharger ou supprimer un fichier, ou pour obtenir ou mettre à jour ses métadonnées. Une référence peut être considérée comme un pointeur vers un fichier dans le cloud. Les références étant légères, vous pouvez en créer autant que nécessaire. Ils sont également réutilisables pour de multiples opérations.

Créez une référence à l'aide de l'instance singleton FirebaseStorage et en appelant sa méthode 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

Vous pouvez ensuite créer une référence à un emplacement plus bas dans l'arborescence, par exemple "images/space.jpg", à l'aide de la méthode child() sur une référence existante.

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

Vous pouvez également utiliser les méthodes getParent() et getRoot() pour remonter dans notre hiérarchie de fichiers. getParent() permet de monter d'un niveau, tandis que getRoot() permet de monter jusqu'en haut.

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

child(), getParent() et getRoot() peuvent être enchaînés plusieurs fois, car chacun renvoie une référence. Toutefois, l'appel de getRoot().getParent() renvoie 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

Propriétés de référence

Vous pouvez inspecter les références pour mieux comprendre les fichiers auxquels elles font référence à l'aide des méthodes getPath(), getName() et getBucket(). Ces méthodes obtiennent le chemin d'accès complet, le nom et le bucket du fichier.

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

Limites concernant les références

Les noms et les chemins de référence peuvent contenir n'importe quelle séquence de caractères Unicode valides, mais certaines restrictions s'appliquent, y compris les suivantes :

  1. La longueur totale de reference.fullPath doit être comprise entre 1 et 1 024 octets lorsqu'elle est encodée en UTF-8.
  2. Aucun caractère de retour chariot ni de saut de ligne.
  3. Évitez d'utiliser #, [, ], * ou ?, car ils ne fonctionnent pas bien avec d'autres outils tels que Firebase Realtime Database ou gsutil.

Exemple complet

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

Découvrez ensuite comment importer des fichiers dans Cloud Storage.