Атрибуты валидации
Часть раздела REST API путешествия по ASP.NET Core на Coddy. Урок 7 из 20.
Записывать каждое правило в виде if — долго. Аннотации данных задают правила для типа в виде атрибутов из System.ComponentModel.DataAnnotations, а Validator проверяет объект на соответствие этим правилам.
record SignupInput(
[property: Required, EmailAddress] string Email,
[property: Range(13, 120)] int Age);
var results = new List<ValidationResult>();
Validator.TryValidateObject(input, new ValidationContext(input), results,
validateAllProperties: true);В позиционной записи property: помещает атрибут в свойство — именно там его ищет Validator. Без validateAllProperties: true он проверяет только [Required]. Каждое нарушенное правило добавляет ValidationResult с именем свойства и сообщением. В .NET 10 также есть builder.Services.AddValidation(), который проверяет параметры конечной точки за вас, но для собственных типов ему нужен генератор исходного кода. Здесь среда выполнения не запускает генераторы исходного кода, поэтому вызывайте Validator самостоятельно.
Задание
СреднеПеренеси правила для названия в TaskInput и добавь новое: длина названия не должна превышать 80 символов.
- Добавлен новый файл
Validation.cs. Его методErrorsпреобразует результаты в словарь, который принимаетResults.ValidationProblem. Там, где указано в комментарии, вызовиValidator.TryValidateObjectдляmodel, передав новыйValidationContext(model),resultsиvalidateAllProperties: true. - В начале
Program.csдобавьusing System.ComponentModel.DataAnnotations;и добавь кTitleвTaskInputдва атрибута:[property: Required(ErrorMessage = "Title is required."), StringLength(80)]. - В POST и PUT замени проверку
IsNullOrWhiteSpaceнаvar errors = Validation.Errors(input);и возвращайResults.ValidationProblem(errors), если значение не равноnull.
Теперь для названия длиной 81 символ возвращается код 400 с таким ответом:
"errors": { "title": ["The field Title must be a string with a maximum length of 80."] }Попробуй: нажми «Запустить» и отправь POST-запрос с телом, в котором название состоит из 81 буквы, на адрес /api/tasks: получи код 400 и указанную выше ошибку. Отправь POST-запрос с телом { "title": "" }: получи код 400 с сообщением Title is required., как и раньше. Отправь POST-запрос с телом { "title": "Order new chairs" }: получи код 201.
Попробуйте сами
var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();
var tasks = new List<TaskItem>
{
new(1, "Write the project brief", false),
new(2, "Book the meeting room", true),
new(3, "Send the invoice", false),
};
var nextId = 4;
app.MapGet("/api/tasks", () => tasks);
app.MapGet("/api/tasks/{id:int}", (int id) =>
{
var task = tasks.Find(t => t.Id == id);
return task is null ? Results.NotFound() : Results.Ok(task);
});
app.MapPost("/api/tasks", (TaskInput input) =>
{
if (string.IsNullOrWhiteSpace(input.Title))
{
return Results.ValidationProblem(new Dictionary<string, string[]>
{
["title"] = ["Title is required."],
});
}
var task = new TaskItem(nextId++, input.Title, input.Done);
tasks.Add(task);
return Results.Created($"/api/tasks/{task.Id}", task);
});
app.MapPut("/api/tasks/{id:int}", (int id, TaskInput input) =>
{
if (string.IsNullOrWhiteSpace(input.Title))
{
return Results.ValidationProblem(new Dictionary<string, string[]>
{
["title"] = ["Title is required."],
});
}
var index = tasks.FindIndex(t => t.Id == id);
if (index == -1) return Results.NotFound();
tasks[index] = new TaskItem(id, input.Title, input.Done);
return Results.Ok(tasks[index]);
});
app.MapPatch("/api/tasks/{id:int}", (int id, TaskPatch patch) =>
{
var index = tasks.FindIndex(t => t.Id == id);
if (index == -1) return Results.NotFound();
var task = tasks[index];
tasks[index] = task with
{
Title = patch.Title ?? task.Title,
Done = patch.Done ?? task.Done,
};
return Results.Ok(tasks[index]);
});
app.MapDelete("/api/tasks/{id:int}", (int id) =>
{
var removed = tasks.RemoveAll(t => t.Id == id);
return removed == 0 ? Results.NotFound() : Results.NoContent();
});
app.Run();
record TaskItem(int Id, string Title, bool Done);
record TaskInput(string Title, bool Done);
record TaskPatch(string? Title, bool? Done);