Как использовать метаданные файлов с Cloud Storage на платформах Apple

После загрузки файла в цифровой отпечаток Cloud Storage вы также можете получить и обновить метаданные файла, например чтобы обновить тип контента. В файлах также можно хранить пользовательские пары "ключ-значение" с дополнительными метаданными.

Получить метаданные файла

Метаданные файла содержат общие свойства, такие как name, size и contentType (часто называемые MIME-типом), а также некоторые менее распространенные, например contentDisposition и timeCreated. Эти метаданные можно получить из ссылки Cloud Storage с помощью метода metadataWithCompletion:.

Swift

// Create reference to the file whose metadata we want to retrieve
let forestRef = storageRef.child("images/forest.jpg")

// Get metadata properties
do {
  let metadata = try await forestRef.getMetadata()
} catch {
  // ...
}

Objective-C

// Create reference to the file whose metadata we want to retrieve
FIRStorageReference *forestRef = [storageRef child:@"images/forest.jpg"];

// Get metadata properties
[forestRef metadataWithCompletion:^(FIRStorageMetadata *metadata, NSError *error) {
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // Metadata now contains the metadata for 'images/forest.jpg'
  }
}];

Обновление метаданных файла

Вы можете обновить метаданные файла в любое время после завершения загрузки файла, используя метод updateMetadata:withCompletion:. Полный список свойств, которые можно обновить, приведен в этой статье. Обновляются только свойства, указанные в метаданных, а все остальные остаются без изменений.

Swift

// Create reference to the file whose metadata we want to change
let forestRef = storageRef.child("images/forest.jpg")

// Create file metadata to update
let newMetadata = StorageMetadata()
newMetadata.cacheControl = "public,max-age=300"
newMetadata.contentType = "image/jpeg"

// Update metadata properties
do {
  let updatedMetadata = try await forestRef.updateMetadata(newMetadata)
} catch {
  // ...
}

Objective-C

// Create reference to the file whose metadata we want to change
FIRStorageReference *forestRef = [storageRef child:@"images/forest.jpg"];

// Create file metadata to update
FIRStorageMetadata *newMetadata = [[FIRStorageMetadata alloc] init];
newMetadata.cacheControl = @"public,max-age=300";
newMetadata.contentType = @"image/jpeg";

// Update metadata properties
[forestRef updateMetadata:newMetadata completion:^(FIRStorageMetadata *metadata, NSError *error){
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // Updated metadata for 'images/forest.jpg' is returned
  }
}];

Вы можете удалить доступные для записи свойства метаданных, задав для них значение nil:

Objective-C

FIRStorageMetadata *newMetadata = [[FIRStorageMetadata alloc] init];
newMetadata.contentType = nil;

// Delete the metadata property
[forestRef updateMetadata:newMetadata completion:^(FIRStorageMetadata *metadata, NSError *error){
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // metadata.contentType should be nil
  }
}];

Swift

let newMetadata = StorageMetadata()
newMetadata.contentType = nil

do {
  // Delete the metadata property
  let updatedMetadata = try await forestRef.updateMetadata(newMetadata)
} catch {
  // ...
}

Обработка ошибок

При получении или обновлении метаданных могут возникать ошибки по разным причинам, например если файл не существует или у пользователя нет разрешения на доступ к нему. Дополнительную информацию об ошибках можно найти в разделе Обработка ошибок.

Пользовательские метаданные

Вы можете указать специальные метаданные в виде объекта NSDictionary, содержащего свойства NSString.

Swift

let metadata = [
  "customMetadata": [
    "location": "Yosemite, CA, USA",
    "activity": "Hiking"
  ]
]

Objective-C

NSDictionary *metadata = @{
  @"customMetadata": @{
    @"location": @"Yosemite, CA, USA",
    @"activity": @"Hiking"
  }
};

Вы можете хранить данные, относящиеся к приложению, для каждого файла в пользовательских метаданных, но мы настоятельно рекомендуем использовать базу данных (например, Firebase Realtime Database) для хранения и синхронизации данных этого типа.

Свойства метаданных файла

Ниже приведен полный список свойств метаданных файла.

Ресурс Тип Можно редактировать
bucket Строка Нет
generation Строка Нет
metageneration Строка Нет
fullPath Строка Нет
name Строка Нет
size Int64 Нет
timeCreated Дата Нет
updated Дата Нет
md5Hash Строка Да
cacheControl Строка Да
contentDisposition Строка Да
contentEncoding Строка Да
contentLanguage Строка Да
contentType Строка Да
customMetadata [String: String] Да

Загрузка, скачивание и обновление файлов важны, но также важна возможность их удаления. Давайте узнаем, как удалять файлы из Cloud Storage.