Créer une référence Cloud Storage sur les plateformes Apple

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

Si vous avez utilisé Firebase Realtime Database , ces chemins devraient vous sembler très familiers. Cependant, vos données de fichiers sont stockées dans Cloud Storage et non dans la base de données en temps réel.

Créer une référence

Créez une référence pour charger, 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 sont légères, vous pouvez donc en créer autant que vous le souhaitez. 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 .

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

// 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 plus bas dans l'arborescence, par exemple 'images/space.jpg' , en utilisant la méthode child sur une référence existante.

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

// 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 les références

Vous pouvez également utiliser les méthodes parent et root pour remonter dans notre hiérarchie de fichiers. parent monte d'un niveau, tandis que root navigue jusqu'au sommet.

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

// 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. L'exception est le parent de root , qui est nil .

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

// 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 complet, le nom et le compartiment du fichier.

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

// 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 et noms de référence peuvent contenir n'importe quelle séquence de caractères Unicode valides, mais certaines restrictions sont imposées, notamment :

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

Exemple complet

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

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

Voyons ensuite comment télécharger des fichiers sur Cloud Storage.