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

在 .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 并附带错误信息,这对前端调试非常有用。
自定义验证逻辑
对于复杂规则,可以继承 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中文网其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1441052.html
微信扫一扫
支付宝扫一扫