Skip to main content

Model Validation In Asp.Net Core Application Using Fluent Validation Library

In this article, we will explore the usage of the Fluent Validation library in the Asp.Net Core application.

Fluent Validation Library:

Fluent Validation is a popular .Net library for enabling validation rules. It has a lot of features like in-built validation rules that are most commonly used in any application and also has flexible support for creating custom rules. Implementing Fluent validation rules is a cleaner approach than using the 'DataAnnotation'(.Net default implementation for applying validation rules). It can be automatically injected into .NetCore model validations without any explicit implementation.

How To Implement Fluent Validation To A Model:

To apply fluent validation to the model, we have to create a separate validator class. The validator class must inherit from 'FluentValidation.AbstractValidator<TModel>'. Inside of the constructor need to apply required validation for the properties of 'TModel'.
public class Student
{
	public string Name { get; set; }
	public int Age { get; set; }
}

public class StudentValidator:AbstractValidator<Student>
{
	public StudentValidator()
	{
		RuleFor(_ => _.Name).NotNull();
		RuleFor(_ => _.Age).GreaterThan(10);
	}
}

Built-in Validators Of Fluent Validation Library:

The following are the build-in validators of the fluent validation library:
NotNull Validator
RuleFor(person => person.FirstName).NotNull()
NotEmpty Validator
RuleFor(person => person.FirstName).NotEmpty()
NotEqual Validator
RuleFor(person => person.Name).NotEqual("Naveen");

// can compare with another prop as well
RuleFor(person => person.Name).NotEqual(person => person.NickName);
Equal Validator
RuleFor(person => person.Name).Equal("naveen")

//compare with other props
RuleFor(person => person.Name).Equal(person => person.NickName)
Length Validator
RuleFor(person => person.Name).Length(1,50)
MaxLength Validator
RuleFor(person => person.Name).MaximumLength(100)
MinLength Validator
RuleFor(person => person.Name).MinimumLength(10)
Less Than Validator
RuleFor(person => person.Age).LessThan(20)

// less than another property
RuleFor(person => person.Age).LessThan(person => person.MaxAgeLimit)
Less Than Or Equal Validator
RuleFor(person => person.Age).LessThanOrEqualTo(20)

// less than or equals to other property
RuleFor(person => person.Age).LessThanOrEqualTo(person => person.MaxAgeLimit)
Greater Than Validator
RuleFor(person => person.Age).GreaterThan(5)

// Greater than other property value
RuleFor(person => person.Age).GreaterThan(person => person.MinimumAgetLimit)
Greater Than Or Equal Validator
RuleFor(person => person.Age).GreaterThanOrEqualTo(5)

// Greater than or equals to other property value
RuleFor(person => person.Age).GreaterThanOrEqualTo(person => person.MinimumAgetLimit)
Regular Expression Validator
RuleFor(person => person.Name).Matches("Regex pattern")
Email Validator
RuleFor(person => person.Email).EmailAddress()
Credit Card Validator
RuleFor(person => person.CreditCardNumber).CreditCard()
Null Validator
RuleFor(person => person.Name).Null()
ExclusiveBetween Validator
RuleFor(person => person.Rank).ExclusiveBetween(1,10)
InClusiveBetween Validator
RuleFor(person => person.Rank).InclusiveBetween(1,10)

Create A .Net5 MVC Application:

Fluent Validation library can be used in any of the Asp.Net Core Applications. In this demo, we are going to create a .Net5 MVC sample application.



Install Fluent Validation Library:

Package Manager Command:
Install-Package FluentValidation.AspNetCore -Version 10.3.3

.NET CLI Command:
dotnet add package FluentValidation.AspNetCore --version 10.3.3

Register Fluent Validation Service:

Now register the fluent validation service as an extension to the MVC service because of this service registration fluent validation gets integrated with MVC model validations.
Startup.cs:
services.AddControllersWithViews()
.AddFluentValidation(options =>
{
	options.RegisterValidatorsFromAssemblyContaining(typeof(Startup));
});
  • Here 'RegisterValidatorsFromAssemblyContaining' it will load all the validator entity of each modal automatically without configuring explicitly. So to this option, we just need to pass any class that is under the root namespace of the library(eg: 'Startup.cs' & 'Program.cs'), so that it can identify all validator classes in our project under that namespace. 

