Verwenden Sie Dateimetadaten mit Cloud Storage on Web

Nach dem Hochladen einer Datei in die Cloud Storage-Referenz können Sie auch die Dateimetadaten abrufen oder aktualisieren, um beispielsweise den Inhaltstyp zu aktualisieren. Dateien können auch benutzerdefinierte Schlüssel/Wert-Paare mit zusätzlichen Dateimetadaten speichern.

Dateimetadaten abrufen

Dateimetadaten enthalten allgemeine Eigenschaften wie name , size und contentType (häufig als MIME-Typ bezeichnet) zusätzlich zu einigen weniger häufigen wie contentDisposition und timeCreated . Diese Metadaten können mit der Methode getMetadata() aus einer Cloud Storage-Referenz abgerufen werden. getMetadata() gibt ein Promise zurück, das die vollständigen Metadaten enthält, oder einen Fehler, wenn das Promise ablehnt.

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

Dateimetadaten aktualisieren

Sie können Dateimetadaten jederzeit nach Abschluss des Datei-Uploads aktualisieren, indem Sie die Methode updateMetadata() verwenden. Weitere Informationen dazu, welche Eigenschaften aktualisiert werden können, finden Sie in der vollständigen Liste . Nur die in den Metadaten angegebenen Eigenschaften werden aktualisiert, alle anderen bleiben unverändert. updateMetadata() gibt ein Promise zurück, das die vollständigen Metadaten enthält, oder einen Fehler, wenn das Promise ablehnt.

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

Sie können eine Metadateneigenschaft löschen, indem Sie sie auf null setzen:

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

Fehler behandeln

Es gibt eine Reihe von Gründen, warum beim Abrufen oder Aktualisieren von Metadaten Fehler auftreten können, einschließlich der Datei, die nicht vorhanden ist, oder des Benutzers, der keine Berechtigung zum Zugriff auf die gewünschte Datei hat. Weitere Informationen zu Fehlern finden Sie im Abschnitt Fehler behandeln der Dokumentation.

Benutzerdefinierte Metadaten

Sie können benutzerdefinierte Metadaten als Objekt angeben, das String Eigenschaften enthält.

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

Sie können benutzerdefinierte Metadaten zum Speichern zusätzlicher anwendungsspezifischer Daten für jede Datei verwenden, aber wir empfehlen dringend, eine Datenbank (z. B. die Firebase Realtime Database ) zum Speichern und Synchronisieren dieser Art von Daten zu verwenden.

Datei-Metadaten-Eigenschaften

Eine vollständige Liste der Metadateneigenschaften einer Datei finden Sie unten:

Das Hochladen, Herunterladen und Aktualisieren von Dateien ist wichtig, aber auch die Möglichkeit, sie zu entfernen. Lassen Sie uns lernen, wie Sie Dateien aus Cloud Storage löschen .