Atribut Validasi
Termasuk bagian REST API dalam perjalanan ASP.NET Core di Coddy. Pelajaran 7 dari 20.
Menuliskan setiap aturan sebagai if akan membuat kode menjadi panjang. Anotasi data menempatkan aturan pada tipe sebagai atribut, dari System.ComponentModel.DataAnnotations, dan Validator memeriksa sebuah object berdasarkan aturan tersebut.
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);Dalam record posisional, property: menempatkan atribut pada property, yaitu tempat Validator mencarinya. Tanpa validateAllProperties: true, pemeriksaan hanya dilakukan pada [Required]. Setiap aturan yang dilanggar menambahkan ValidationResult yang berisi nama property dan pesan. .NET 10 juga menyediakan builder.Services.AddValidation(), yang memeriksa parameter endpoint untukmu, tetapi untuk tipe buatanmu sendiri, fitur ini memerlukan generator sumber. Runner di sini tidak menjalankan generator sumber, jadi kamu perlu memanggil Validator sendiri.
Tantangan
SedangPindahkan aturan judul ke TaskInput, lalu tambahkan aturan baru: judul memiliki paling banyak 80 karakter.
- Kamu mendapat file baru,
Validation.cs. MethodErrors-nya mengubah hasil menjadi dictionary yang diperlukan olehResults.ValidationProblem. Di tempat yang ditunjukkan oleh komentar, panggilValidator.TryValidateObjectpadamodeldenganValidationContext(model)baru,results, danvalidateAllProperties: true. - Di bagian atas
Program.cs, tambahkanusing System.ComponentModel.DataAnnotations;dan beriTitlemilikTaskInputdua atribut:[property: Required(ErrorMessage = "Title is required."), StringLength(80)]. - Di POST dan PUT, ganti pemeriksaan
IsNullOrWhiteSpacedenganvar errors = Validation.Errors(input);dan berikanResults.ValidationProblem(errors)jika nilainya bukannull.
Judul dengan 81 karakter sekarang menghasilkan 400 dengan:
"errors": { "title": ["The field Title must be a string with a maximum length of 80."] }Coba: tekan Jalankan lalu kirim POST dengan body yang judulnya terdiri dari 81 huruf ke /api/tasks: 400 dan error di atas. Kirim POST { "title": "" }: 400 dengan Title is required., seperti sebelumnya. Kirim POST { "title": "Order new chairs" }: 201.
Coba sendiri
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);