Управление свойствами и метаданными BLOB-объектов с помощью Go

Кроме данных, которые они содержат, BLOB-объекты поддерживают свойства системы и определяемые пользователем метаданные. В этой статье показано, как управлять свойствами системы и пользовательскими метаданными с помощью клиентского модуля служба хранилища Azure для Go.

Необходимые компоненты

• Подписка Azure — создайте бесплатную учетную запись.
• Учетная запись хранения Azure — создайте такую учетную запись.
• Go 1.18+

Настройка среды

Если у вас нет существующего проекта, в этом разделе показано, как настроить проект для работы с клиентским модулем Хранилище BLOB-объектов Azure для Go. Ниже приведены действия по установке модуля, добавлению import путей и созданию авторизованного клиентского объекта. Дополнительные сведения см. в статье Начало работы с хранилищем BLOB-объектов Azure и Go.

Установка модулей

Установите модуль azblob с помощью следующей команды:

go get github.com/Azure/azure-sdk-for-go/sdk/storage/azblob

Чтобы выполнить проверку подлинности с помощью идентификатора Microsoft Entra (рекомендуется), установите azidentity модуль с помощью следующей команды:

go get github.com/Azure/azure-sdk-for-go/sdk/azidentity

Добавление путей импорта

В файле кода добавьте следующие пути импорта:

import (
    "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/storage/azblob"
)

Эти пути импорта представляют минимальные необходимые для начала работы. В некоторых примерах кода в этой статье могут потребоваться дополнительные пути импорта. Дополнительные сведения и примеры использования см. в примерах кода.

Создание клиентского объекта

Чтобы подключить приложение к хранилищу BLOB-объектов, создайте клиентский объект с помощью azblob. NewClient. В следующем примере показано, как создать клиентский объект с помощью DefaultAzureCredential авторизации:

func getServiceClientTokenCredential(accountURL string) *azblob.Client {
    // Create a new service client with token credential
    credential, err := azidentity.NewDefaultAzureCredential(nil)
    handleError(err)

    client, err := azblob.NewClient(accountURL, credential, nil)
    handleError(err)

    return client
}

Авторизация

Механизм авторизации должен иметь необходимые разрешения для работы со свойствами контейнера или метаданными. Для авторизации через Microsoft Entra ID (рекомендуется) для операций получения необходима встроенная роль Azure RBAC Читатель данных BLOB-объектов Хранилища или выше, а для операций установки необходима роль Сотрудник данных BLOB-объектов Хранилища или выше. Дополнительные сведения см. в руководстве по авторизации для задания свойств BLOB-объектов (REST API), получения свойств BLOB-объектов (REST API), задания метаданных BLOB-объектов (REST API) или получения метаданных BLOB-объектов (REST API).

Сведения о свойствах и метаданных

• Свойства системы: свойства системы есть у каждого ресурса хранилища BLOB-объектов. Некоторые из них можно прочитать или задать, а некоторые — только прочитать. На самом деле, некоторые свойства системы соответствуют определенным стандартным заголовкам HTTP. Клиентская библиотека служба хранилища Azure для Go поддерживает эти свойства.

• Определяемые пользователем метаданные: такие метаданные состоят из одной или нескольких пар "имя-значение", которые можно указать для ресурса хранилища BLOB-объектов. Вы можете использовать метаданные для хранения дополнительных значений вместе с ресурсом. Значения метаданных предназначены только для ваших собственных целей и не влияют на поведение ресурса.

  Пары имен и значений метаданных являются допустимыми HTTP-заголовками, поэтому они должны соответствовать всем ограничениям для HTTP-заголовков. Дополнительные сведения о требованиях к именованию метаданных см. в разделе "Имена метаданных".

Установка и получение свойств

Чтобы задать свойства блоба, вызовите следующий метод из клиентского объекта блоба:

• SetHTTPHeaders

Все свойства, не заданные явно, очищаются. Чтобы сохранить существующие свойства, вы можете сначала получить свойства блоба, а затем использовать их для заполнения заголовков, которые не подлежат обновлению.

В следующем примере кода задаются системные свойства BlobContentType и BlobContentLanguage для объекта Blob, при этом сохраняются существующие свойства.

