Menu
CoddyTech

验证属性

本课属于 Coddy ASP.NET Core 学习旅程的“REST API”单元。第 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。

challenge icon

挑战

中等

将标题规则移到 TaskInput 上,并添加一条新规则:标题最多包含 80 个字符。

  1. 现在有一个新文件 Validation.cs。它的 Errors 方法会将结果转换为 Results.ValidationProblem 所需的字典。在注释所指的位置,使用新的 ValidationContext(model)、results 和 validateAllProperties: true,对 model 调用 Validator.TryValidateObject。
  2. 在 Program.cs 的顶部,添加 using System.ComponentModel.DataAnnotations;,并为 TaskInput 的 Title 添加两个属性:[property: Required(ErrorMessage = "Title is required."), StringLength(80)]。
  3. 在 POST 和 PUT 中,将 IsNullOrWhiteSpace 检查替换为 var errors = Validation.Errors(input);,如果它不是 null,就返回 Results.ValidationProblem(errors)。

现在,长度为 81 个字符的标题会返回 400,并附带以下内容:

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

试试看:按下“运行”,然后向 /api/tasks 发送一个标题包含 81 个字母的 POST 请求:返回 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);

REST API中的所有课