0

0

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

星降

星降

发布时间:2025-10-31 16:01:09

|

693人浏览过

|

来源于php中文网

原创

在 .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 并附带错误信息,这对前端调试非常有用。

自定义验证逻辑

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

Synths.Video
Synths.Video

一键将文章转换为带有真人头像和画外音的视频

下载
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 的作用机制,以及如何让错误信息清晰传达给调用方。

相关专题

更多
if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

751

2023.08.22

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

9

2026.01.20

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

59

2026.01.19

java用途介绍
java用途介绍

本专题整合了java用途功能相关介绍,阅读专题下面的文章了解更多详细内容。

80

2026.01.19

java输出数组相关教程
java输出数组相关教程

本专题整合了java输出数组相关教程,阅读专题下面的文章了解更多详细内容。

38

2026.01.19

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

10

2026.01.19

xml格式相关教程
xml格式相关教程

本专题整合了xml格式相关教程汇总,阅读专题下面的文章了解更多详细内容。

13

2026.01.19

PHP WebSocket 实时通信开发
PHP WebSocket 实时通信开发

本专题系统讲解 PHP 在实时通信与长连接场景中的应用实践,涵盖 WebSocket 协议原理、服务端连接管理、消息推送机制、心跳检测、断线重连以及与前端的实时交互实现。通过聊天系统、实时通知等案例,帮助开发者掌握 使用 PHP 构建实时通信与推送服务的完整开发流程,适用于即时消息与高互动性应用场景。

17

2026.01.19

微信聊天记录删除恢复导出教程汇总
微信聊天记录删除恢复导出教程汇总

本专题整合了微信聊天记录相关教程大全,阅读专题下面的文章了解更多详细内容。

155

2026.01.18

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.9万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 8.6万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

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