func setBlobProperties(client *azblob.Client, containerName string, blobName string) {
    // Reference the blob as a client object
    blobClient := client.ServiceClient().NewContainerClient(containerName).NewBlobClient(blobName)

    // Get the existing blob properties
    resp, err := blobClient.GetProperties(context.TODO(), nil)
    handleError(err)

    // Set the new blob properties and include existing properties
    _, err = blobClient.SetHTTPHeaders(context.TODO(), blob.HTTPHeaders{
        BlobContentType:        to.Ptr("text/plain"),
        BlobContentLanguage:    to.Ptr("en-us"),
        BlobContentEncoding:    resp.ContentEncoding,
        BlobContentDisposition: resp.ContentDisposition,
        BlobCacheControl:       resp.CacheControl,
    }, nil)
    handleError(err)
}

Чтобы получить свойства объекта Blob, вызовите следующий метод из клиентского объекта Blob:

• GetProperties

Следующий пример кода получает системные свойства блоба и отображает некоторые значения:

func getBlobProperties(client *azblob.Client, containerName string, blobName string) {
    // Reference the blob as a client object
    blobClient := client.ServiceClient().NewContainerClient(containerName).NewBlobClient(blobName)

    // Get the blob properties
    resp, err := blobClient.GetProperties(context.TODO(), nil)
    handleError(err)

    // Print the blob properties
    fmt.Printf("Content type: %v\n", *resp.ContentType)
    fmt.Printf("Content language: %v\n", *resp.ContentLanguage)
}

Настройка и извлечение метаданных

Метаданные можно указать как одну или несколько пар "имя-значение" для ресурса BLOB или ресурса контейнера. Чтобы задать метаданные, отправьте карту, содержащую пары "имя-значение", используя следующий метод из клиентского объекта БОЛЬШОго двоичного объекта:

• SetMetadata

В следующем примере кода задаются метаданные объекта BLOB.

func setBlobMetadata(client *azblob.Client, containerName string, blobName string) {
    // Reference the blob as a client object
    blobClient := client.ServiceClient().NewContainerClient(containerName).NewBlobClient(blobName)

    // Set the blob metadata
    var metadata = make(map[string]*string)
    metadata["key1"] = to.Ptr("value1")
    metadata["key2"] = to.Ptr("value2")

    _, err := blobClient.SetMetadata(context.TODO(), metadata, nil)
    handleError(err)
}

Чтобы получить метаданные, вызовите метод GetProperties из клиентского объекта blob и получите доступ к Metadata полю в ответе. Метод GetProperties извлекает свойства и метаданные большого двоичного объекта, вызывая операцию Get Blob Properties и операцию Get Blob Metadata.

В следующем примере кода считываются метаданные объекта BLOB и выводится каждая пара ключ/значение.

func getBlobMetadata(client *azblob.Client, containerName string, blobName string) {
    // Reference the blob as a client object
    blobClient := client.ServiceClient().NewContainerClient(containerName).NewBlobClient(blobName)

    // Get the blob properties, which includes metadata
    resp, err := blobClient.GetProperties(context.TODO(), nil)
    handleError(err)

    // Print the blob metadata
    for k, v := range resp.Metadata {
        fmt.Printf("%v: %v\n", k, *v)
    }
}

Ресурсы

Дополнительные сведения об управлении свойствами системы и пользовательскими метаданными с помощью клиентского модуля Хранилище BLOB-объектов Azure для Go см. в следующих ресурсах.

Примеры кода

• Просмотр примеров кода из этой статьи (GitHub)

Операции REST API

Пакет SDK Azure для Go содержит библиотеки, которые создаются на основе REST API Azure, что позволяет взаимодействовать с операциями REST API через знакомые парадигмы Go. Методы клиентской библиотеки для управления системными свойствами и пользовательскими метаданными используют следующие операции REST API:

• Установка свойств Blob (REST API)
• Получение свойств BLOB-объектов (REST API)
• Настройка метаданных BLOB-объектов (REST API)
• Получение метаданных BLOB-объектов (REST API)

Ресурсы модуля клиента

• Справочная документация по модулю клиента
• Исходный код клиентского модуля
• Пакет (pkg.go.dev)

Связанный контент

• Эта статья является частью руководства разработчика Blob Storage для Go. Дополнительные сведения см. в полном списке статей руководства разработчика по созданию приложения Go.