Utilizzare i metadati dei file con Cloud Storage su Flutter

Dopo aver caricato un file nel riferimento Cloud Storage, puoi anche recuperare e aggiornare i metadati del file, ad esempio per visualizzare o aggiornare il tipo di contenuti. I file possono anche memorizzare coppie chiave/valore personalizzate con metadati aggiuntivi dei file.

Recupera i metadati del file

I metadati dei file contengono proprietà comuni come name, size e contentType (spesso indicato come tipo MIME), oltre ad alcune meno comuni come contentDisposition e timeCreated. Questi metadati possono essere recuperati da un riferimento Cloud Storage utilizzando il metodo getMetadata().

// Create reference to the file whose metadata we want to retrieve
final forestRef = storageRef.child("images/forest.jpg");

// Get metadata properties
final metadata = await forestRef.getMetadata();

// Metadata now contains the metadata for 'images/forest.jpg'

Aggiornare i metadati del file

Puoi aggiornare i metadati dei file in qualsiasi momento al termine del caricamento utilizzando il metodo updateMetadata(). Consulta l'elenco completo per ulteriori informazioni sulle proprietà che possono essere aggiornate. Vengono aggiornate solo le proprietà specificate nei metadati, mentre tutte le altre rimangono invariate.

// Create reference to the file whose metadata we want to change
final forestRef = storageRef.child("images/forest.jpg");

// Create file metadata to update
final newMetadata = SettableMetadata(
  cacheControl: "public,max-age=300",
  contentType: "image/jpeg",
);

// Update metadata properties
final metadata = await forestRef.updateMetadata(newMetadata);

// Updated metadata for 'images/forest.jpg' is returned

Puoi eliminare le proprietà dei metadati scrivibili passando null:

// Delete the cacheControl property
final newMetadata = SettableMetadata(cacheControl: null);
final metadata = await forestRef.updateMetadata(newMetadata);

Gestire gli errori

Esistono diversi motivi per cui potrebbero verificarsi errori durante l'ottenimento o l'aggiornamento dei metadati, tra cui il fatto che il file non esista o che l'utente non abbia l'autorizzazione per accedere al file desiderato. Puoi trovare ulteriori informazioni sugli errori nella sezione Gestire gli errori della documentazione.

Metadati personalizzati

Puoi specificare metadati personalizzati utilizzando il parametro customMetadata del costruttore SettableMetadata:

// Create reference to the file whose metadata we want to change
final forestRef = storageRef.child("images/forest.jpg");

// Create file metadata to update
final newCustomMetadata = SettableMetadata(
  customMetadata: {
    "location": "Yosemite, CA, USA",
    "activity": "Hiking",
  },
);

// Update metadata properties
final metadata = await forestRef.updateMetadata(newCustomMetadata);

// Updated metadata for 'images/forest.jpg' is returned

Puoi archiviare i dati specifici dell'app per ogni file nei metadati personalizzati, ma ti consigliamo vivamente di utilizzare un database (ad esempio Firebase Realtime Database) per archiviare e sincronizzare questo tipo di dati.

Proprietà dei metadati dei file

Di seguito è riportato un elenco completo delle proprietà dei metadati di un file:

Proprietà	Tipo	Impostabile?
bucket	String	No
generation	String	No
metageneration	String	No
metadataGeneration	String	No
fullPath	String	No
name	String	No
size	int	No
timeCreated	DateTime	No
updated	DateTime	No
md5Hash	String	No
cacheControl	String	Sì
contentDisposition	String	Sì
contentEncoding	String	Sì
contentLanguage	String	Sì
contentType	String	Sì
customMetadata	Map<String, String>	Sì

Caricare, scaricare e aggiornare i file è importante, ma lo è anche la possibilità di rimuoverli. Scopri come eliminare file da Cloud Storage.