Українська
Перевірка вхідних даних
Крок 1. Правила перевірки як класи
Навіщо. Кожну команду, що надходить від клієнта, треба перевірити раніше за все інше: ім’я користувача правильної довжини й із дозволених символів, електронна адреса, що схожа на адресу, тіло повідомлення не довше 4000 символів. Якщо писати ці перевірки як оператори if на початку кожного методу сервісу, вони змішуються з бізнес-логікою, і їх важко побачити в цілому.
FluentValidation описує правила однієї команди в одному невеликому класі:
cs
RuleFor(c => c.Email).NotEmpty().EmailAddress().MaximumLength(256);Правила читаються як специфікація, їх можна тестувати окремо, і вони повідомляють про всі порушені правила одразу, по полях – саме те, що потрібно формі реєстрації, щоб показати помилки поруч із полями.
Що зробити. Додайте пакет до Chatex.Core разом із Microsoft.Extensions.Configuration.Abstractions, який знадобиться AddCore наприкінці цієї теми:
powershell
dotnet add Source/Chatex.Core package FluentValidationpowershell
dotnet add Source/Chatex.Core package Microsoft.Extensions.Configuration.Abstractionsxml
<Project Sdk="Microsoft.NET.Sdk">
<ItemGroup>
<ProjectReference Include="..\Chatex.Data\Chatex.Data.csproj" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="FluentValidation" />
<PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" />
</ItemGroup>
</Project>Крок 2. Від результату перевірки до Error
Навіщо. FluentValidation повертає власний ValidationResult зі списком збоїв. Сервіси ж говорять мовою Result і Error, тому невеликий місток перетворює збої на одну помилку перевірки з подробицями за полями. Назви полів мають збігатися з тим, що бачить клієнт у JSON: властивість C# UserName у тілі запиту має вигляд userName.
Що зробити.
cs
using System.Text.RegularExpressions;
using FluentValidation;
namespace Chatex.Core.Common;
internal static class ValidationExtensions
{
/// <summary>Runs the validator; returns null when <paramref name="instance"/> is valid.</summary>
public static async Task<Error?> ValidateToErrorAsync<T>(
this IValidator<T> validator, T instance, CancellationToken cancellationToken)
{
var result = await validator.ValidateAsync(instance, cancellationToken);
if (result.IsValid)
{
return null;
}
return Error.Validation("validation_failed", "One or more fields are invalid.") with
{
Details = result.Errors
.GroupBy(e => CamelCase(e.PropertyName))
.ToDictionary(g => g.Key, g => g.Select(e => e.ErrorMessage).ToArray()),
};
}
/// <summary>Field names as clients see them in JSON: <c>UserName</c> becomes <c>userName</c>.</summary>
private static string CamelCase(string name) =>
name.Length == 0 ? name : char.ToLowerInvariant(name[0]) + name[1..];
/// <summary>
/// A Telegram-style handle: starts with a letter, then letters, digits or underscores. Null passes;
/// combine with NotEmpty when the handle is required.
/// </summary>
public static IRuleBuilderOptions<T, TProperty> Handle<T, TProperty>(
this IRuleBuilder<T, TProperty> rule, int minLength, int maxLength)
{
var pattern = new Regex($"^[A-Za-z][A-Za-z0-9_]{{{minLength - 1},{maxLength - 1}}}$", RegexOptions.CultureInvariant);
return rule
.Must(value => value is not string text || pattern.IsMatch(text))
.WithMessage($"Use {minLength}-{maxLength} letters, digits or underscores, starting with a letter.");
}
}ValidateToErrorAsync– метод розширення дляIValidator<T>. Він повертаєnull, якщо команда дійсна, тож сервіс може написати:csif (await validator.ValidateToErrorAsync(command, cancellationToken) is { } invalid) { return invalid; }Шаблон
is { } invalidозначає «не єnull, і назви цеinvalid».GroupBy+ToDictionaryзбирають усі повідомлення одного поля в масив:{ "password": ["...", "..."] }.with { Details = ... }створює копію запису помилки із заповненими подробицями – записи підтримують неруйнівну зміну.Handle– власне правило для@handlesкористувачів і чатів: спочатку літера, далі літери, цифри або підкреслення, із заданою довжиною. Воно розширюєIRuleBuilderіз FluentValidation, тож вишиковується в ланцюжок, як вбудоване правило:RuleFor(c => c.UserName).NotEmpty().Handle(3, 32).nullпроходить, тому те саме правило обслуговує й необов’язкові ідентифікатори (у приватного чату його немає).Регулярний вираз будується один раз на правило з
RegexOptions.CultureInvariant; подвоєні фігурні дужки всередині інтерпольованого рядка дають одинарні дужки квантифікатора,{2,31}дляHandle(3, 32).
Клас має модифікатор internal: ним користуються лише сервіси цього проєкту.
Крок 3. Помилки Identity
Навіщо. Деякі правила перевіряє ASP.NET Core Identity, а не наші перевіряльники: правила пароля (довжина, цифри), дозволені символи імені користувача, дубльоване ім’я користувача. Identity повідомляє про них списком IdentityError із кодами на кшталт PasswordTooShort або DuplicateUserName. Вони мають дійти до клієнта в тій самій формі, що й наші власні помилки перевірки.
Що зробити.
cs
using Microsoft.AspNetCore.Identity;
namespace Chatex.Core.Common;
internal static class IdentityErrors
{
/// <summary>Turns Identity's errors into one validation error, grouped under the field they concern.</summary>
public static Error ToValidationError(IEnumerable<IdentityError> errors)
{
var details = errors
.GroupBy(e => FieldOf(e.Code))
.ToDictionary(g => g.Key, g => g.Select(e => e.Description).ToArray());
return Error.Validation("validation_failed", "One or more fields are invalid.") with { Details = details };
}
private static string FieldOf(string code) => code switch
{
_ when code.StartsWith("Password", StringComparison.Ordinal) => "password",
_ when code.Contains("UserName", StringComparison.Ordinal) => "userName",
_ when code.Contains("Email", StringComparison.Ordinal) => "email",
_ => "",
};
}FieldOf вгадує поле за кодом помилки за допомогою виразу switch, гілки якого – самі лише умови (_ when ...): коди, що починаються з Password, належать до password, і так далі. Помилки, що не підходять до жодного поля, потрапляють під порожній ключ "" – загальноприйняте місце для помилок усього об’єкта.
using Microsoft.AspNetCore.Identity; працює без нового пакета: Chatex.Core посилається на Chatex.Data, який посилається на пакет Identity, а посилання на пакети передаються далі до проєктів, що посилаються на проєкт.
Перевірка
dotnet build проходить успішно без жодного попередження.