专栏首页晓晨的专栏ASP.NET Core 添加统一模型验证处理机制

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

相关文章

  • 快速序列化组件MessagePack介绍

    晓晨
  • Entity Framework Core 2.0 新特性

    晓晨
  • .NET Core 配置Configuration杂谈

    晓晨
  • ASP.Net MVC开发基础学习笔记:四、校验、AJAX与过滤器

      位于 System.ComponentModel.DataAnnotations 命名空间中的特性指定对数据模型中的各个字段的验证。这些特性用于定义常见的验...

    Edison Zhou
  • [享学Netflix] 十、Archaius对Commons Configuration核心API Configuration的扩展实现

    上篇文章体验了一把Netflix Archaius的使用,感受到了它对配置管理上的便捷性。或许有小伙伴会说,配置管理上它和Apache Commons Conf...

    YourBatman
  • java之门面模式详解

    本文先给个例子让你看懂了这个设计模式的概念,再分析这个这设计模式的优点,最后再具体的去看看实现方式。 1.一个例子来让你理解门面设计模式概念 最直观的需求是...

    如来
  • 如何使用MongoDB+Springboot实现分布式ID?

    一、背景 如何实现分布式id,搜索相关的资料,一般会给出这几种方案: 使用数据库自增Id 使用reids的incr命令 使用UUID Twitter的snowf...

    方志朋
  • ASP.NET MVC三个重要的描述对象:ControllerDescriptor和ActionDescriptor的创建

    不论是用于描述Controller的ControllerDescriptor,还是用于描述Action方法的ActionDescriptor,都具有同步和异步两...

    蒋金楠
  • [WCF]缺少一行代码引发的血案

    这是今天作项目支持的发现的一个关于WCF的问题,虽然最终我只是添加了一行代码就解决了这个问题,但是整个纠错过程是痛苦的,甚至最终发现这个问题都具有偶然性。具体来...

    蒋金楠
  • Mybatis接口Mapper内的方法为啥不能重载?

    来源:https://my.oschina.net/zudajun/blog/666223

    程序猿DD

扫码关注云+社区

领取腾讯云代金券