Implement Fluent Validation For Model:

Let's understand how to enable modal validation in Asp.Net Core using fluent validation. Let's create a view model like 'PersonViewModel.cs' in the 'Models' folder.
Models/PersonViewModel.cs:
namespace FluentValidationDemo.MVC.Models
{
    public class PersonViewModel
    {
        public int ID { get; set; }
        public string LastName { get; set; }
        public string FirstName { get; set; }
        public int Age { get; set; }
    }
}
Now our goal is to define validation rules for the above class, so we have to create a new validator class like 'PersonViewModelValidator.cs' in a 'Validators' folder like below.
Validators/PersonViewModelValidator.cs:
using FluentValidation;
using FluentValidationDemo.MVC.Models;

namespace FluentValidationDemo.MVC.Validators
{
    public class PersonViewModelValidator:AbstractValidator<PersonViewModel>
    {
        public PersonViewModelValidator()
        {
            RuleFor(_ => _.FirstName).NotEmpty().Length(4,12);
            RuleFor(_ => _.Age).GreaterThan(10);
        }
    }
}
  • (Line: 6) To create a validator class it should inherit 'FluentValidation.AbstractValidator<TModel>' where 'TModel' is the type of our model that we want to enable the validation rules
  • All validation rules have to be defined inside of our validator class constructor.
  • (Line: 10)  Here I applied two validation rules for the 'FirstName' property like 'NotEmpty'(that means field can't be the empty string) and 'Length(4,12)' defined string range with min and max values.
  • (Line: 11) Here I applied only one validation rule like 'Age' property needs to be greater than some specified limit value.
Let's create an MVC view where we can observe server-side validations firing as per our validation rules. So let's create a new controller like 'PersonController.cs'.
Controllers/PersonController.cs:
using FluentValidationDemo.MVC.Models;
using Microsoft.AspNetCore.Mvc;

namespace FluentValidationDemo.MVC.Controllers
{
    [Route("person")]
    public class PersonController : Controller
    {
        
        [HttpGet]
        [Route("create")]
        public IActionResult Create()
        {
            return View();
        }

        [HttpPost]
        [Route("create")]
        public IActionResult Create(PersonViewModel person)
        {
            if (ModelState.IsValid)
            {
                return Content("Success");
            }
            return View(person);
        }
    }
}
  • (Line: 10-15) Defined a HttpGet action method, its just displays our page.
  • (Line: 17-26) Define a HttpPost action method. At #Line21 checking our model is valid or not
Views/Person/Create.cshtml:
@model FluentValidationDemo.MVC.Models.PersonViewModel

<div>
    <form asp-action="create" method="post">
        <div class="form-group row">
            <label asp-for="FirstName" class="col-sm-2 col-form-label">Name</label>
            <div class="col-sm-10">
                <input asp-for="FirstName" type="text" class="form-control" />
                <span asp-validation-for="FirstName" class="text-danger"></span>
            </div>
        </div>
        <div class="form-group row">
            <label asp-for="Age" class="col-sm-2 col-form-label">Name</label>
            <div class="col-sm-10">
                <input asp-for="Age" type="text" class="form-control" />
                <span asp-validation-for="Age" class="text-danger"></span>
            </div>
        </div>
        <div class="form-group row">
            <button type="submit" class="btn btn-primary">Submit</button>
        </div>
    </form>
</div>
  • (Line: 1) Defined model for our razor view.
  • Created a small form with MVC model binding using razor syntax.
Now open the page and enter some invalid data into the form and click on submit button error messages will be displayed as below.

Implement Fluent Validation For Nested Model:

Now let's explore how fluent validation rules are applied for the nested model. Let's create a child view model like 'PersonAddressViewModel.cs'.
Models/PersonViewModel.cs & Models/PersonAddressViewModel.cs:
namespace FluentValidationDemo.MVC.Models
{
    public class PersonViewModel
    {
        public int ID { get; set; }
        public string LastName { get; set; }
        public string FirstName { get; set; }
        public int Age { get; set; }
		
		// child navigation property
        public PersonAddressViewModel PersonAddress { get; set; }
    }
}


namespace FluentValidationDemo.MVC.Models
{
    public class PersonAddressViewModel
    {
        public int PersonAddressId { get; set; }
        public string AddressLine1 { get; set; }
        public string AddressLine2 { get; set; }
        public string City { get; set; }
        public string State { get; set; }
        public string Country { get; set; }
    }
}
  • (Line: 11) Child class(PersonalAddressViewModel) navigation property.
  • (Line: 18-26) Add new child class like 'PersonAddressViewModel'.
Now let's create a validator class for 'PersonAddressViewModel' like 'PersonAddressViewModelValidator.cs' where we have to apply the validation rules.
Validators/PersonAddressViewModelValidators.cs:
using FluentValidation;
using FluentValidationDemo.MVC.Models;

namespace FluentValidationDemo.MVC.Validators
{
    public class PersonAddressViewModelValidator: AbstractValidator<PersonAddressViewModel>
    {
        public PersonAddressViewModelValidator()
        {
            RuleFor(_ => _.AddressLine1).NotEmpty();
        }
    }
}
  • (Line: 6) Inherited 'FluentValidation.AbstractValidotr<TModel>'.
  • (Line: 10) For the 'AddressLine1' property applied a validation rule like it can't be empty.
let's update our view(Create.cshtml) with an additional textbox that to bind our child class property like 'AddressLine1'.
Views/Person/Create.cshtml:
@model FluentValidationDemo.MVC.Models.PersonViewModel


<div>
    <form asp-action="create" method="post">
        <div class="form-group row">
            <label asp-for="FirstName" class="col-sm-2 col-form-label">Name</label>
            <div class="col-sm-10">
                <input asp-for="FirstName" type="text" class="form-control" />
                <span asp-validation-for="FirstName" class="text-danger"></span>
            </div>
        </div>
        <div class="form-group row">
            <label asp-for="Age" class="col-sm-2 col-form-label">Age</label>
            <div class="col-sm-10">
                <input asp-for="Age" type="text" class="form-control" />
                <span asp-validation-for="Age" class="text-danger"></span>
            </div>
        </div>
        <div class="form-group row">
            <label asp-for="PersonAddress.AddressLine1" class="col-sm-2 col-form-label">Address1</label>
            <div class="col-sm-10">
                <input asp-for="PersonAddress.AddressLine1" type="text" class="form-control" />
                <span asp-validation-for="PersonAddress.AddressLine1" class="text-danger"></span>
            </div>
        </div>

        <div class="form-group row">
            <button type="submit" class="btn btn-primary">Submit</button>
        </div>
    </form>
</div>
  • (Line: 20-26) A new text field added for 'AddressLine1'
By default, fluent validation doesn't fire the validation rules of child class directly. So to enable we have to configure our service with an additional option as below:
Startup.cs:
services.AddControllersWithViews()
.AddFluentValidation(options =>
{
	options.RegisterValidatorsFromAssemblyContaining(typeof(Startup));
	options.ImplicitlyValidateChildProperties = true;
});
  • (Line: 5) The 'ImplicitlyValidateChildProperties' set to 'true' will fire child class properties validation rules automatically.
Now let's go to our page and enter invalid data and check the error messages as below.

CustomizeValidator Attribute:

Fluent Validation provides an attribute called 'CustomizeValidator'. With this attribute, we can only validate the required properties we want, unspecified properties validation won't fire. But it won't have control over the child-class property.

So let's update our post-action method with this CustomizeValidator attribute.
Controllers/PersonController.cs:
[HttpPost]
[Route("create")]
public IActionResult Create([CustomizeValidator(Properties ="Age")] PersonViewModel person)
{
	if (ModelState.IsValid)
	{
		return Content("Success");
	}
	return View(person);
}
  • (Line: 3) Payload decorated with 'FluentValidation.AspNetCore.CustomizedValidator' attribute. To this attribute, we have to pass the properties to which we want to fire the validation rules.

Video Session:

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on the FluentValidation library in the AspNet Core application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

Popular posts from this blog

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http

GraphQL API Integration In Asp.Net Core Application

Introduction: GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data. How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions. HTTP-POST is the only Http verb recommended by the GraphQL. The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API: The main building blocks of GraphQL API is Schemas and Types.  A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc. T