雷火电竞-中国电竞赛事及体育赛事平台

歡迎來到入門教程網(wǎng)!

ASP.NET

當(dāng)前位置:主頁 > 網(wǎng)絡(luò)編程 > ASP.NET >

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

來源:本站原創(chuàng)|時間:2020-01-11|欄目:ASP.NET|點擊:

為什么要使用FluentValidation

1.在日常的開發(fā)中,需要驗證參數(shù)的合理性,不緊前端需要驗證傳毒的參數(shù),后端也需要驗證參數(shù)
2.在領(lǐng)域模型中也應(yīng)該驗證,做好防御性的編程是一種好的習(xí)慣(其實以前重來不寫的,被大佬教育了一番)
3.FluentValidation 是.NET 開發(fā)的驗證框架,開源,主要是簡單好用,內(nèi)置了一些常用的驗證器,可以直接使用,擴展也很方便

使用FluentValidation

1.引入FluentValidation.AspNetCore NuGet包
2.建立需要驗證的類

/// <summary>
/// 創(chuàng)建客戶
/// </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.統(tǒng)一返回驗證的信息,ResponseResult為全局統(tǒng)一參數(shù)返回的類

  /// <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 =>
    {
      //忽略循環(huán)引用
      //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>
  /// 創(chuàng)建客戶
  /// </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 = "創(chuàng)建客戶成功!"
    };
    return result;
  }

以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持我們。

上一篇:用.NET做動態(tài)域名解析的方法示例

欄    目:ASP.NET

下一篇:談?wù)?net對象生命周期(垃圾回收)

本文標(biāo)題:.Net Core3.0 WEB API中使用FluentValidation驗證(批量注入)

本文地址:http://www.jygsgssxh.com/a1/ASP_NET/10825.html

網(wǎng)頁制作CMS教程網(wǎng)絡(luò)編程軟件編程腳本語言數(shù)據(jù)庫服務(wù)器

如果侵犯了您的權(quán)利,請與我們聯(lián)系,我們將在24小時內(nèi)進行處理、任何非本站因素導(dǎo)致的法律后果,本站均不負(fù)任何責(zé)任。

聯(lián)系QQ:835971066 | 郵箱:835971066#qq.com(#換成@)

Copyright © 2002-2020 腳本教程網(wǎng) 版權(quán)所有