ASP.NET Core 添加统一模型验证处理机制

一.前言

模型验证自ASP.NET MVC便有提供,我们可以在Model(DTO)的属性上加上数据注解(Data Annotations)特性,在进入Action之前便会根据数据注解,来验证输入的数据是否合法,下面介绍以下如何统一处理验证并返回错误信息。

二.Action过滤器实现统一验证

我们在判断验证状态时一般会在Action里判断ModelState.IsValid是否为true。

public IActionResult Create([FromBody]CreateOrderDto dto)
{
        if(ModelState.IsValid)
        {
            //TODO:...
        }
}

如果我们在每个需要验证的Action里面都写这个判断岂不是太麻烦,我们是否可以在进入所有的Action之前都进行验证,如果错误,就直接返回错误信息,不去执行Action了,当然时可以的。我们可以利用MVC的ActionFilter即Action过滤器,在执行Action之前统一判断处理。

1.首先定义一个通用的返回结果类:

public class XcHttpResult
{
    public string Msg { get; set; }

    public bool Result { get; set; }
}

2.定义一个ActionFilter

public class XcActionFilter : IActionFilter
{
    public void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
            XcHttpResult result = new XcHttpResult() { Result = false };

            foreach (var item in context.ModelState.Values)
            {
                foreach (var error in item.Errors)
                {
                    result.Msg += error.ErrorMessage + "|";
                }
            }

            context.Result = new JsonResult(result);
        }
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {

    }
}

3.配置过滤器

Startup.cs里配置过滤器,使其生效:

public void ConfigureServices(IServiceCollection services)
{

    services.AddMvc(options =>
    {
        options.Filters.Add<XcActionFilter>();
    });
}

三.测试

定义一个DTO:

public class CreateOrderDto
{
    [Required(ErrorMessage = "商品ID不得为空")]
    public string ProductId { get; set; }

    [Required(ErrorMessage = "购买商品数量不得为空")]
    [Range(1, 999, ErrorMessage = "购买商品数量必须介于1~999之间")]
    public int Number { get; set; } = 0;

    [Required(ErrorMessage = "用户ID不得为空")]
    public string UserId { get; set; }
}

使用Postman来测试接口:

可以看出已经成功验证!设置了商品数量的取值范围为1~999之间,而我输入了9999被成功拦截并返回错误信息.

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏更流畅、简洁的软件开发方式

我的数据访问函数库的源代码(一)—— 共用部分

/* 2008 4 25 更新 */ 我的数据访问函数库的源码。整个类有1400多行,原先就是分开来写的,现在更新后还是分开来发一下吧。 第一部分:内部成员...

1789
来自专栏jeremy的技术点滴

sed命令工作原理及命令备忘

3419
来自专栏大内老A

如果你想深刻理解ASP.NET Core请求处理管道,可以试着写一个自定义的Server

我们在上面对ASP.NET Core默认提供的具有跨平台能力的KestrelServer进行了详细介绍(《聊聊ASP.NET Core默认提供的这个跨平台的服务...

2288
来自专栏Linux驱动

第1阶段——uboot分析之启动函数bootm命令 (9)

本节主要学习: 详细分析UBOOT中"bootcmd=nand read.jffs2 0x30007FC0 kernel;bootm 0x30007FC0" 中...

2469
来自专栏圣杰的专栏

ASP.NET Core 中断请求了解一下(翻译)

假设有一个耗时的Action,在浏览器发出请求返回响应之前,如果刷新了页面,对于浏览器(客户端)来说前一个请求就会被终止。而对于服务端来说,又是怎样呢?前一个请...

1123
来自专栏丑胖侠

《Drools7.0.0.Final规则引擎教程》第4章 global全局变量

global 全局变量 global用来定义全局变量,它可以让应用程序的对象在规则文件中能够被访问。通常,可以用来为规则文件提供数据或服务。特别是用来操作规则执...

2786
来自专栏技术与生活

设计模式-状态模式

一个对象的行为取决于一个或者多个动态变化的属性,这些属性叫做状态,比如订单的支付状态;而这些订单状态的值是预先知道的,已支付、未支付;当订单在客户操作过程中可能...

1274
来自专栏菩提树下的杨过

Oracle中使用Entity Framework 6.x Code-First方式开发

去年写过一篇EF的简单学习笔记,当时EF还不支持Oracle的Code-First开发模式,今天无意又看了下Oracle官网,发现EF6.X已经支持了,并且给出...

2365
来自专栏xingoo, 一个梦想做发明家的程序员

Oozie分布式任务的工作流——脚本篇

继前一篇大体上翻译了Email的Action配置,本篇继续看一下Shell的相关配置。 Shell Action Shell Action可以执行Shel...

2079
来自专栏Linux驱动

第1阶段——uboot分析之启动函数bootm命令 (9)

本节主要学习: 详细分析UBOOT中"bootcmd=nand read.jffs2 0x30007FC0 kernel;bootm 0x30007FC0...

1805

扫码关注云+社区