Vos fichiers sont stockés dans un bucket Cloud Storage for Firebase. Les fichiers de ce bucket sont présentés dans une structure hiérarchique, tout comme le système de fichiers de votre disque dur local.
En créant une référence à un fichier, votre application y accède. Une référence peut pointer vers un fichier spécifique ou vers un nœud de niveau supérieur dans la hiérarchie. On peut considérer qu'il s'agit d'un pointeur vers le fichier ou le nœud dans le cloud. Après avoir créé une référence, vous pouvez l'utiliser pour effectuer des opérations (par exemple, importer ou télécharger des données, obtenir ou mettre à jour des métadonnées, ou supprimer le fichier).
Cette page explique comment utiliser le SDK Cloud Storage for Firebase pour créer et utiliser des références.
Créer une référence
Pour effectuer des opérations sur un fichier, vous devez d'abord créer une référence à ce fichier. Les références sont légères. Vous pouvez donc en créer autant que nécessaire. Ils sont également réutilisables pour plusieurs opérations.
Les références sont créées à l'aide du service FirebaseStorage et en appelant sa méthode reference.
Swift
// Get a reference to the storage service using the default Firebase App let storage = Storage.storage() // Create a storage reference from our storage service let storageRef = storage.reference()
Objective-C
// Get a reference to the storage service using the default Firebase App FIRStorage *storage = [FIRStorage storage]; // Create a storage reference from our storage service FIRStorageReference *storageRef = [storage reference];
Vous pouvez créer une référence à un emplacement situé plus bas dans l'arborescence, par exemple 'images/space.jpg', en utilisant la méthode child sur une référence existante.
Swift
// Create a child reference // imagesRef now points to "images" let imagesRef = storageRef.child("images") // Child references can also take paths delimited by '/' // spaceRef now points to "images/space.jpg" // imagesRef still points to "images" var spaceRef = storageRef.child("images/space.jpg") // This is equivalent to creating the full reference let storagePath = "\(your_firebase_storage_bucket)/images/space.jpg" spaceRef = storage.reference(forURL: storagePath)
Objective-C
// Create a child reference // imagesRef now points to "images" FIRStorageReference *imagesRef = [storageRef child:@"images"]; // Child references can also take paths delimited by '/' // spaceRef now points to "images/space.jpg" // imagesRef still points to "images" FIRStorageReference *spaceRef = [storageRef child:@"images/space.jpg"]; // This is equivalent to creating the full reference spaceRef = [storage referenceForURL:@"gs://<your-firebase-storage-bucket>/images/space.jpg"];
Naviguer avec des références
Vous pouvez également utiliser les méthodes parent et root pour remonter dans la hiérarchie de vos fichiers. parent permet de remonter d'un niveau, tandis que root permet de remonter tout en haut.
Swift
// Parent allows us to move to the parent of a reference // imagesRef now points to 'images' let imagesRef = spaceRef.parent() // Root allows us to move all the way back to the top of our bucket // rootRef now points to the root let rootRef = spaceRef.root()
Objective-C
// Parent allows us to move to the parent of a reference // 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 FIRStorageReference *rootRef = [spaceRef root];
child, parent et root peuvent être enchaînés plusieurs fois, car chacun renvoie une référence. La seule exception est le parent de root, qui est nil.
Swift
// References can be chained together multiple times // earthRef points to "images/earth.jpg" let earthRef = spaceRef.parent()?.child("earth.jpg") // nilRef is nil, since the parent of root is nil let nilRef = spaceRef.root().parent()
Objective-C
// References can be chained together multiple times // earthRef points to "images/earth.jpg" FIRStorageReference *earthRef = [[spaceRef parent] child:@"earth.jpg"]; // nilRef is nil, since the parent of root is nil FIRStorageReference *nilRef = [[spaceRef root] parent];
Propriétés de référence
Vous pouvez inspecter les références pour mieux comprendre les fichiers vers lesquels elles pointent à l'aide des propriétés fullPath, name et bucket. Ces propriétés obtiennent le chemin d'accès complet, le nom et le bucket du fichier.
Swift
// 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
Objective-C
// 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;
Limites des références
Les chemins d'accès et les noms de référence peuvent contenir n'importe quelle séquence de caractères Unicode valides, mais certaines restrictions sont imposées, y compris :
- La longueur totale de reference.fullPath doit être comprise entre 1 et 1 024 octets lorsqu'elle est encodée en UTF-8.
- Pas de caractères de retour chariot ni de saut de ligne.
- Évitez d'utiliser
#,[,],*ou?, car ils ne fonctionnent pas bien avec d'autres outils tels que Firebase Realtime Database ou gsutil.
Exemple complet
Swift
// Points to the root reference let storageRef = Storage.storage().reference() // Points to "images" let imagesRef = storageRef.child("images") // Points to "images/space.jpg" // Note that you can use variables to create child values let fileName = "space.jpg" let spaceRef = imagesRef.child(fileName) // File path is "images/space.jpg" let path = spaceRef.fullPath // File name is "space.jpg" let name = spaceRef.name // Points to "images" let images = spaceRef.parent()
Objective-C
// Points to the root reference FIRStorageReference *storageRef = [[FIRStorage storage] reference]; // Points to "images" FIRStorageReference *imagesRef = [storageRef child:@"images"]; // Points to "images/space.jpg" // Note that you can use variables to create child values NSString *fileName = @"space.jpg"; FIRStorageReference *spaceRef = [imagesRef child:fileName]; // File path is "images/space.jpg" NSString *path = spaceRef.fullPath; // File name is "space.jpg" NSString *name = spaceRef.name; // Points to "images" imagesRef = [spaceRef parent];
Découvrez ensuite comment importer des fichiers dans Cloud Storage.