欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

ASP.NET Core WebApi中使用FluentValidation验证数据模型的方法

程序员文章站 2022-03-21 13:52:48
介绍 验证用户输入是一个web应用中的基本功能。对于生产系统,开发人员通常需要花费大量时间,编写大量的代码来完成这一功能。如果我们使用fluentvalidation...

介绍

ASP.NET Core WebApi中使用FluentValidation验证数据模型的方法

验证用户输入是一个web应用中的基本功能。对于生产系统,开发人员通常需要花费大量时间,编写大量的代码来完成这一功能。如果我们使用fluentvalidation构建asp.net core web api,输入验证的任务将比以前容易的多。

fluentvalidation是一个非常流行的构建强类型验证规则的.net库。

配置项目

第一步:下载fluentvalidation

我们可以使用nuget下载最新的 fluentvalidation

pm> install-package fluentvalidation.aspnetcore

第二步:添加fluentvalidation服务

我们需要在 startup.cs 文件中添加fluentvalidation服务

public void configureservices(iservicecollection services) 
{ 
  // mvc + validating
  services.addmvc()
  .setcompatibilityversion(compatibilityversion.version_2_1)
  .addfluentvalidation();
}

添加校验器

fluentvalidation 提供了多种内置的校验器。在下面的例子中,我们可以看到其中的2种

  • notnull 校验器
  • notempty 校验器

第一步: 添加一个需要验证的数据模型

下面我们添加一个 user 类。

public class user
{
  public string gender { get; set; }
  public string firstname { get; set; }
  public string lastname { get; set; }
  public string sin { get; set; }
}

第二步: 添加校验器类

使用 fluentvalidation 创建校验器类,校验器类都需要继承自一个抽象类 abstractvalidator

public class uservalidator : abstractvalidator<user>
{
  public uservalidator()
  {
   // 在这里添加规则
  }
}

第三步: 添加验证规则

在这个例子中,我们需要验证firstname, lastname, sin不能为null, 不能为空。我们也需要验证工卡sin(social insurance number)编号是合法的

public static class utilities
{
  public static bool isvalidsin(int sin)
  {
   if (sin < 0 || sin > 999999998) return false;

   int checksum = 0;
   for (int i = 4; i != 0; i--)
   {
     checksum += sin % 10;
     sin /= 10;

     int addend = 2 * (sin % 10); 
     
     if (addend >= 10) addend -= 9;
     
     checksum += addend;
     sin /= 10;
   }
     
   return (checksum + sin) % 10 == 0;
  }
}

下面我们在 uservalidator 类的构造函数中,添加验证规则

public class uservalidator : abstractvalidator<user>
{
  public uservalidator()
  {
   rulefor(x => x.firstname)
   .notempty()
   .withmessage("firstname is mandatory.");

   rulefor(x => x.lastname)
   .notempty()
   .withmessage("lastname is mandatory.");

   rulefor(x => x.sin)
   .notempty()
   .withmessage("sin is mandatory.")
   .must((o, list, context) =>
   {
     if (null != o.sin)
     {
      context.messageformatter.appendargument("sin", o.sin);
      return utilities.isvalidsin(int.parse(o.sin));
     }
     return true;
   })
   .withmessage("sin ({sin}) is not valid.");
  } 
}

第四步: 注入验证服务

public void configureservices(iservicecollection services) 
{ 
  // 添加验证器
  services.addsingleton<ivalidator<user>, uservalidator>();
  // mvc + validating
  services
    .addmvc()
    .setcompatibilityversion(compatibilityversion.version_2_1)
    .addfluentvalidation();
}

第五步:在 startup.cs 中管理你的验证错误

asp.net core 2.1及以上版本中,你可以覆盖modelstate管理的默认行为(apibehavioroptions)

public void configureservices(iservicecollection services) 
{ 
  // validators
  services.addsingleton<ivalidator<user>, uservalidator>();
  // mvc + validating
  services
    .addmvc()
    .setcompatibilityversion(compatibilityversion.version_2_1)
    .addfluentvalidation();

  // override modelstate
  services.configure<apibehavioroptions>(options =>
  {
    options.invalidmodelstateresponsefactory = (context) =>
    {
     var errors = context.modelstate
       .values
       .selectmany(x => x.errors
             .select(p => p.errormessage))
       .tolist();
      
     var result = new
     {
       code = "00009",
       message = "validation errors",
       errors = errors
     };
      
     return new badrequestobjectresult(result);
    };
  });
}

当数据模型验证失败时,程序会执行这段代码。

在这个例子,我设置了如何向客户端显示错误。这里返回结果中,我只是包含了一个错误代码,错误消息以及错误对象列表。

下面让我们看一下最终效果。

使用验证器

这里验证器使用起来非常容易。

你只需要创建一个action, 并将需要验证的数据模型放到action的参数中。

由于验证服务已在配置中添加,因此当请求这个action时, fluentvalidation 将自动验证你的数据模型!

第一步:创建一个使用待验证数据模型的action

[route("api/[controller]")]
[apicontroller]
public class demovalidationcontroller : controllerbase
{
  [httppost]
  public iactionresult post(user user)
  {
   return nocontent();
  }
}

第二步:使用postman测试你的action

ASP.NET Core WebApi中使用FluentValidation验证数据模型的方法

总结

在本篇博客中,我讲解了如何使用 fluentvalidation 进行数据模型验证。

本篇源代码 https://github.com/lamondlu/fluentvalidationexample

原文链接:common features in asp.net core 2.1 webapi: validation

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。