Verwenden Sie Dateimetadaten mit Cloud Storage auf Flutter

Nach dem Hochladen einer Datei in die Cloud Storage-Referenz können Sie auch die Dateimetadaten abrufen und aktualisieren, um beispielsweise den Inhaltstyp anzuzeigen oder 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.

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

// 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 Metadateneigenschaften löschen, indem Sie null übergeben:

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

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 mit dem customMetadata Parameter des SettableMetadata Konstruktors 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, aber wir empfehlen dringend, eine Datenbank (z. B. die Firebase Realtime Database ) zu verwenden, um diese Art von Daten zu speichern und zu synchronisieren.

Datei-Metadaten-Eigenschaften

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

Eigentum	Typ	Einstellbar?
`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 die Möglichkeit, sie zu entfernen. Lassen Sie uns lernen, wie Sie Dateien aus Cloud Storage löschen .