asp.net core webapi中的数据注解与数据验证

在这一课中,主要讲解了如何在 Web API 中使用数据注解(Data Annotations)和进行数据验证,以确保请求数据的有效性和完整性。

在 Web API 中,数据验证是确保客户端传递的数据符合业务规则和格式要求的关键步骤。数据注解提供了一种简洁的方式来对模型进行验证,无需编写额外的验证逻辑。

一、什么是数据注解(Data Annotations)?

数据注解是 .NET 提供的一种用于模型属性的元数据标注方式。它通过在模型类的属性上应用特定的特性(Attribute)来定义验证规则。数据注解通常用于验证用户输入、控制数据存储格式、设置显示格式等。

常用的数据注解包括:

  • Required:表示该字段是必填的。
  • StringLength:限制字符串的最大长度或最小长度。
  • Range:指定数值字段的允许范围。
  • EmailAddress:验证电子邮件地址的格式。
  • RegularExpression:验证输入是否匹配特定的正则表达式。
  • Compare:验证两个字段的值是否相等(例如密码确认)。
  • CreditCard:验证信用卡号的格式。
  • Url:验证 URL 的格式。
  • Phone:验证电话号码格式。

二、Web API中的数据验证流程

  1. 定义数据模型:创建一个包含数据注解的模型类,模型类通常用于表示请求体(Request Body)中的数据。

  2. 使用数据注解:在模型类的属性上应用不同的数据注解特性,指定验证规则。

  3. 在控制器中接收数据:在 Web API 控制器中接收这些模型对象作为方法参数。

  4. 验证请求数据:当 Web API 接收到请求时,自动执行数据验证。如果数据无效,API 会返回错误响应,指明哪个字段的值无效。

  5. 自定义验证(可选):除了使用内建的数据注解,还可以实现自定义验证特性或使用 Fluent Validation 等第三方库。

三、使用数据注解进行验证

1. 定义一个数据模型

假设我们要创建一个用户注册的 Web API,其中包含用户的姓名、电子邮件、密码和年龄等字段。我们可以定义一个模型类,并在其中使用数据注解来验证输入数据。

using System.ComponentModel.DataAnnotations;public class RegisterModel
{[Required(ErrorMessage = "姓名是必填项")][StringLength(50, ErrorMessage = "姓名的长度不能超过50个字符")]public string Name { get; set; }[Required(ErrorMessage = "电子邮件是必填项")][EmailAddress(ErrorMessage = "无效的电子邮件格式")]public string Email { get; set; }[Required(ErrorMessage = "密码是必填项")][StringLength(100, MinimumLength = 6, ErrorMessage = "密码长度必须在6到100个字符之间")]public string Password { get; set; }[Range(18, 100, ErrorMessage = "年龄必须在18到100岁之间")]public int Age { get; set; }
}

在上面的代码中,RegisterModel 类定义了用户注册所需的数据字段:

  • Name:必填,且最大长度不能超过 50 个字符。
  • Email:必填,并且需要符合电子邮件格式。
  • Password:必填,且长度需要在 6 到 100 个字符之间。
  • Age:必须是 18 到 100 之间的整数。
2. 在控制器中使用模型

接下来,在 Web API 控制器中,使用 RegisterModel 作为请求参数:

using Microsoft.AspNetCore.Mvc;[Route("api/[controller]")]
[ApiController]
public class UserController : ControllerBase
{[HttpPost("register")]public IActionResult Register([FromBody] RegisterModel model){if (!ModelState.IsValid){return BadRequest(ModelState);  // 返回验证失败的详细信息}// 如果数据有效,执行注册逻辑return Ok("注册成功");}
}

UserControllerRegister 方法中,我们将 RegisterModel 作为请求体参数。如果传递的数据无效,ModelState.IsValid 会返回 false,此时我们使用 BadRequest(ModelState) 返回所有验证失败的详细信息。

3. 返回验证错误信息

如果请求数据无效,API 会返回类似以下的响应,指明哪些字段未通过验证:

{"name": ["姓名是必填项"],"email": ["无效的电子邮件格式"],"password": ["密码长度必须在6到100个字符之间"],"age": ["年龄必须在18到100岁之间"]
}

四、常见数据注解的使用示例

1. Required — 必填验证
[Required(ErrorMessage = "用户名是必填项")]
public string Username { get; set; }
2. StringLength — 字符串长度限制
[StringLength(50, MinimumLength = 5, ErrorMessage = "用户名长度必须在5到50个字符之间")]
public string Username { get; set; }
3. EmailAddress — 验证电子邮件格式
[EmailAddress(ErrorMessage = "请输入有效的电子邮件地址")]
public string Email { get; set; }
4. Range — 数值范围限制
[Range(18, 100, ErrorMessage = "年龄必须在18到100岁之间")]
public int Age { get; set; }
5. RegularExpression — 正则表达式验证
[RegularExpression(@"^\d{3}-\d{2}-\d{4}$", ErrorMessage = "无效的社会安全号格式")]
public string SSN { get; set; }

五、使用 Fluent Validation 进行复杂验证

除了数据注解,Fluent Validation 是一个流行的第三方库,它提供了更灵活的验证功能。使用 Fluent Validation,你可以通过更具可读性的语法进行复杂的验证。

using FluentValidation;public class RegisterModelValidator : AbstractValidator<RegisterModel>
{public RegisterModelValidator(){RuleFor(x => x.Name).NotEmpty().WithMessage("姓名不能为空").Length(1, 50);RuleFor(x => x.Email).NotEmpty().EmailAddress().WithMessage("无效的电子邮件");RuleFor(x => x.Password).NotEmpty().Length(6, 100).WithMessage("密码长度必须在6到100个字符之间");RuleFor(x => x.Age).InclusiveBetween(18, 100).WithMessage("年龄必须在18到100岁之间");}
}

Fluent Validation 提供了更加灵活和可配置的验证机制,适用于复杂的验证场景。

六、总结

在 Web API 中使用数据注解和数据验证是一种简单而有效的方式,用于确保客户端传递的请求数据符合要求。通过数据注解,我们能够轻松定义字段的验证规则,如必填、长度、范围、格式等。在实际开发中,结合数据注解和合适的错误处理,可以提高 API 的健壮性,确保应用的正确性和安全性。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/diannao/66441.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

MATLAB语言的编程范式

MATLAB语言的编程范式 MATLAB&#xff08;Matrix Laboratory&#xff09;是一种高性能的语言&#xff0c;广泛用于数值计算、数据分析和算法开发。它为工程师和科学家提供了强大的数学工具&#xff0c;尤其擅长矩阵运算、数据可视化和复杂系统建模。在这篇文章中&#xff0c;我…

【学习路线】Python 算法(人工智能)详细知识点学习路径(附学习资源)

学习本路线内容之前&#xff0c;请先学习Python的基础知识 其他路线&#xff1a; Python基础 >> Python进阶 >> Python爬虫 >> Python数据分析&#xff08;数据科学&#xff09; >> Python 算法&#xff08;人工智能&#xff09; >> Pyth…

游戏引擎学习第77天

仓库: https://gitee.com/mrxiao_com/2d_game 回顾昨天的 bug 今天我们继续开发进度&#xff0c;进行调试昨天代码的问题&#xff0c;主要是关于如何跟踪玩家和敌人在世界中的高度位置。虽然我们做的是一款 2D 游戏&#xff0c;但我们希望能够处理多层的房间&#xff0c;玩家…

【Java基础】正则表达式的使用与常用类分享

1. Java 正则表达式 正则表达式定义了字符串的模式。 可以用来搜索、编辑或处理文本。 正则表达式并不仅限于某一种语言&#xff0c;但是在每种语言中有细微的差别。 1.1 正则表达式实例 一个字符串其实就是一个简单的正则表达式&#xff0c;例如 Hello World 正则表达式匹配…

第30天:Web开发-PHP应用组件框架前端模版渲染三方插件富文本编辑器CVE审计

#知识点 1、安全开发-原生PHP-开发组件集合 2、安全开发-原生PHP-模版引擎渲染 3、安全开发-原生PHP-第三方编辑器 组件/框架 说明 [Web框架] Laravel 现代化、功能全面的框架&#xff0c;适合大多数Web应用。 Symfony 高度模块化、功能强大的框架&#xff0c;适合复杂…

with as提高sql的执行效率

实战sql with cte(UNIT_ID, UNIT_NAME, PARENT_UNIT_ID, UNIT_CODE ) as (select UNIT_ID, UNIT_NAME, PARENT_UNIT_ID , UNIT_CODEfrom HPFM_UNITunion allselect t.UNIT_ID, t.UNIT_NAME, t.PARENT_UNIT_ID, t.UNIT_CODEfrom HPFM_UNIT tjoin cte on t.PARENT_UNIT_ID cte.U…

计算机网络 (29)网络地址转换NAT

前言 网络地址转换&#xff08;Network Address Translation&#xff0c;NAT&#xff09;是计算机网络中的一种重要协议&#xff0c;它主要用于将私有IP地址转换为公共IP地址&#xff0c;以实现内部网络与外部网络之间的通信。 一、基本概念 NAT是一种在局域网&#xff08;LAN&…

Docker--Docker Volume(存储卷)

什么是存储卷&#xff1f; Docker的存储卷是一种将宿主机的本地文件系统中的某个目录与容器内部的文件系统中的某个目录建立绑定关系的机制。这种绑定关系意味着&#xff0c;当在容器的这个目录下写入数据时&#xff0c;会同步到宿主机的这个目录中&#xff1b;同样&#xff0…

STM32裸机开发转FreeRTOS教程

目录 1. 简介2. RTOS设置&#xff08;1&#xff09;分配内存&#xff08;2&#xff09;查看任务剩余空间&#xff08;3&#xff09;使用osDelay 3. 队列的使用&#xff08;1&#xff09;创建队列&#xff08;1&#xff09;直接传值和指针传值&#xff08;2&#xff09;发送/接收…

用豆包MarsCode IDE打造精美数据大屏:从零开始的指南

原标题&#xff1a;用豆包MarsCode IDE&#xff0c;从0到1画出精美数据大屏&#xff01; 豆包MarsCode IDE 是一个云端 AI IDE 平台&#xff0c;通过内置的 AI 编程助手&#xff0c;开箱即用的开发环境&#xff0c;可以帮助开发者更专注于各类项目的开发。 作为一名前端开发工…

PySide6的样式表

PySide6 提供了对 Qt 样式表&#xff08;Qt Style Sheets&#xff0c;简称 QSS&#xff09;的支持&#xff0c;这是一种类似于 CSS 的样式表语言&#xff0c;用于自定义 Qt 应用程序的外观。 1. 什么是 Qt 样式表&#xff08;QSS&#xff09; Qt 样式表是一种声明性的样式表语…

android 启动页倒计时页面编写

一、需求和技术 1、实现5,4,3,2,1启动页倒计时 2、倒计时实现使用CountDownTimer 二、activity代码 public class OpenActivity extends AppCompatActivity {private Button in;@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanc…

PCB原理图的编译设置

设置步骤&#xff1a; 进入-->Project Options...&#xff0c;对照设置“致命错误”部分来设置即可

LInux单机安装Redis

1. 安装gee工具包 由于Redis是基于c语言编写的所以安装的时候需要先安装gee以及gcc的依赖,yum云用不了可以看一下这个 linux 替换yum源镜像_更换yum镜像源-CSDN博客 yum install -y gcc tcl 2. 添加redis的压缩包 3. 上传到Linux 上传到 /usr/local/src 目录、这个目录一般用于…

键盘鼠标共享工具Barrier(kail与windows操作系统)

键鼠共享工具Barrier(kail与windows操作系统)_barrier软件-CSDN博客 sudo apt install barrier

黄仁勋演讲总结(2种显卡,1个开源大模型,1个数据采集平台)

研发算力显卡RTX50系列&#xff0c;PC端显卡GB10&#xff0c;开源大模型Cosmos&#xff08;用于机器人和自动驾驶&#xff09;&#xff0c; Isaac GR00T&#xff08;人形机器人的数据采集平台&#xff09;。 新一代 RTX 50 系列显卡 RTX 50 系列 GPU&#xff0c;相对之前系列&a…

Linux内核学习——数据结构

文章目录 链表双向链表哈希链表 红黑树无锁环形缓冲区映射参考 内核版本&#xff1a;linux-6.6.69 longterm 链表 双向链表 Linux内核实现了一套纯链表的封装&#xff0c;链表节点数据结构只有指针区而没有数据区&#xff0c;另外还封装了各种操作函数&#xff0c;如创建节点…

批量写入数据到数据库,卡顿怎么解决

在批量写入数据到数据库时,遇到卡顿或性能瓶颈是比较常见的问题。以下是一些可能的解决方案和优化策略,帮助你提高批量写入的性能: ### 1. **批量大小优化** - **调整批量大小**:尝试调整批量写入的数据量,找到一个平衡点。过大或过小的批量大小都可能影响性能。通常,批…

初学Linux电源管理

学习文档出处&#xff1a; 万字整理 | 深入理解Linux电源管理&#xff1a;万字整理 | 深入理解Linux电源管理-CSDN博客 电源管理 因为设备需要用电&#xff0c;而且设备中的各个硬件所需要的电压是不一样的。故计算机需要对硬件的电源状态管理。但是电能并不是免费的&#x…

基于开发/发布/缺陷分离模型的 Git 分支管理实践20250103

基于开发/发布/缺陷分离模型的 Git 分支管理实践 引言 在现代软件开发中&#xff0c;合理的分支管理策略是保证项目成功的关键因素之一。本文将详细介绍一种基于开发/发布/缺陷分离的 Git 分支管理模型&#xff0c;这种模型不仅能提升团队协作效率&#xff0c;还能确保代码质…