Проверка параметров и именованные параметры
Проверяйте параметры при запуске с помощью DataAnnotations или FluentValidation и используйте именованные параметры для нескольких экземпляров.
«Проверка параметров и именованные параметры» — бесплатный урок C# Academy на CoddyKit. Это урок 3 из 4. Ты можешь прочитать весь урок бесплатно ниже — а потом практиковать его прямо в браузере с встроенным редактором кода и ИИ-репетитором 24/7. Это часть пути обучения C# Academy, и твой прогресс синхронизируется между веб-версией и приложением CoddyKit. Курс C# Academy содержит 4 уроков всего.
Зачем проверять параметры?
Отсутствующая или некорректная конфигурация вызывает ошибки во время выполнения, которые трудно отследить. Проверка параметров при запуске превращает скрытые ошибки конфигурации в явные, понятные исключения ещё до обработки первого запроса.
ValidateOnStart
ValidateOnStart() запускает проверку сразу при запуске приложения, а не откладывает её до первого использования. Поэтому приложение с неправильной конфигурацией завершается с ошибкой сразу, а не через несколько часов.
builder.Services
.AddOptions<DatabaseOptions>()
.BindConfiguration("Database")
.ValidateDataAnnotations()
.ValidateOnStart(); // throw OptionsValidationException on startup
// Without ValidateOnStart:
// - Validation only runs on first IOptions<T>.Value access
// - A rarely-used service could run for hours before failing
// With ValidateOnStart:
// - App fails at Host.Run() if config is invalid
// - Health checks and probes never report healthy for bad configПроверка с помощью DataAnnotations
Используйте стандартные атрибуты System.ComponentModel.DataAnnotations в классе параметров. Они автоматически обрабатываются методом ValidateDataAnnotations().
using System.ComponentModel.DataAnnotations;
public class EmailOptions
{
[Required(ErrorMessage = "SMTP host is required")]
[MinLength(3)]
public string SmtpHost { get; set; } = string.Empty;
[Range(1, 65535, ErrorMessage = "Port must be 1-65535")]
public int SmtpPort { get; set; } = 587;
[Required]
[EmailAddress(ErrorMessage = "Invalid sender address")]
public string SenderAddress { get; set; } = string.Empty;
[Range(1, 30)]
public int TimeoutSeconds { get; set; } = 10;
}
builder.Services
.AddOptions<EmailOptions>()
.BindConfiguration("Email")
.ValidateDataAnnotations()
.ValidateOnStart();Пользовательский делегат проверки
Перегрузка Validate(Func<T, bool>, string) добавляет лямбда-выражение для правил, которые нельзя выразить атрибутами, например ограничений между свойствами.
builder.Services
.AddOptions<ConnectionPoolOptions>()
.BindConfiguration("ConnectionPool")
.ValidateDataAnnotations()
.Validate(
opts => opts.MaxSize >= opts.MinSize,
"MaxSize must be greater than or equal to MinSize")
.Validate(
opts => opts.ConnectionTimeoutMs > 0,
"ConnectionTimeoutMs must be positive")
.ValidateOnStart();
public class ConnectionPoolOptions
{
[Range(1, 100)] public int MinSize { get; set; } = 2;
[Range(1, 500)] public int MaxSize { get; set; } = 20;
public int ConnectionTimeoutMs { get; set; } = 5000;
}IValidateOptions для сложных правил
Для сложной логики с несколькими сообщениями об ошибках реализуйте IValidateOptions<T>. Он получает экземпляр параметров и возвращает результат с подробными сообщениями о сбоях.
public class PaymentOptionsValidator : IValidateOptions<PaymentOptions>
{
public ValidateOptionsResult Validate(string? name, PaymentOptions opts)
{
var failures = new List<string>();
if (opts.Provider == "Stripe" && string.IsNullOrWhiteSpace(opts.StripeSecretKey))
failures.Add("StripeSecretKey is required when Provider is Stripe");
if (opts.Provider == "PayPal" && string.IsNullOrWhiteSpace(opts.PayPalClientId))
failures.Add("PayPalClientId is required when Provider is PayPal");
if (opts.RetryCount < 0 || opts.RetryCount > 5)
failures.Add("RetryCount must be between 0 and 5");
return failures.Count == 0
? ValidateOptionsResult.Success
: ValidateOptionsResult.Fail(failures);
}
}
builder.Services.AddSingleton<IValidateOptions<PaymentOptions>, PaymentOptionsValidator>();Именованные параметры — понятие
Именованные параметры позволяют зарегистрировать несколько конфигураций одного типа параметров. Распространённый сценарий: несколько исходящих клиентов HTTP, каждый со своим базовым URL-адресом и временем ожидания.
// appsettings.json:
{
"HttpClients": {
"Orders": {
"BaseUrl": "https://orders-service",
"TimeoutSeconds": 30
},
"Inventory": {
"BaseUrl": "https://inventory-service",
"TimeoutSeconds": 10
}
}
}
public class HttpClientOptions
{
public string BaseUrl { get; set; } = string.Empty;
public int TimeoutSeconds { get; set; } = 30;
}Регистрация именованных параметров
Передайте строку имени первым аргументом в Configure<T>. Используйте IOptionsMonitor<T>.Get(name), чтобы получить конкретный экземпляр.
// Register:
builder.Services.Configure<HttpClientOptions>("Orders",
builder.Configuration.GetSection("HttpClients:Orders"));
builder.Services.Configure<HttpClientOptions>("Inventory",
builder.Configuration.GetSection("HttpClients:Inventory"));
// Consume:
public class ApiGateway
{
private readonly HttpClientOptions _orders;
private readonly HttpClientOptions _inventory;
public ApiGateway(IOptionsMonitor<HttpClientOptions> monitor)
{
_orders = monitor.Get("Orders");
_inventory = monitor.Get("Inventory");
}
// IOptions<T>.Value always returns the unnamed (default) instance
// IOptionsMonitor<T>.Get(name) returns the named instance
}Именованные параметры с проверкой
Проверяйте именованные параметры по отдельности, вызывая AddOptions<T>(name) для каждой именованной регистрации.
foreach (var clientName in new[] { "Orders", "Inventory", "Auth" })
{
builder.Services
.AddOptions<HttpClientOptions>(clientName)
.BindConfiguration($"HttpClients:{clientName}")
.ValidateDataAnnotations()
.Validate(
opts => Uri.IsWellFormedUriString(opts.BaseUrl, UriKind.Absolute),
$"HttpClients:{clientName}:BaseUrl must be a valid absolute URI")
.ValidateOnStart();
}
// If any named instance fails, the app refuses to startAPI OptionsBuilder
OptionsBuilder<T> (возвращаемый методом AddOptions<T>()) — это плавный API, который аккуратно объединяет все шаги регистрации, связывания и проверки.
// Full OptionsBuilder chain:
builder.Services
.AddOptions<DatabaseOptions>() // create builder
.BindConfiguration("Database") // bind JSON section
.Configure(opts => // manual override
{
if (builder.Environment.IsDevelopment())
opts.EnableDetailedErrors = true;
})
.PostConfigure(opts => // runs after all Configure
{
opts.ConnectionString ??= "default-fallback";
})
.ValidateDataAnnotations() // attribute rules
.Validate(o => o.MaxPoolSize > 0,
"MaxPoolSize must be positive")
.ValidateOnStart(); // eager validationПрактический пример: параметры политики повторных попыток
Полная настройка параметров повторных попыток с проверкой зависимостей между полями и именованными политиками для разных служб.
public class RetryOptions
{
[Range(0, 10)] public int MaxAttempts { get; set; } = 3;
[Range(100, 60000)] public int BaseDelayMs { get; set; } = 500;
public bool UseExponentialBackoff { get; set; } = true;
[Range(1, 120000)] public int MaxDelayMs { get; set; } = 30000;
}
foreach (var policy in new[] { "Database", "HttpClient", "MessageBus" })
{
builder.Services
.AddOptions<RetryOptions>(policy)
.BindConfiguration($"RetryPolicies:{policy}")
.Validate(o => !o.UseExponentialBackoff || o.MaxDelayMs > o.BaseDelayMs,
"MaxDelayMs must exceed BaseDelayMs when using exponential backoff")
.ValidateOnStart();
}Быстрая проверка
Какое преимущество даёт вызов ValidateOnStart() при регистрации параметров?
Итоги: проверка параметров и именованные параметры
Основные выводы:
ValidateOnStart(): ошибка обнаруживается при запуске, а не при первом использовании- DataAnnotations:
[Required],[Range]и другие атрибуты +ValidateDataAnnotations() Validate(Func, message): встроенное лямбда-выражение для правил между свойствамиIValidateOptions<T>: полная программная проверка с несколькими ошибками- Именованные параметры:
Configure<T>(name, ...)+IOptionsMonitor<T>.Get(name) OptionsBuilder<T>: плавный API для объединения всех шагов регистрации
Часто задаваемые вопросы
Урок «Проверка параметров и именованные параметры» бесплатный?
Да — полный текст урока «Проверка параметров и именованные параметры» бесплатно доступен здесь в веб-версии. Чтобы практиковать его интерактивно (встроенный редактор кода и ИИ-репетитор 24/7) и разблокировать остальной курс C# Academy, подпишись на CoddyKit PRO. Курс C# Academy содержит 4 уроков всего.
Чему я научусь в уроке «Проверка параметров и именованные параметры»?
Проверяйте параметры при запуске с помощью DataAnnotations или FluentValidation и используйте именованные параметры для нескольких экземпляров. Ты практикуешь C# Academy с помощью реального кода, который запускаешь прямо в браузере, и ИИ-репетитор 24/7 отвечает на твои вопросы во время урока.
Нужен ли мне опыт, чтобы начать C# Academy?
Предыдущий опыт не требуется. C# Academy на CoddyKit структурирован для всех уровней — от новичков до продвинутых, поэтому ты можешь начать отсюда или с самого начала и учиться в своем темпе. Это урок 3 из 4.
Сколько времени занимает урок «Проверка параметров и именованные параметры»?
Большинство уроков CoddyKit занимают около 5–10 минут. Каждый из них компактный и интерактивный, поэтому ты постоянно делаешь прогресс и продолжаешь с того же места в веб-версии и приложении.
Можно ли писать и запускать код в этом уроке C# Academy?
Да. Каждый урок C# Academy включает встроенный редактор кода, поэтому ты пишешь и запускаешь реальный код прямо в браузере и получаешь моментальную обратную связь от AI — локальная установка не требуется.
Все уроки этого курса
- Источники и поставщики конфигурации
- Строго типизированные параметры с IOptions
- Проверка параметров и именованные параметры
- Управление секретами