Usa i metadati dei file con Cloud Storage sul Web

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

Ottieni i metadati del file

I metadati del 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() . getMetadata() restituisce una Promise contenente i metadati completi o un errore se la Promise viene rifiutata.

import { getStorage, ref, getMetadata } from "firebase/storage";

// Create a reference to the file whose metadata we want to retrieve
const storage = getStorage();
const forestRef = ref(storage, 'images/forest.jpg');

// Get metadata properties
getMetadata(forestRef)
  .then((metadata) => {
    // Metadata now contains the metadata for 'images/forest.jpg'
  })
  .catch((error) => {
    // Uh-oh, an error occurred!
  });
storage_get_metadata.js

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

// Get metadata properties
forestRef.getMetadata()
  .then((metadata) => {
    // Metadata now contains the metadata for 'images/forest.jpg'
  })
  .catch((error) => {
    // Uh-oh, an error occurred!
  });
file-metadata.js

Aggiorna i metadati del file

È possibile aggiornare i metadati del file in qualsiasi momento dopo il completamento del caricamento del file utilizzando il metodo updateMetadata() . Fare riferimento all'elenco completo per ulteriori informazioni su quali proprietà possono essere aggiornate. Vengono aggiornate solo le proprietà specificate nei metadati, tutte le altre non vengono modificate. updateMetadata() restituisce una Promise contenente i metadati completi o un errore se la Promise viene rifiutata.

import { getStorage, ref, updateMetadata } from "firebase/storage";

// Create a reference to the file whose metadata we want to change
const storage = getStorage();
const forestRef = ref(storage, 'images/forest.jpg');

// Create file metadata to update
const newMetadata = {
  cacheControl: 'public,max-age=300',
  contentType: 'image/jpeg'
};

// Update metadata properties
updateMetadata(forestRef, newMetadata)
  .then((metadata) => {
    // Updated metadata for 'images/forest.jpg' is returned in the Promise
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
storage_update_metadata.js

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

// Create file metadata to update
var newMetadata = {
  cacheControl: 'public,max-age=300',
  contentType: 'image/jpeg'
};

// Update metadata properties
forestRef.updateMetadata(newMetadata)
  .then((metadata) => {
    // Updated metadata for 'images/forest.jpg' is returned in the Promise
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
file-metadata.js

Puoi eliminare una proprietà dei metadati impostandola su null :

import { getStorage, ref, updateMetadata } from "firebase/storage";

const storage = getStorage();
const forestRef = ref(storage, 'images/forest.jpg');

// Create file metadata with property to delete
const deleteMetadata = {
  contentType: null
};

// Delete the metadata property
updateMetadata(forestRef, deleteMetadata)
  .then((metadata) => {
    // metadata.contentType should be null
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
storage_delete_metadata.js

// Create file metadata with property to delete
var deleteMetadata = {
  contentType: null
};

// Delete the metadata property
forestRef.updateMetadata(deleteMetadata)
  .then((metadata) => {
    // metadata.contentType should be null
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
file-metadata.js

Gestire gli errori

Esistono diversi motivi per cui possono verificarsi errori durante l'acquisizione o l'aggiornamento dei metadati, incluso il file non esistente o l'utente che non dispone dell'autorizzazione per accedere al file desiderato. Ulteriori informazioni sugli errori sono disponibili nella sezione Gestione degli errori dei documenti.

Metadati personalizzati

È possibile specificare metadati personalizzati come oggetto contenente proprietà String .

const metadata = {
  customMetadata: {
    'location': 'Yosemite, CA, USA',
    'activity': 'Hiking'
  }
};
storage_custom_metadata.js

var metadata = {
  customMetadata: {
    'location': 'Yosemite, CA, USA',
    'activity': 'Hiking'
  }
};
file-metadata.js

Puoi utilizzare metadati personalizzati per archiviare dati aggiuntivi specifici dell'app per ciascun file, ma ti consigliamo vivamente di utilizzare un database (come Firebase Realtime Database ) per archiviare e sincronizzare questo tipo di dati.

Proprietà dei metadati del file

Di seguito è disponibile un elenco completo delle proprietà dei metadati su un file:

Il caricamento, il download e l'aggiornamento dei file è importante, ma lo è anche la possibilità di rimuoverli. Impariamo come eliminare i file da Cloud Storage.