در
قسمت قبل، روش تعریف قواعد اعتبارسنجی را با استفاده از کتابخانه‌ی
Fluent Validation بررسی کردیم. در این قسمت می‌خواهیم این قواعد را به صورت خودکار به یک برنامه‌ی ASP.NET Core معرفی کرده و سپس از آنها استفاده کنیم.
روش اول: استفاده‌ی دستی از اعتبارسنج کتابخانه‌ی Fluent Validation
روش‌های زیادی برای استفاده‌ی از قواعد تعریف شده‌ی توسط کتابخانه‌ی Fluent Validation وجود دارند. اولین روش، فراخوانی دستی اعتبارسنج، در مکان‌های مورد نیاز است. برای اینکار در ابتدا نیاز است با اجرای دستور «dotnet add package FluentValidation.AspNetCore»، این کتابخانه را در پروژه‌ی وب خود نیز نصب کنیم تا بتوانیم از کلاس‌ها و متدهای آن استفاده نمائیم. پس از آن، روش دستی کار با کلاس RegisterModelValidator که در قسمت قبل آن‌را تعریف کردیم، به صورت زیر است:
using FluentValidationSample.Models;
using Microsoft.AspNetCore.Mvc;
namespace FluentValidationSample.Web.Controllers
{
public class HomeController : Controller
{
public IActionResult Index()
{
return View();
}
[HttpPost]
public IActionResult RegisterValidateManually(RegisterModel model)
{
var validator = new RegisterModelValidator();
var validationResult = validator.Validate(model);
if (!validationResult.IsValid)
{
return BadRequest(validationResult.Errors[0].ErrorMessage);
}
// TODO: Save the model
return Ok();
}
}
}
ساده‌ترین روش کار با RegisterModelValidator تعریف شده، ایجاد یک وهله‌ی جدید از آن و سپس فراخوانی متد Validate آن شیء است. در این حالت می‌توان کنترل کاملی را بر روی قالب پیام نهایی بازگشت داده شده داشت. برای مثال در اینجا اولین خطای بازگشت داده شده، به اطلاع کاربر رسیده‌است. حتی می‌توان کل شیء Errors را نیز بازگشت داد.
یک نکته: متد الحاقی AddToModelState که در فضای نام FluentValidation.AspNetCore قرار دارد، امکان تبدیل نتیجه‌ی اعتبارسنجی حاصل را به ModelState استاندارد ASP.NET Core نیز میسر می‌کند:
public IActionResult RegisterValidateManually(RegisterModel model)
{
var validator = new RegisterModelValidator();
var validationResult = validator.Validate(model);
if (!validationResult.IsValid)
{
validationResult.AddToModelState(ModelState, null);
return BadRequest(ModelState);
}
// TODO: Save the model
return Ok();
} روش دوم: تزریق اعتبارسنج تعریف شده در سازنده‌ی کنترلر
بجای وهله سازی دستی RegisterModelValidator و ایجاد وابستگی مستقیمی به آن، می‌توان از روش تزریق وابستگی‌های آن نیز استفاده کرد. در این حالت اعتبارسنج RegisterModelValidator با طول عمر Transient به سیستم تزریق وابستگی‌ها معرفی شده:
namespace FluentValidationSample.Web
{
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddTransient<IValidator<RegisterModel>, RegisterModelValidator>();
services.AddControllersWithViews();
}
و پس از آن با تزریق <IValidator<RegisterModel به سازنده‌ی کنترلر مدنظر، می‌توان به امکانات آن همانند روش اول، دسترسی یافت:
namespace FluentValidationSample.Web.Controllers
{
public class HomeController : Controller
{
private readonly IValidator<RegisterModel> _registerModelValidator;
public HomeController(IValidator<RegisterModel> registerModelValidator)
{
_registerModelValidator = registerModelValidator;
}
[HttpPost]
public IActionResult RegisterValidatorInjection(RegisterModel model)
{
var validationResult = _registerModelValidator.Validate(model);
if (!validationResult.IsValid)
{
return BadRequest(validationResult.Errors[0].ErrorMessage);
}
// TODO: Save the model
return Ok();
}
}
}
به این ترتیب new RegisterModelValidator را با وهله‌ای از <IValidator<RegisterModel، تعویض کردیم. کار با این روش بسیار انعطاف پذیر بوده و همچنین قابلیت آزمون پذیری بالایی را نیز دارد.
روش سوم: خودکار سازی اجرای یک تک اعتبارسنج تعریف شده
اگر متد الحاقی AddFluentValidation را به صورت زیر به سیستم معرفی کنیم:
namespace FluentValidationSample.Web
{
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddTransient<IValidator<RegisterModel>, RegisterModelValidator>();
services.AddControllersWithViews().AddFluentValidation();
}
سبب اجرای خودکار تمام IValidatorهای اضافه شده‌ی به سیستم، پیش از اجرای اکشن متد مرتبط با آنها میشود. برای مثال اگر اکشن متدی دارای پارامتری از نوع RegisterModel بود، چون IValidator مخصوص به آن به سیستم تزریق وابستگی‌ها معرفی شده‌است، متد الحاقی AddFluentValidation، کار وهله سازی خودکار این IValidator و سپس فراخوانی متد Validate آن‌را به صورت خودکار انجام می‌دهد. به این ترتیب، قطعه کدهایی را که تاکنون نوشتیم، به صورت زیر خلاصه خواهند شد که در آنها اثری از بکارگیری کتابخانه‌ی FluentValidation مشاهده نمیشود:
namespace FluentValidationSample.Web.Controllers
{
public class HomeController : Controller
{
[HttpPost]
public IActionResult RegisterValidatorAutomatically(RegisterModel model)
{
if (!ModelState.IsValid)
{
// re-render the view when validation failed.
return View(model);
}
// TODO: Save the model
return Ok();
}
}
}
زمانیکه model به سمت اکشن متد فوق ارسال میشود، زیرساخت model-binding موجود در ASP.NET Core، اینبار کار اعتبارسنجی آن‌را توسط RegisterModelValidator به صورت خودکار انجام داده و نتیجه‌ی آن‌را به ModelState اضافه می‌کند که برای مثال در اینجا سبب رندر مجدد فرم شده که تمام مباحث tag-helperهای استانداردی مانند asp-validation-summary و asp-validation-for پس از آن به صورت متداولی و همانند قبل، قابل استفاده خواهند بود.
نکته 1: تنظیمات فوق برایASP.NET Web Pages و PageModels نیز یکی است. فقط با این تفاوت که اعتبارسنج‌ها را فقط می‌توان به مدل‌هایی که به صورت خواص یک page model تعریف شده‌اند، اعمال کرد و نه به کل page model.
نکته 2: اگر کنترلر شما به ویژگی [ApiController] مزین شده باشد:
namespace FluentValidationSample.Web.Controllers
{
[Route("[controller]")]
[ApiController]
public class HomeController : Controller
{
[HttpPost]
public IActionResult RegisterValidatorAutomatically(RegisterModel model)
{
// TODO: Save the model
return Ok();
}
}
}
در این حالت دیگر نیازی به ذکر if (!ModelState.IsValid) نیست و خطای حاصل از شکست اعتبارسنجی، به صورت خودکار توسط FluentValidation تشکیل شده و بازگشت داده میشود (پیش از رسیدن به بدنه‌ی اکشن متد فوق) و برای نمونه یک چنین شکل و خروجی خودکاری را پیدا می‌کند:
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|84df05e2-41e0d4841bb61293.",
"errors": {
"FirstName": [
"'First Name' must not be empty."
]
}
}
اگر علاقمند به سفارشی سازی این خروجی خودکار هستید، باید به این صورت با تنظیم ApiBehaviorOptions و مقدار دهی نحوه‌ی تشکیل ModelState نهایی، عمل کرد:
public void ConfigureServices(IServiceCollection services)
{
// ...
// override modelstate
services.Configure<ApiBehaviorOptions>(options =>
{
options.InvalidModelStateResponseFactory = context =>
{
var errors = context.ModelState.Values.SelectMany(x => x.Errors.Select(p => p.ErrorMessage)).ToList();
return new BadRequestObjectResult(new
{
Code = "00009",
Message = "Validation errors",
Errors = errors
});
};
});
} روش چهارم: خودکار سازی ثبت و اجرای تمام اعتبارسنج‌های تعریف شده
و در آخر بجای معرفی دستی تک تک اعتبارسنج‌های تعریف شده به سیستم تزریق وابستگی‌ها، می‌توان تمام آنها را با فراخوانی متد RegisterValidatorsFromAssemblyContaining، به صورت خودکار از یک اسمبلی خاص استخراج نمود و با طول عمر Transient، به سیستم معرفی کرد. در این حالت متد ConfigureServices به صورت زیر خلاصه میشود:
namespace FluentValidationSample.Web
{
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddControllersWithViews().AddFluentValidation(
fv => fv.RegisterValidatorsFromAssemblyContaining<RegisterModelValidator>()
);
}
در اینجا امکان استفاده‌ی از متد fv.RegisterValidatorsFromAssembly نیز برای معرفی اسمبلی خاصی مانند ()Assembly.GetExecutingAssembly نیز وجود دارد.
سازگاری اجرای خودکار FluentValidation با اعتبارسنج‌های استاندارد ASP.NET Core
به صورت پیش‌فرض، زمانیکه FluentValidation اجرا میشود، اگر اعتبارسنج دیگری نیز در سیستم تعریف شده باشد، اجرا خواهد شد. به این معنا که برای مثال می‌توان FluentValidation و DataAnnotations attributes و IValidatableObjectها را با هم ترکیب کرد.
اگر می‌خواهید این قابلیت را غیرفعال کنید و فقط سبب اجرای خودکار FluentValidationها شوید، نیاز است تنظیم زیر را انجام دهید:
public void ConfigureServices(IServiceCollection services)
{
services.AddControllersWithViews().AddFluentValidation(
fv =>
{
fv.RegisterValidatorsFromAssemblyContaining<RegisterModelValidator>();
fv.RunDefaultMvcValidationAfterFluentValidationExecutes = false;
}
);
} 
