Expero.Libraries.CSharp.ObjectStorage.S3

Пакет для работы c S3-like ObjectStorage.

Пакет содержит:

• Сервис для работы c S3-like ObjectStorage
• Фабрику для получения именованного экземпляра сервиса с разными параметрами
• Health метрика для работы c S3-like ObjectStorage

Работа с IObjectStorageS3Service

Пример подключения:

services.AddMdsObjectStorageS3Service(s =>
{
    var options = //...

    s.Host = options.Host; // Хост для подключеня
    s.Ssl = options.Ssl; // Используем ли мы SSL для работы
    s.AccessKey = options.AccessKey; // AccessKey для подключеня
    s.SecretKey = options.SecretKey; // SecretKey для подключеня
    s.DefaultBucket = options.DefaultBucket; // Какой бакет будет использоваться для проверки подключения и для загрузки файлов по умолчанию 
});

Рекоменудуем подключать на уровне Core.Tools, и там же положить фабрику для имен бакетов, если планируется использовать несколько бакетов для работы.

Например, вот так:

public static class ObjectStorageBuckets
{
    // NB: Имена необходимо указывать в lowercase
    public static ObjectStorageS3BucketName Default { get; } = new("default");

    public static ObjectStorageS3BucketName Feeds { get; } = new("feeds");
}

Работа с IObjectStorageS3Factory

В пакете есть возможность подключения именованного сервиса и получения экземпляра через фабрику IObjectStorageS3Factory. Фабрика доступна через DI, при регистрации сервиса с указанием имени (AddMdsObjectStorageS3Service("Name", ...).

Пример:

services.AddMdsObjectStorageS3Service("Name", s =>
{
    var options = //...

    s.Host = options.Host; // Хост для подключеня
    s.Ssl = options.Ssl; // Используем ли мы SSL для работы
    s.AccessKey = options.AccessKey; // AccessKey для подключеня
    s.SecretKey = options.SecretKey; // SecretKey для подключеня
    s.DefaultBucket = options.DefaultBucket; // Какой бакет будет использоваться для проверки подключения и для загрузки файлов по умолчанию 
});

internal class Uploader : IUploader
{
    private readonly IObjectStorageS3Service _objectStorage;

    public LoggingUploader(IObjectStorageS3Factory factory)
    {
        _objectStorage = factory.Create("Name");
    }

    /*...*/
}

N.B. Для получения экземплра сервиса IObjectStorageS3Service через DI обязательно нужно зарегиститровать сервис, используя AddMdsObjectStorageS3Service без указания имени.

Директории

При сохранении файлов в бакет, библиотека позволяет прописать директорию внутри бакета, если директория не существует, то она будет создана.

Например, если нам нужно сохранить какой-либо контент в бакет по директории dir/sub_dir/sub_sub_dir/, то код будет выглядеть так:

// Для сохранения можно использовать следующий метод из IObjectStorageS3Service
Task<FileUploadResult> IObjectStorageS3Service.UploadAsync(byte[] content, UploadParameters parameters);

Пример использования:

IObjectStorageS3Service _objectStorage; // получаем через DI

var parameters = new UploadParameters
{
    Bucket = new ObjectStorageS3BucketName("my-test-bucket"),
    Directory = "dir/sub_dir/sub_sub_dir/",
    FileName = "may-test-image.png"
};

var result = await _objectStorage.UploadAsync(content, parameters);