.Net Core3.0 WEB API中使用FluentValidation验证(批量注入)

 更新时间:2019年12月06日 10:38:51   作者:往事随灬锋  
这篇文章主要介绍了.Net Core3.0 WEB API中使用FluentValidation验证(批量注入),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

为什么要使用FluentValidation

1.在日常的开发中,需要验证参数的合理性,不紧前端需要验证传毒的参数,后端也需要验证参数
2.在领域模型中也应该验证,做好防御性的编程是一种好的习惯(其实以前重来不写的,被大佬教育了一番)
3.FluentValidation 是.NET 开发的验证框架,开源,主要是简单好用,内置了一些常用的验证器,可以直接使用,扩展也很方便

使用FluentValidation

1.引入FluentValidation.AspNetCore NuGet包
2.建立需要验证的类

/// <summary>
/// 创建客户
/// </summary>
public class CreateCustomerDto
{
  /// <summary>
  /// 客户姓名
  /// </summary>
  public string CustomerName { get; set; }
  /// <summary>
  /// 客户年龄
  /// </summary>
  public string CustomerAge { get; set; }
  /// <summary>
  /// 客户电话
  /// </summary>
  public string CustomerPhone { get; set; }
  /// <summary>
  /// 客户地址
  /// </summary>
  public Address CustomerAddress { get; set; }
}

/// <summary>
/// 验证
/// </summary>
public class CreateCustomerDtoValidator : AbstractValidator<CreateCustomerDto>
{
  public CreateCustomerDtoValidator()
  {
    RuleFor(x => x.CustomerName)
       .NotEmpty()
       .WithMessage("客户姓名不能为空");
    RuleFor(x => x.CustomerPhone)
       .NotEmpty()
       .WithMessage("客户电话不能为空");

  }
}

3.统一返回验证的信息,ResponseResult为全局统一参数返回的类

  /// <summary>
  /// 添加AddFluentValidationErrorMessage
  /// </summary>
  /// <returns></returns>
  public DependencyInjectionService AddFluentValidationErrorMessage()
  {
    _services.Configure<ApiBehaviorOptions>(options =>
    {
      options.InvalidModelStateResponseFactory = (context) =>
      {
        var errors = context.ModelState
          .Values
          .SelectMany(x => x.Errors
                .Select(p => p.ErrorMessage))
          .ToList();
        var result = new ResponseResult<List<string>>
        {
          StatusCode = "00009",
          Result = errors,
          Message = string.Join(",", errors.Select(e => string.Format("{0}", e)).ToList()),
          IsSucceed = false
        };

        return new BadRequestObjectResult(result);
      };
    });
    return _dependencyInjectionConfiguration;
  }

4.注入验证的类

使用builder.RegisterType().As<IValidator>();比较麻烦每次新增都需要添加一次注入
所以我们使用批量的注入,来减少麻烦,通过反射获取所有的验证的类批量注入

  /// <summary>
  /// 添加MVC
  /// </summary>
  /// <returns></returns>
  public DependencyInjectionService AddMvc()
  {
    _services.AddControllers(options => 
    { 
      options.Filters.Add(typeof(LogHelper));
    }).AddJsonOptions(options =>
    {
      //忽略循环引用
      //options.JsonSerializerOptions.IgnoreReadOnlyProperties = true;
    }).AddFluentValidation(options =>
    {
      options.RunDefaultMvcValidationAfterFluentValidationExecutes = false;
      var validatorList = GetFluentValidationValidator("ConferenceWebApi");
      foreach (var item in validatorList)
      {
        options.RegisterValidatorsFromAssemblyContaining(item);
      }
    });
    return _dependencyInjectionConfiguration;
  }

  /// <summary>
  /// 获取所有的FluentValidation Validator的类
  /// </summary>
  public IEnumerable<Type> GetFluentValidationValidator(string assemblyName)
  {
    if (assemblyName == null)
      throw new ArgumentNullException(nameof(assemblyName));
    if (string.IsNullOrEmpty(assemblyName))
      throw new ArgumentNullException(nameof(assemblyName));

    var implementAssembly = RuntimeHelper.GetAssembly(assemblyName);
    if (implementAssembly == null)
    {
      throw new DllNotFoundException($"the dll ConferenceWebApi not be found");
    }
    var validatorList = implementAssembly.GetTypes().Where(e => e.Name.EndsWith("Validator"));
    return validatorList;
  }

5.使用起来就十分简单了

  /// <summary>
  /// 创建客户
  /// </summary>
  /// <param name="input"></param>
  /// <returns></returns>
  [HttpPost]
  public async Task<ResponseResult<string>> CreateCustomer([FromBody] CreateCustomerDto input)
  {
    var createCustomerCommand = new CreateCustomerCommand(input.CustomerName,input.CustomerAge,input.CustomerPhone,input.CustomerAddress);
    await _commandService.SendCommandAsync(createCustomerCommand);
    var result = new ResponseResult<string>
    {
      IsSucceed = true,
      Result = "创建客户成功!"
    };
    return result;
  }

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

相关文章

  • .NET CORE 鉴权的实现示例

    .NET CORE 鉴权的实现示例

    本文主要介绍了.NET CORE 鉴权的实现示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-02-02
  • .Net中的Junction Points(交接点)操作

    .Net中的Junction Points(交接点)操作

    这篇文章介绍了.Net中的Junction Points(交接点)操作,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-06-06
  • Asp.Net用OWC操作Excel的实例代码

    Asp.Net用OWC操作Excel的实例代码

    这篇文章介绍了Asp.Net用OWC操作Excel的实例代码,有需要的朋友可以参考一下,希望对你有所帮助
    2013-07-07
  • Entity Framework常用查询语句

    Entity Framework常用查询语句

    这篇文章介绍了Entity Framework常用查询语句的用法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-03-03
  • .Net MVC实现长轮询

    .Net MVC实现长轮询

    这篇文章主要为大家详细介绍了.Net MVC实现长轮询的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-06-06
  • asp.net DoDragDrop 方法的使用

    asp.net DoDragDrop 方法的使用

    DoDragDrop方法,用于开始对象的拖放操作,需要的朋友可以参考下。
    2011-12-12
  • 使用ASP.Net WebAPI构建REST服务

    使用ASP.Net WebAPI构建REST服务

    这篇文章介绍了使用ASP.Net WebAPI构建REST服务的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-06-06
  • asp.net CheckBoxList各项最小宽度CSS样式(兼容性good)

    asp.net CheckBoxList各项最小宽度CSS样式(兼容性good)

    ASP.NET中,CheckBoxList里的选择都是自动宽度的,属性时没有设置各项宽度的设置,在IE10、遨游4极速模式及兼容模式下均可正确显示最小宽度,此样式除了用于CheckBoxList外,也可用于DIV等
    2013-04-04
  • 一文搞懂MemoryCache 清除全部缓存的方法

    一文搞懂MemoryCache 清除全部缓存的方法

    这篇文章主要介绍了MemoryCache 清除全部缓存的方法,本文给大家介绍两个方法,每种方法通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-12-12
  • .NET Core类库项目中读取appsettings.json配置的方法

    .NET Core类库项目中读取appsettings.json配置的方法

    ASP.NET Core是一个全新的Web开发平台,微软在它上面构建了MVC、SingalR、GRPC、Orleans这样广泛使用的Web框架,今天通过本文给大家详细介绍下.NET Core读取appsettings.json配置的方法,感兴趣的朋友一起看看吧
    2022-03-03

最新评论