.NET Web API如何进行模型验证

星降
发布: 2025-10-31 16:01:09
原创
648人浏览过
在 .NET Web API 中,模型验证通过数据注解和 ModelState 实现,1. 使用 Required、StringLength 等特性标注模型属性;2. 框架在绑定后自动验证并填充 ModelState;3. 在 Action 中通过 ModelState.IsValid 判断结果,失败则返回 400 及错误详情;4. 复杂规则可自定义 ValidationAttribute;5. 可通过全局过滤器自动处理验证,提升代码复用与一致性。

.net web api如何进行模型验证

在 .NET Web API 中进行模型验证,主要是通过数据注解(Data Annotations)和内置的模型绑定机制来实现。当客户端提交数据时,框架会自动根据模型上的特性进行校验,并将结果写入 ModelState,开发者可以据此判断请求是否合法。

使用数据注解进行基本验证

最常见的做法是在模型属性上添加验证特性。例如:

public class Product
{
    [Required(ErrorMessage = "名称是必填的")]
    [StringLength(100, MinimumLength = 2, ErrorMessage = "名称长度必须在2到100之间")]
    public string Name { get; set; }

    [Range(1, 1000, ErrorMessage = "价格必须在1到1000之间")]
    public decimal Price { get; set; }

    [EmailAddress(ErrorMessage = "邮箱格式不正确")]
    public string Email { get; set; }
}
登录后复制

这些特性会在模型绑定完成后自动触发验证。

在控制器中检查验证状态

在 Action 方法中,使用 ModelState.IsValid 判断模型是否通过验证:

[HttpPost]
public IActionResult Create([FromBody] Product product)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

    // 处理业务逻辑
    return CreatedAtAction(nameof(GetById), new { id = 1 }, product);
}
登录后复制

如果验证失败,返回 400 Bad Request 并附带错误信息,这对前端调试非常有用。

可图大模型
可图大模型

可图大模型(Kolors)是快手大模型团队自研打造的文生图AI大模型

可图大模型32
查看详情 可图大模型

自定义验证逻辑

对于复杂规则,可以继承 ValidationAttribute 创建自定义特性:

public class FutureDateAttribute : ValidationAttribute
{
    protected override ValidationResult IsValid(object value, ValidationContext validationContext)
    {
        if (value is DateTime date && date > DateTime.Now)
        {
            return ValidationResult.Success;
        }
        return new ValidationResult("日期必须是将来的时间。");
    }
}
登录后复制

然后在模型中使用:

public class Order
{
    [FutureDate]
    public DateTime DeliveryDate { get; set; }
}
登录后复制

启用自动模型验证过滤器(可选)

为避免每个 Action 都写 if (!ModelState.IsValid),可以全局配置自动响应:

// 在 Program.cs 或 Startup.cs 中
builder.Services.AddControllers(options =>
{
    options.Filters.Add(new ValidateModelAttribute());
});
登录后复制

这样,所有不符合验证规则的请求会自动返回 400 响应,无需手动检查。

基本上就这些。合理使用数据注解能让验证变得简洁可靠,结合自定义规则还能应对复杂场景。关键是理解 ModelState 的作用机制,以及如何让错误信息清晰传达给调用方。

以上就是.NET Web API如何进行模型验证的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习
PHP中文网抖音号
发现有趣的

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号