Dateimetadaten mit Cloud Storage in Flutter verwenden

Nachdem Sie eine Datei in Cloud Storage hochgeladen haben, können Sie auch die Dateimetadaten abrufen und aktualisieren, z. B. um den Inhaltstyp anzusehen oder zu aktualisieren. In Dateien können auch benutzerdefinierte Schlüssel/Wert-Paare mit zusätzlichen Dateimetadaten gespeichert werden.

Dateimetadaten abrufen

Dateimetadaten enthalten allgemeine Attribute wie name, size und contentType (oft als MIME-Typ bezeichnet) sowie einige weniger häufige Attribute wie contentDisposition und timeCreated. Diese Metadaten können mit der Methode getMetadata() aus einer Cloud Storage-Referenz abgerufen werden.

// 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'

Dateimetadaten aktualisieren

Sie können die Dateimetadaten jederzeit nach Abschluss des Datei-Uploads mit der Methode updateMetadata() aktualisieren. Weitere Informationen zu den Attributen, die aktualisiert werden können, finden Sie in der vollständigen Liste. Es werden nur die in den Metadaten angegebenen Attribute aktualisiert. Alle anderen bleiben unverändert.

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

Sie können beschreibbare Metadatenattribute löschen, indem Sie null übergeben:

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

Fehlerbehebung

Es gibt eine Reihe von Gründen, warum beim Abrufen oder Aktualisieren von Metadaten Fehler auftreten können. Dazu gehören beispielsweise, dass die Datei nicht vorhanden ist oder der Nutzer keine Berechtigung hat, auf die gewünschte Datei zuzugreifen. Weitere Informationen zu Fehlern finden Sie im Abschnitt Fehlerbehebung in der Dokumentation.

Benutzerdefinierte Metadaten

Sie können benutzerdefinierte Metadaten mit dem Parameter customMetadata des Konstruktors SettableMetadata angeben:

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

Sie können app-spezifische Daten für jede Datei in benutzerdefinierten Metadaten speichern. Wir empfehlen jedoch dringend, eine Datenbank (z. B. die Firebase Realtime Database) zu verwenden, um diese Art von Daten zu speichern und zu synchronisieren.

Attribute von Dateimetadaten

Unten finden Sie eine vollständige Liste der Metadatenattribute einer Datei:

Attribut Typ Festlegbar?
bucket String Nein
generation String Nein
metageneration String Nein
metadataGeneration String Nein
fullPath String Nein
name String Nein
size int Nein
timeCreated DateTime Nein
updated DateTime Nein
md5Hash String Nein
cacheControl String Ja
contentDisposition String Ja
contentEncoding String Ja
contentLanguage String Ja
contentType String Ja
customMetadata Map<String, String> Ja

Das Hochladen, Herunterladen und Aktualisieren von Dateien ist wichtig, aber auch das Entfernen von Dateien. Hier erfahren Sie, wie Sie Dateien aus Cloud Storage löschen.