سمات التحقق
جزء من قسم واجهات API بنمط REST في رحلة 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);