Dateimetadaten mit Cloud Storage im Web verwenden

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

Dateimetadaten abrufen

Dateimetadaten enthalten gängige Eigenschaften wie name, size und contentType (oft als MIME-Typ bezeichnet) sowie einige weniger gängige wie contentDisposition und timeCreated. Diese Metadaten können mithilfe der Methode getMetadata() aus einer Cloud Storage-Referenz abgerufen werden. getMetadata() gibt eine Promise mit den vollständigen Metadaten zurück oder einen Fehler, wenn die Promise abgelehnt wird.

Web

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

Web

// 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 die Dateimetadaten jederzeit nach Abschluss des Dateiuploads mit der Methode updateMetadata() aktualisieren. Weitere Informationen zu den Attributen, die Sie aktualisieren 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 eine Promise mit den vollständigen Metadaten zurück oder einen Fehler, wenn die Promise abgelehnt wird.

Web

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

Web

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

Web

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

Web

// 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 kann verschiedene Gründe dafür geben, dass beim Abrufen oder Aktualisieren von Metadaten Fehler auftreten. Dazu gehört beispielsweise, dass die Datei nicht vorhanden ist oder der Nutzer keine Berechtigung zum Zugriff auf die gewünschte Datei hat. Weitere Informationen zu Fehlern finden Sie im Abschnitt Fehler beheben der Dokumentation.

Benutzerdefinierte Metadaten

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

Web

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

Web

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

Sie können benutzerdefinierte Metadaten verwenden, um zusätzliche appspezifische Daten für jede Datei zu speichern. Wir empfehlen jedoch dringend, eine Datenbank (z. B. die Firebase Realtime Database) zum Speichern und Synchronisieren dieser Art von Daten zu verwenden.

Dateimetadateneigenschaften

Unten findest du eine vollständige Liste der Metadateneigenschaften in einer Datei:

Attribut Typ Beschreibbar
bucket String NEIN
generation String NEIN
metageneration String NEIN
fullPath String NEIN
name String NEIN
size number NEIN
timeCreated String NEIN
updated String NEIN
md5Hash String JA beim Upload, NEIN bei updateMetadata
cacheControl String YES
contentDisposition String YES
contentEncoding String YES
contentLanguage String YES
contentType String YES
customMetadata Objekt mit String-zu-String-Zuordnungen YES

Das Hochladen, Herunterladen und Aktualisieren von Dateien ist wichtig, aber auch das Entfernen von Dateien. Sehen wir uns an, wie Sie Dateien in Cloud Storage löschen.