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 条评论
登录 后参与评论

相关文章

来自专栏木木玲

Netty 那些事儿 ——— Netty实现“流量整形”原理分析及实战

3304
来自专栏Java Edge

Spring Data JPA踩坑记:与Bootstrap Table的分页协作@PersistenceContext和@Resource的区别

注入一堆保存实体类状态的数据结构,针对实体类的不同状态(四种,managedh或detached等)可以做出不同的反应(merge,persist等等),其实就...

931
来自专栏coder修行路

Python并发编程协程(Coroutine)之Gevent

Gevent官网文档地址:http://www.gevent.org/contents.html 基本概念 我们通常所说的协程Coroutine其实是corpo...

27710
来自专栏有刻

Java 小记 — RabbitMQ 的实践与思考

34010
来自专栏逸鹏说道

我为NET狂官方面试题-数据库篇答案

说明:如有错误可以批评指正,有更好写法也可以提点下~ 1. 求结果:select "1"? 报错,SQL里面只有单引号,列如:'xx' 2. 查找包含"obj...

3378
来自专栏salesforce零基础学习

salesforce 零基础学习(六十四)页面初始化时实现DML操作

有的时候我们往往会遇到此种类似的需求:用户在访问某个详细的记录时,需要记录一下什么时候哪个用户访问过此页面,也就是说进入此页面时,需要插入一条记录到表中,表有用...

1988
来自专栏Linyb极客之路

杂谈Java高并发

对于我们开发的网站,如果网站的访问量非常大的话,那么我们就需要考虑相关的并发访问问题了。而并发问题是绝大部分的程序员头疼的问题,但话又说回来了,既然逃避不掉,那...

1005
来自专栏JAVA高级架构

Java编写基于netty的RPC框架

1022
来自专栏Kubernetes

原 荐 Kubernetes Resourc

更多关于kubernetes的深入文章,请看我csdn或者oschina的博客主页。 ResoureQuota介绍 关于ResoureQuota和Resourc...

4609
来自专栏Python私房菜

简析Python中的四种队列

在Python文档中搜索队列(queue)会发现,Python标准库中包含了四种队列,分别是queue.Queue / asyncio.Queue / mult...

623

扫码关注云+社区