Używanie metadanych pliku w Cloud Storage w internecie

Po przesłaniu pliku do Cloud Storage możesz również uzyskać lub zaktualizować metadane pliku, na przykład aby zmienić typ treści. Pliki mogą też przechowywać niestandardowe pary klucz-wartość z dodatkowymi metadanymi pliku.

Pobieranie metadanych

Metadane pliku zawierają typowe właściwości, takie jak name, size, contentType (często nazywany typem MIME), a także najpopularniejsze, takie jak contentDisposition i timeCreated. Te metadane można pobrać z pliku referencyjnego Cloud Storage za pomocą metody getMetadata(). getMetadata() zwraca wartość Promise zawierającą pełne metadane lub błąd w przypadku odrzucenia przez element Promise.

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

Aktualizowanie metadanych pliku

Po zakończeniu przesyłania pliku możesz zaktualizować jego metadane w dowolnym momencie, używając metody updateMetadata(). Zapoznaj się z pełna lista. można zaktualizować. Aktualizowane są tylko właściwości określone w metadanych, wszystkie pozostałe pozostaną niezmienione. updateMetadata() zwraca Promise zawierający pełne metadane lub błąd w przypadku odrzucenia ze względu na Promise.

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

Możesz usunąć właściwość metadanych, ustawiając ją na null:

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

Obsługa błędów

Błędy podczas pobierania lub aktualizowania metadanych mogą wystąpić z różnych powodów, na przykład z powodu braku pliku lub braku uprawnień użytkownika do wybranego pliku. Więcej informacji o błędach znajdziesz w sekcji Przetwarzanie błędów w dokumentacji.

Niestandardowe metadane

Niestandardowe metadane możesz określić jako obiekt zawierający właściwości String.

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

Możesz użyć niestandardowych metadanych do przechowywania dodatkowych danych dotyczących poszczególnych aplikacji ale zalecamy korzystanie z bazy danych (takiej jak Firebase Realtime Database) do przechowywania i synchronizowania tego typu danych.

Właściwości metadanych pliku

Pełna lista właściwości metadanych pliku jest dostępna poniżej:

Właściwość Typ Z możliwością zapisu
bucket ciąg znaków NIE
generation ciąg znaków NIE
metageneration ciąg znaków NIE
fullPath ciąg znaków NIE
name ciąg znaków NIE
size liczba NIE
timeCreated ciąg znaków NIE
updated ciąg znaków NIE
md5Hash ciąg znaków TAK przy przesyłaniu, NIE w aktualizacji metadanych
cacheControl ciąg znaków TAK
contentDisposition ciąg znaków TAK
contentEncoding ciąg znaków TAK
contentLanguage ciąg znaków TAK
contentType ciąg znaków TAK
customMetadata Obiekt zawierający mapowania ciągu znaków TAK

Przesyłanie, pobieranie i aktualizowanie plików jest ważne, ale równie ważne jest ich usuwanie. Zobaczmy, jak usuwanie plików od Cloud Storage.