Reo.Core.FileStorage 10.0.20

Reo.Core.FileStorage

Описание пакета

Пакет Reo.Core.FileStorage предоставляет инструменты для управления конфигурацией файлового хранения (ФХ), включая проверку существования необходимых файловых групп и разрешений, их создание при необходимости, а также валидацию настроек. Он решает проблему обеспечения согласованности и корректности настроек ФХ в различных средах (например, разработка, тестирование, продакшн), автоматизируя процессы проверки и настройки.

Основные компоненты

• IFileStorageAdminClientV1: Интерфейс для взаимодействия с административным API ФХ. Предоставляет методы для получения и создания файловых групп, разрешений и других ресурсов.
• ShareNameCheckService: Фоновый сервис, который проверяет наличие необходимых файловых групп и разрешений в ФХ. Если они отсутствуют, сервис автоматически создаёт их.
• FileStorageOptionsValidator: Валидатор для проверки корректности настроек ФХ (например, URL, логины и пароли администратора).
• DTO-модели (FileGroupDto, FilePermissionDto и др.): Классы для передачи данных между клиентом и сервером ФХ.
• FileStorageShareNameException: Исключение, которое выбрасывается при попытке использовать недопустимое имя папки в ФХ (например, содержащее символ /).

Требования

• .NET: Совместим с .NET Core 3.1, .NET 5, .NET 6, .NET 7.
• Зависимости:
  • FluentValidation (для валидации настроек).
  • Reo.Core.Extensions (для расширений строк и коллекций).

Установка

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

NuGet Package Manager:

Install-Package Reo.Core.FileStorage

.NET CLI:

dotnet add package Reo.Core.FileStorage

Настройка

Регистрация в DI-контейнере (ASP.NET Core)

Добавьте сервисы в Startup.cs или Program.cs:

services.AddFileStorage(options =>
{
 options.Endpoint = "https://filestorage.example.com";
 options.AdminUserName = "admin";
 options.AdminUserPassword = "securepassword";
 options.UserName = "user";
 options.UserPassword = "userpassword";
});

Конфигурационные параметры

Настройки можно указать в appsettings.json:

"FileStorageOptions": {
 "Endpoint": "https://filestorage.example.com",
 "AdminUserName": "admin",
 "AdminUserPassword": "securepassword",
 "UserName": "user",
 "UserPassword": "userpassword"
}

Использование

Пример 1: Проверка и создание файловых групп

// Регистрация сервиса в DI
services.AddSingleton<ShareNameCheckService>();

// В фоновом процессе (например, в ASP.NET Core)
var shareNameCheckService = serviceProvider.GetRequiredService<ShareNameCheckService>();
await shareNameCheckService.ExecuteAsync(CancellationToken.None);

Пример 2: Валидация настроек

var validator = new FileStorageOptionsValidator();
var options = new FileStorageOptions
{
 Endpoint = "",
 AdminUserName = "admin",
 AdminUserPassword = "securepassword",
 UserName = "user",
 UserPassword = "userpassword"
};

var result = validator.Validate(options);
if (!result.IsValid)
{
 foreach (var error in result.Errors)
 {
 Console.WriteLine($"Ошибка: {error.ErrorMessage}");
 }
}

Пример 3: Использование IFileStorageAdminClientV1

var client = serviceProvider.GetRequiredService<IFileStorageAdminClientV1>();
var fileGroupRequest = new FileGroupDto
{
 GroupName = "Reports",
 FilePermissionIds = new List<Guid> { Guid.NewGuid() }
};

await client.CreateFileGroupAsync(fileGroupRequest, CancellationToken.None);

Лицензия

Данный пакет распространяется под лицензией MIT.