导读:本期聚焦于小伙伴创作的《C#如何验证输入参数_C# DataAnnotations模型绑定校验【基础】》,敬请观看详情,探索知识的价值。以下视频、文章将为您系统阐述其核心内容与价值。如果您觉得《C#如何验证输入参数_C# DataAnnotations模型绑定校验【基础】》有用,将其分享出去将是对创作者最好的鼓励。

在C#的Web开发或者通用应用开发中,输入参数的合法性校验是避免程序异常、保障数据正确性的基础工作。传统的手动校验方式需要为每个参数编写独立的判断逻辑,不仅代码冗余,后期维护成本也比较高。DataAnnotations是.NET框架提供的一套参数标注特性集合,配合模型绑定机制,可以在参数绑定的过程中自动完成校验,非常适合基础的输入参数校验场景。

C#如何验证输入参数_C# DataAnnotations模型绑定校验【基础】

DataAnnotations常用校验特性

DataAnnotations提供了多种内置的校验特性,覆盖大部分常见的参数校验需求,以下是几个最常用的特性说明:

  • Required:标注参数必填,不允许为null或者空字符串
  • StringLength:限制字符串的长度范围,可设置最大长度和最小长度
  • Range:限制数值类型的参数取值范围
  • RegularExpression:通过正则表达式校验参数的格式,比如手机号、邮箱格式
  • EmailAddress:专门校验邮箱格式的快捷特性

模型定义与特性标注示例

首先我们需要定义一个承载输入参数的模型类,在对应的属性上添加校验特性,示例如下:

using System.ComponentModel.DataAnnotations;

namespace Demo.Models
{
    public class UserRegisterModel
    {
        [Required(ErrorMessage = "用户名不能为空")]
        [StringLength(20, MinimumLength = 3, ErrorMessage = "用户名长度需要在3到20个字符之间")]
        public string UserName { get; set; }

        [Required(ErrorMessage = "邮箱不能为空")]
        [EmailAddress(ErrorMessage = "请输入正确的邮箱格式")]
        public string Email { get; set; }

        [Required(ErrorMessage = "年龄不能为空")]
        [Range(1, 120, ErrorMessage = "年龄需要在1到120之间")]
        public int Age { get; set; }

        [RegularExpression(@"^1[3-9]d{9}$", ErrorMessage = "请输入正确的手机号")]
        public string Phone { get; set; }
    }
}

模型绑定时的自动校验

在ASP.NET Core的控制器中,当我们将模型类作为参数接收时,框架会在模型绑定的过程中自动触发DataAnnotations的校验逻辑,不需要手动调用校验方法。示例如下:

using Microsoft.AspNetCore.Mvc;
using Demo.Models;

namespace Demo.Controllers
{
    [ApiController]
    [Route("api/user")]
    public class UserController : ControllerBase
    {
        [HttpPost("register")]
        public IActionResult Register([FromBody] UserRegisterModel model)
        {
            // 判断模型校验是否通过
            if (!ModelState.IsValid)
            {
                // 返回校验失败的错误信息
                return BadRequest(ModelState);
            }
            // 校验通过后的业务逻辑
            return Ok("注册信息校验通过");
        }
    }
}

校验结果的处理方式

当校验不通过时,ModelState对象会包含所有校验失败的字段和对应的错误信息,我们可以通过遍历ModelState获取具体的错误内容,也可以直接将其返回给前端。如果需要自定义错误信息的返回格式,可以参考以下处理方式:

[HttpPost("register-custom")]
public IActionResult RegisterCustom([FromBody] UserRegisterModel model)
{
    if (!ModelState.IsValid)
    {
        var errors = new List<string>();
        foreach (var state in ModelState.Values)
        {
            foreach (var error in state.Errors)
            {
                errors.Add(error.ErrorMessage);
            }
        }
        return BadRequest(new { code = 400, msg = "参数校验失败", errors });
    }
    return Ok(new { code = 200, msg = "注册成功" });
}

非Web场景下的手动校验

如果不是在ASP.NET Core的模型绑定场景,比如在普通的控制台程序或者类库中,需要手动触发DataAnnotations的校验,可以使用Validator类实现,示例代码如下:

using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;

public class ValidationHelper
{
    public static List<string> ValidateObject(object obj)
    {
        var results = new List<ValidationResult>();
        var context = new ValidationContext(obj);
        // 执行校验,将所有错误结果存入results
        Validator.TryValidateObject(obj, context, results, true);
        var errorMessages = new List<string>();
        foreach (var result in results)
        {
            errorMessages.Add(result.ErrorMessage);
        }
        return errorMessages;
    }
}

// 调用示例
var user = new UserRegisterModel
{
    UserName = "ab",
    Email = "wrong_email",
    Age = 150
};
var errors = ValidationHelper.ValidateObject(user);
if (errors.Count > 0)
{
    foreach (var error in errors)
    {
        Console.WriteLine(error);
    }
}

注意事项

  • 如果模型属性是可空类型,Required特性默认不会校验可空类型的null值,需要额外设置特性参数
  • 正则校验特性中的正则表达式需要符合C#的正则语法规则,特殊字符需要正确转义
  • 自定义校验逻辑可以通过继承ValidationAttribute基类实现,满足特殊的业务校验需求

C#DataAnnotations模型绑定校验输入参数验证修改时间:2026-06-13 11:54:33

免责声明:​ 已尽一切努力确保本网站所含信息的准确性。网站内容多为原创整理与精心编撰,观点力求客观中立。本站旨在免费分享,内容仅供个人学习、研究或参考使用。若引用了第三方作品,版权归原作者所有。如内容涉及您的权益,请联系我们处理。
内容垂直聚焦
专注技术核心技术栏目,确保每篇文章深度聚焦于实用技能。从代码技巧到架构设计,为用户提供无干扰的纯技术知识沉淀,精准满足专业提升需求。
知识结构清晰
覆盖从开发到部署的全链路。AI、前端、编程、数据库、服务器、建站、系统层层递进,构建清晰学习路径,帮助用户系统化掌握开发与运维所需的核心技术。
深度技术解析
拒绝泛泛而谈,深入技术细节与实践难点。无论是数据库优化还是服务器配置,均结合真实场景与代码示例进行剖析,致力于提供可直接应用于工作的解决方案。
专业领域覆盖
精准对应开发生命周期。从前端界面到后端编程,从数据库操作到服务器运维,形成完整闭环,一站式满足全栈工程师和运维人员的技术需求。
即学即用高效
内容强调实操性,步骤清晰、代码完整。用户可根据教程直接复现和应用于自身项目,显著缩短从学习到实践的距离,快速解决开发中的具体问题。
持续更新保障
专注既定技术方向进行长期、稳定的内容输出。确保各栏目技术文章持续更新迭代,紧跟主流技术发展趋势,为用户提供经久不衰的学习价值。