Phema.Validation
3.1.10
C# strongly-typed validation library for .NET
Install-Package Phema.Validation -Version 3.1.10
dotnet add package Phema.Validation --version 3.1.10
<PackageReference Include="Phema.Validation" Version="3.1.10" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Phema.Validation --version 3.1.10
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Phema.Validation, 3.1.10"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Phema.Validation as a Cake Addin
#addin nuget:?package=Phema.Validation&version=3.1.10
// Install Phema.Validation as a Cake Tool
#tool nuget:?package=Phema.Validation&version=3.1.10
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Phema.Validation
A simple, lightweight, fluent and extensible validation library for .NET Core
Installation
$> dotnet add package Phema.Validation
Core concepts
IValidationContext
- Scoped service to store all validation detailsIValidationCondition
- Contains a validation checks (e.g.Is(() => ...)
)IValidationDetail
- WhenIValidationCondition
is not valid adds toIValidationContext.ValidationDetails
ValidationSeverity
- Validation error level, used inIValidationContext.ValidationSeverity
andIValidationDetail.ValidationSeverity
IValidationScope
- Is a nested validation context with validation path and severity override
Usage (ASP.NET Core, HostedService examples)
// Add `IValidationContext` as scoped service
services.AddValidation(options => ...);
// Get or inject
var validationContext = serviceProvider.GetRequiredService<IValidationContext>();
// Validation key will be `Name` using default validation part provider
validationContext.When(person, p => p.Name)
.Is(name => name == null)
.AddValidationDetail("Name must be set");
// Validation key will be `Address.Locations[0].Latitude` using default validation part provider
validationContext.When(person, p => p.Address.Locations[0].Latitude)
.Is(latitude => ...custom check...)
.AddValidationDetail("Some custom check failed");
Validation conditions
- Monads are not composable, so
Is
andIsNot
,IsNull
andIsNotNull
... duplication
// Check for Phema.Validation.Conditions namespace
validationContext.When(person, p => p.Name)
.IsNullOrWhitespace()
.AddValidationDetail("Name must be set");
// Use multiple conditions (joined with AND)
validationContext.When(person, p => p.Name)
.IsNotNull()
// AND
.HasLengthGreater(20)
// .IsNull()
// .IsEqual()
// .IsNotUrl()
// .IsNotEmail()
// .IsMatch(regex)
.AddValidationDetail("Name should be less than 20");
// DateTime conditions
validationContext.When(task, t => t.DueDate)
.IsNotUtc()
.AddValidationDetail("Due date must be in Utc");
// Type checks
validationContext.When(person, p => p.Car)
.IsType<Ferrari>(typed => typed.Is(ferarriCar => ...Some Ferrari specific checks...))
.AddValidationDetail("You have Ferrari car, but ...");
Validation details
var validationDetails = validationContext
.When(person, p => p.Age)
// Validation check is failed, validation condition is valid
.Is(() => false)
.AddValidationDetail("Age must be set");
// Use deconstruction
var (key, message) = validationContext
.When(person, p => p.Age)
.IsNull()
.AddValidationDetail("Age must be set");
// More deconstruction
var (key, message, isValid) = validationContext
.When(person, p => p.Age)
.IsNull()
.AddValidationDetail("Age must be set");
// Even more deconstruction!
var (key, message, isValid, severity) = validationContext
.When(person, p => p.Age)
.IsNull()
.AddValidationDetail("Age must be set");
Check validation
// Throw exception when details severity greater than ValidationContext.ValidationSeverity
validationContext.When(person, p => p.Address)
.IsNull()
.AddValidationFatal("Address is not presented!!!"); // If invalid throw ValidationConditionException
// Check if context is valid
validationContext.IsValid();
validationContext.EnsureIsValid(); // If invalid throw ValidationContextException
// Check concrete validation details
validationContext.IsValid(person, p => p.Age);
validationContext.IsNotValid(person, p => p.Age);
validationContext.EnsureIsValid(person, p => p.Age);
Compose and reuse validation rules with extensions
- Call is allocation free
- Static checks
// Extensions
public static void ValidateCustomer(this IValidationContext validationContext, Customer customer)
{
// Some checks
}
validationContext.ValidateCustomer(customer);
- Write your own middleware or validation components/validators on top of
IValidationContext
Validation part resolvers
ValidationPartResolver
is a delegate, trying to getstring
valdiation part fromMemberInfo
- Use built in resolvers with
ValidationPartResolvers
static class:Default
,DataMember
,PascalCase
,CamelCase
// Configure DataMember validation part resolver
services.AddValidation(options =>
options.WithValidationPartResolver(ValidationPartResolvers.DataMember));
// Override validation parts with `DataMemberAttribute`
[DataMember(Name = "name")]
public string Name { get; set; }
Validation scopes
- Use scopes when you need to have:
- Same nested validation path multiple times
- Empty validation details collection (syncing with parent context/scope)
- ValidationSeverity override
// Validation key will be `Child.*ValidationPart*`
ValidateChild(validationContext.CreateScope(parent, p => p.Child))
// Validation key will be `Address.Locations[0].*ValidationPart*`
ValidateLocation(validationContext.CreateScope(person, p => p.Address.Locations[0]))
// Override local scope ValidationSeverity
using (var scope = validationContext.CreateScope(person, p => p.Address, ValidationSeverity.Warning))
{
// Some scope validation checks syncing with validationContext
}
High performance with non-expression constructions
validationContext.When("key", value)
.IsNull()
.AddValidationDetail("Value is null");
validationContext.CreateScope("key", ValidationSeverity.Warning);
validationContext.IsValid("key");
validationContext.IsNotValid("key");
validationContext.EnsureIsValid("key");
Phema.Validation
A simple, lightweight, fluent and extensible validation library for .NET Core
Installation
$> dotnet add package Phema.Validation
Core concepts
IValidationContext
- Scoped service to store all validation detailsIValidationCondition
- Contains a validation checks (e.g.Is(() => ...)
)IValidationDetail
- WhenIValidationCondition
is not valid adds toIValidationContext.ValidationDetails
ValidationSeverity
- Validation error level, used inIValidationContext.ValidationSeverity
andIValidationDetail.ValidationSeverity
IValidationScope
- Is a nested validation context with validation path and severity override
Usage (ASP.NET Core, HostedService examples)
// Add `IValidationContext` as scoped service
services.AddValidation(options => ...);
// Get or inject
var validationContext = serviceProvider.GetRequiredService<IValidationContext>();
// Validation key will be `Name` using default validation part provider
validationContext.When(person, p => p.Name)
.Is(name => name == null)
.AddValidationDetail("Name must be set");
// Validation key will be `Address.Locations[0].Latitude` using default validation part provider
validationContext.When(person, p => p.Address.Locations[0].Latitude)
.Is(latitude => ...custom check...)
.AddValidationDetail("Some custom check failed");
Validation conditions
- Monads are not composable, so
Is
andIsNot
,IsNull
andIsNotNull
... duplication
// Check for Phema.Validation.Conditions namespace
validationContext.When(person, p => p.Name)
.IsNullOrWhitespace()
.AddValidationDetail("Name must be set");
// Use multiple conditions (joined with AND)
validationContext.When(person, p => p.Name)
.IsNotNull()
// AND
.HasLengthGreater(20)
// .IsNull()
// .IsEqual()
// .IsNotUrl()
// .IsNotEmail()
// .IsMatch(regex)
.AddValidationDetail("Name should be less than 20");
// DateTime conditions
validationContext.When(task, t => t.DueDate)
.IsNotUtc()
.AddValidationDetail("Due date must be in Utc");
// Type checks
validationContext.When(person, p => p.Car)
.IsType<Ferrari>(typed => typed.Is(ferarriCar => ...Some Ferrari specific checks...))
.AddValidationDetail("You have Ferrari car, but ...");
Validation details
var validationDetails = validationContext
.When(person, p => p.Age)
// Validation check is failed, validation condition is valid
.Is(() => false)
.AddValidationDetail("Age must be set");
// Use deconstruction
var (key, message) = validationContext
.When(person, p => p.Age)
.IsNull()
.AddValidationDetail("Age must be set");
// More deconstruction
var (key, message, isValid) = validationContext
.When(person, p => p.Age)
.IsNull()
.AddValidationDetail("Age must be set");
// Even more deconstruction!
var (key, message, isValid, severity) = validationContext
.When(person, p => p.Age)
.IsNull()
.AddValidationDetail("Age must be set");
Check validation
// Throw exception when details severity greater than ValidationContext.ValidationSeverity
validationContext.When(person, p => p.Address)
.IsNull()
.AddValidationFatal("Address is not presented!!!"); // If invalid throw ValidationConditionException
// Check if context is valid
validationContext.IsValid();
validationContext.EnsureIsValid(); // If invalid throw ValidationContextException
// Check concrete validation details
validationContext.IsValid(person, p => p.Age);
validationContext.IsNotValid(person, p => p.Age);
validationContext.EnsureIsValid(person, p => p.Age);
Compose and reuse validation rules with extensions
- Call is allocation free
- Static checks
// Extensions
public static void ValidateCustomer(this IValidationContext validationContext, Customer customer)
{
// Some checks
}
validationContext.ValidateCustomer(customer);
- Write your own middleware or validation components/validators on top of
IValidationContext
Validation part resolvers
ValidationPartResolver
is a delegate, trying to getstring
valdiation part fromMemberInfo
- Use built in resolvers with
ValidationPartResolvers
static class:Default
,DataMember
,PascalCase
,CamelCase
// Configure DataMember validation part resolver
services.AddValidation(options =>
options.WithValidationPartResolver(ValidationPartResolvers.DataMember));
// Override validation parts with `DataMemberAttribute`
[DataMember(Name = "name")]
public string Name { get; set; }
Validation scopes
- Use scopes when you need to have:
- Same nested validation path multiple times
- Empty validation details collection (syncing with parent context/scope)
- ValidationSeverity override
// Validation key will be `Child.*ValidationPart*`
ValidateChild(validationContext.CreateScope(parent, p => p.Child))
// Validation key will be `Address.Locations[0].*ValidationPart*`
ValidateLocation(validationContext.CreateScope(person, p => p.Address.Locations[0]))
// Override local scope ValidationSeverity
using (var scope = validationContext.CreateScope(person, p => p.Address, ValidationSeverity.Warning))
{
// Some scope validation checks syncing with validationContext
}
High performance with non-expression constructions
validationContext.When("key", value)
.IsNull()
.AddValidationDetail("Value is null");
validationContext.CreateScope("key", ValidationSeverity.Warning);
validationContext.IsValid("key");
validationContext.IsNotValid("key");
validationContext.EnsureIsValid("key");
Dependencies
-
.NETStandard 2.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 3.0.0)
- Microsoft.Extensions.Options (>= 3.0.0)
Used By
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version History
Version | Downloads | Last updated |
---|---|---|
3.1.10 | 217 | 10/12/2019 |
3.1.9 | 284 | 9/27/2019 |
3.1.8 | 253 | 9/25/2019 |
3.1.7 | 205 | 9/15/2019 |
3.1.6 | 169 | 9/8/2019 |
3.1.5 | 151 | 9/7/2019 |
3.1.4 | 152 | 9/7/2019 |
3.1.3 | 172 | 9/7/2019 |
3.1.2 | 151 | 8/25/2019 |
3.1.1 | 150 | 8/24/2019 |
3.1.0 | 151 | 8/23/2019 |
3.0.9 | 151 | 8/23/2019 |
3.0.8 | 153 | 8/22/2019 |
3.0.7 | 158 | 8/16/2019 |
3.0.6 | 147 | 7/30/2019 |
3.0.5 | 151 | 7/29/2019 |
3.0.4 | 154 | 7/29/2019 |
3.0.3 | 152 | 7/28/2019 |
3.0.2 | 151 | 7/21/2019 |