Menu
CoddyTech

Atrybuty walidacji

Część sekcji API REST ścieżki ASP.NET Core w Coddy. Lekcja 7 z 20.

Zapisywanie każdej reguły jako if sprawia, że kod staje się długi. Atrybuty walidacji umieszczają reguły na typie jako atrybuty z System.ComponentModel.DataAnnotations, a Validator sprawdza zgodność obiektu z tymi regułami.

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);

W rekordzie pozycyjnym property: umieszcza atrybut na właściwości — to właśnie jej szuka Validator. Bez validateAllProperties: true sprawdzany jest tylko atrybut [Required]. Każda niespełniona reguła dodaje obiekt ValidationResult zawierający nazwę właściwości i komunikat. .NET 10 ma też metodę builder.Services.AddValidation(), która sprawdza za Ciebie parametry punktu końcowego, ale w przypadku własnych typów wymaga generatora źródłowego. Ten runner nie uruchamia generatorów źródłowych, więc wywołujesz Validator samodzielnie.

challenge icon

Wyzwanie

Średni

Przenieś reguły dotyczące tytułu do TaskInput i dodaj nową: tytuł może mieć najwyżej 80 znaków.

  1. Masz nowy plik: Validation.cs. Jego metoda Errors przekształca wyniki w słownik, którego oczekuje Results.ValidationProblem. W miejscu komentarza wywołaj Validator.TryValidateObject dla model, przekazując nowy ValidationContext(model), results i validateAllProperties: true.
  2. Na początku Program.cs dodaj using System.ComponentModel.DataAnnotations; i przypisz do Title w TaskInput dwa atrybuty: [property: Required(ErrorMessage = "Title is required."), StringLength(80)].
  3. W POST i PUT zastąp sprawdzenie IsNullOrWhiteSpace kodem var errors = Validation.Errors(input); i zwracaj Results.ValidationProblem(errors), gdy wartość nie jest null.

Tytuł o długości 81 znaków zwraca teraz kod 400 z odpowiedzią:

"errors": { "title": ["The field Title must be a string with a maximum length of 80."] }

Wypróbuj: naciśnij „Uruchom” i wyślij żądanie POST z treścią, w której tytuł ma 81 liter, do /api/tasks: otrzymasz kod 400 i powyższy błąd. Wyślij żądanie POST z treścią { "title": "" }: otrzymasz kod 400 z komunikatem Title is required., tak jak wcześniej. Wyślij żądanie POST z treścią { "title": "Order new chairs" }: otrzymasz kod 201.

Spróbuj swoich sił

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);

Wszystkie lekcje w sekcji API REST