Creare un riferimento a Cloud Storage su Flutter

I file vengono archiviati in un bucket Cloud Storage. I file in questo bucket sono presentati in una struttura gerarchica, proprio come il file system sul tuo disco rigido locale o i dati in Firebase Realtime Database. Creando un riferimento a un file, la tua app ne ottiene l'accesso. Questi riferimenti possono essere utilizzati per caricare o scaricare dati, recuperare o aggiornare i metadati o eliminare il file. Un riferimento può puntare a un file specifico o a un nodo di livello superiore nella gerarchia.

Se hai utilizzato Firebase Realtime Database, questi percorsi dovrebbero essere molto familiari. Tuttavia, i dati dei file vengono archiviati in Cloud Storage, non in Realtime Database.

Creazione di un riferimento

Creare un riferimento per caricare, scaricare o eliminare un file o per ottenere o aggiornare i relativi metadati. Un riferimento può essere considerato come un puntatore a un file nel cloud. I riferimenti sono leggeri, quindi puoi crearne quanti ne hai bisogno. Inoltre, sono riutilizzabili per più operazioni.

Crea un riferimento utilizzando l'istanza singleton FirebaseStorage e chiamando il relativo metodo ref().

final storageRef = FirebaseStorage.instance.ref();

Successivamente, puoi creare un riferimento a una posizione più in basso nell'albero, ad esempio "images/space.jpg", utilizzando il metodo child() su un riferimento esistente.

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

// Child references can also take paths
// spaceRef now points to "images/space.jpg
// imagesRef still points to "images"
final spaceRef = storageRef.child("images/space.jpg");

Puoi anche utilizzare le proprietà parent e root per risalire nella gerarchia dei file. parent consente di salire di un livello, mentre root consente di andare fino in alto.

// parent allows us to move our reference to a parent node
// imagesRef2 now points to 'images'
final imagesRef2 = spaceRef.parent;

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

child(), parent e root possono essere messi in catena più volte, poiché ognuno è un riferimento. Tuttavia, l'accesso a root.parent genera null.

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

// nullRef is null, since the parent of root is null
final nullRef = spaceRef.root.parent;

Proprietà di riferimento

Puoi ispezionare i riferimenti per comprendere meglio i file a cui rimandano utilizzando le proprietà fullPath, name e bucket. Queste proprietà recuperano il percorso, il nome e il bucket completi del file.

// 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 that the files are stored in
spaceRef.bucket;

Limitazioni relative ai riferimenti

I percorsi e i nomi di riferimento possono contenere qualsiasi sequenza di caratteri Unicode validi, ma sono imposte alcune limitazioni, tra cui:

  1. La lunghezza totale di reference.fullPath deve essere compresa tra 1 e 1024 byte quando è codificata in UTF-8.
  2. Nessun carattere di ritorno a capo o di a capo.
  3. Evita di utilizzare #, [, ], * o ?, poiché non funzionano bene con altri strumenti come Firebase Realtime Database o gsutil.

Esempio completo

// Points to the root reference
final storageRef = FirebaseStorage.instance.ref();

// Points to "images"
Reference? imagesRef = storageRef.child("images");

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

// File path is "images/space.jpg"
final path = spaceRef.fullPath;

// File name is "space.jpg"
final name = spaceRef.name;

// Points to "images"
imagesRef = spaceRef.parent;

Ora scopriamo come caricare file su Cloud Storage.