0

0

.NET Web API如何进行模型验证_Web API模型验证实现方式

畫卷琴夢

畫卷琴夢

发布时间:2025-11-13 16:00:15

|

962人浏览过

|

来源于php中文网

原创

答案:.NET Web API 模型验证通过数据注解、自定义特性、IValidatableObject 和全局过滤器实现,确保数据合法性。使用 [Required]、[StringLength] 等特性可自动验证字段;自定义 ValidationAttribute 支持复杂规则如用户名不含邮箱前缀;IValidatableObject 用于跨字段验证如密码一致性;通过全局 ModelStateValidationFilter 统一处理验证失败响应,避免重复代码,提升接口健壮性与可维护性。

.net web api如何进行模型验证_web api模型验证实现方式

.NET Web API 中的模型验证是确保客户端提交的数据符合预期结构和规则的关键环节。通过合理的验证机制,可以减少错误数据进入业务逻辑层,提升接口的健壮性和安全性。实现模型验证有多种方式,最常用的是基于数据注解(Data Annotations)和手动验证,也可结合自定义验证逻辑或使用第三方库增强灵活性。

使用数据注解进行模型验证

这是最简单且广泛使用的方式。在模型类的属性上添加特性(Attributes),由框架自动触发验证。

  • [Required]:标记字段为必填项
  • [StringLength]:限制字符串长度
  • [Range]:数值范围限制
  • [EmailAddress]:验证邮箱格式
  • [RegularExpression]:使用正则表达式校验格式

例如:

public class UserDto
{
    [Required(ErrorMessage = "姓名不能为空")]
    [StringLength(50, ErrorMessage = "姓名不能超过50个字符")]
    public string Name { get; set; }

    [Required]
    [EmailAddress(ErrorMessage = "邮箱格式不正确")]
    public string Email { get; set; }

    [Range(18, 100, ErrorMessage = "年龄必须在18到100之间")]
    public int Age { get; set; }
}

控制器中可通过 ModelState.IsValid 判断验证是否通过:

[HttpPost]
public IActionResult Create([FromBody] UserDto user)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }
    // 处理逻辑
    return Ok();
}

自定义验证逻辑

当内置注解无法满足需求时,可创建自定义验证特性。继承 ValidationAttribute 并重写 IsValid 方法。

例如,要求用户名不能与邮箱前缀相同:

public class NoEmailPrefixInNameAttribute : ValidationAttribute
{
    protected override ValidationResult IsValid(object value, ValidationContext validationContext)
    {
        var model = (UserDto)validationContext.ObjectInstance;
        if (model.Name != null && model.Email != null)
        {
            var emailPrefix = model.Email.Split('@')[0];
            if (model.Name.Contains(emailPrefix))
            {
                return new ValidationResult("用户名不能包含邮箱前缀");
            }
        }
        return ValidationResult.Success;
    }
}

将该特性应用到模型:

[NoEmailPrefixInName]
public class UserDto { ... }

使用 IValidatableObject 接口

对于跨字段或多条件组合验证,实现 IValidatableObject 接口更合适。

Winston AI
Winston AI

强大的AI内容检测解决方案

下载

修改模型类:

public class UserDto : IValidatableObject
{
    public string Password { get; set; }
    public string ConfirmPassword { get; set; }

    public IEnumerable Validate(ValidationContext validationContext)
    {
        if (Password != ConfirmPassword)
        {
            yield return new ValidationResult("两次密码输入不一致", new[] { nameof(ConfirmPassword) });
        }
    }
}

这种方式适合需要访问整个对象实例的复杂验证场景。

全局处理验证失败响应

为了避免每个 Action 都重复写 if (!ModelState.IsValid),可以通过过滤器统一处理。

注册全局过滤器,在 Program.csStartup.cs 中配置:

builder.Services.AddControllers(options =>
{
    options.Filters.Add(new ModelStateValidationFilter());
});

自定义过滤器示例:

public class ModelStateValidationFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
            context.Result = new BadRequestObjectResult(context.ModelState);
        }
    }
}

这样所有请求都会自动检查模型状态并返回标准化错误信息。

基本上就这些。合理使用数据注解、自定义特性、IValidatableObject 和全局过滤器,就能构建出清晰可靠的 Web API 模型验证体系。关键在于根据实际场景选择合适的方式,保持代码简洁且易于维护。

相关专题

更多
js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

506

2023.06.20

正则表达式不包含
正则表达式不包含

正则表达式,又称规则表达式,,是一种文本模式,包括普通字符和特殊字符,是计算机科学的一个概念。正则表达式使用单个字符串来描述、匹配一系列匹配某个句法规则的字符串,通常被用来检索、替换那些符合某个模式的文本。php中文网给大家带来了有关正则表达式的相关教程以及文章,希望对大家能有所帮助。

246

2023.07.05

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

722

2023.07.05

java正则表达式匹配字符串
java正则表达式匹配字符串

在Java中,我们可以使用正则表达式来匹配字符串。本专题为大家带来java正则表达式匹配字符串的相关内容,帮助大家解决问题。

209

2023.08.11

正则表达式空格
正则表达式空格

正则表达式空格可以用“s”来表示,它是一个特殊的元字符,用于匹配任意空白字符,包括空格、制表符、换行符等。本专题为大家提供正则表达式相关的文章、下载、课程内容,供大家免费下载体验。

343

2023.08.31

Python爬虫获取数据的方法
Python爬虫获取数据的方法

Python爬虫可以通过请求库发送HTTP请求、解析库解析HTML、正则表达式提取数据,或使用数据抓取框架来获取数据。更多关于Python爬虫相关知识。详情阅读本专题下面的文章。php中文网欢迎大家前来学习。

293

2023.11.13

正则表达式空格如何表示
正则表达式空格如何表示

正则表达式空格可以用“s”来表示,它是一个特殊的元字符,用于匹配任意空白字符,包括空格、制表符、换行符等。想了解更多正则表达式空格怎么表示的内容,可以访问下面的文章。

229

2023.11.17

正则表达式中如何匹配数字
正则表达式中如何匹配数字

正则表达式中可以通过匹配单个数字、匹配多个数字、匹配固定长度的数字、匹配整数和小数、匹配负数和匹配科学计数法表示的数字的方法匹配数字。更多关于正则表达式的相关知识详情请看本专题下面的文章。php中文网欢迎大家前来学习。

526

2023.12.06

俄罗斯搜索引擎Yandex最新官方入口网址
俄罗斯搜索引擎Yandex最新官方入口网址

Yandex官方入口网址是https://yandex.com;用户可通过网页端直连或移动端浏览器直接访问,无需登录即可使用搜索、图片、新闻、地图等全部基础功能,并支持多语种检索与静态资源精准筛选。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1

2025.12.29

热门下载

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

精品课程

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

共24课时 | 2.1万人学习

【李炎恢】ThinkPHP8.x 后端框架课程
【李炎恢】ThinkPHP8.x 后端框架课程

共50课时 | 4.3万人学习

Swoft2.x速学之http api篇课程
Swoft2.x速学之http api篇课程

共16课时 | 0.9万人学习

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

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