How to implement Custom Model Validator in .NET Core

Question

I need to implement custom Model Validator in .NET Core project. I need to do complex validation so I am avoiding Attribute validation. I used

public class UserModel : IValidatableObject {
    public int UserId { get; set; }
    public string UserName { get; set; }
    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {

    }
}

But I need to separate Validation logic from Model So I found this in ASP.NET MVC -

public class ProjectModelValidatorProvider : ModelValidatorProvider {
    public override IEnumerable<ModelValidator> 
        GetValidators(ModelMetadata metadata, ControllerContext context) {
            if (metadata.ModelType == typeof(User))
                yield return new UserModelValidator(metadata, context);
    }
}

public class UserModelValidator : ModelValidator {
    public UserModelValidator(ModelMetadata metadata, ControllerContext controllerContext)
    : base(metadata, controllerContext) { }

    public override IEnumerable<ModelValidationResult> Validate(object container) {
    var model = (User)Metadata.Model;
    if (string.IsNullOrEmpty(model.Login))
        yield return new ModelValidationResult { 
            MemberName = "Login", 
            Message = "Please specify Login" 
        };


    }
}

// register your Provider
ModelValidatorProviders.Providers.Add(new ProjectModelValidatorProvider());

With the help of ModelValidatorProvider and ModelValidator I achieved it. But how to achieve this in .NET Core such that with ModelState.IsValid I will be able to validate the model ?

Xueli Chen · Accepted Answer · 2019-09-05 09:48:04Z

4

In ASP.NET Core , you could customize a class that inherits IModelValidatorProvider interface like below :

public class CustomModelValidatorProvider : IModelValidatorProvider
{
    public void CreateValidators(ModelValidatorProviderContext context)
    {
        if (context.ModelMetadata.ContainerType == typeof(User))
        {
            context.Results.Add(new ValidatorItem
            {
                Validator = new UserModelValidator(),
                IsReusable = true
            });
        }
    }
}

public class UserModelValidator : IModelValidator
{
    private static readonly object _emptyValidationContextInstance = new object();
    public IEnumerable<ModelValidationResult> Validate(ModelValidationContext validationContext)
    {
        var validationResults = new List<ModelValidationResult>();


        if (validationContext.ModelMetadata.Name == "FirstName" && validationContext.Model == null)
        {
            var validationResult = new ModelValidationResult("", "FirstName is required");

            validationResults.Add(validationResult);

        }
        return validationResults;
    }
}

You could also add partial keyword in your model to separate Validation logic from Model , refer to following code:

public partial class User
{
    public int Id { get; set; }

    public string Gender { get; set; }

    [MaxLength(10)]
    public string FirstName { get; set; }

    [MaxLength(30)]
    public string LastName { get; set; }

    [EmailAddress]
    public string Email { get; set; }

    public List<UserGroups> UserGroups { get; set; }
    public List<Referal> Referals { get; set; }

}

public partial class User : IValidatableObject
{
    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        if (string.IsNullOrEmpty(FirstName))
        {
            yield return new ValidationResult("FirstName is Required", new[] { "FirstName" });
        }
    }
}

answered Sep 5, 2019 at 9:48

Xueli Chen

12.7k3 gold badges28 silver badges39 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

artista_14 Over a year ago

I am trying to implement 1st suggestion. Is there any way to inject repository inside ModelValidator ? I registered modelvalidatorprovider in services.AddMvc(options => { options.ModelValidatorProviders.Add(new ModelValidatorProvider()); })

Rahul Jha Over a year ago

@artista_14 services.AddScoped<IModelValidatorProvider, ModelValidatorProvider>(); services.AddMvc(options => { options.ModelValidatorProviders. Add(services.BuildServiceProvider().GetService<IModelValidatorProvider>() ); }).SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

kang · Accepted Answer · 2020-07-30 05:23:10Z

0

I tried to use the first method.But user class [MaxLength(10)] attribute No more work. The effect I want to achieve is that it can be controlled by attributes.After passing, you can go to custom verification.

edited Jul 30, 2020 at 5:23

user10539074

answered Jul 30, 2020 at 3:34

kang

396 bronze badges

2 Comments

artista_14 Over a year ago

if u will use custom validators, attributes will not work. You have to write all validations explicitly.

kang Over a year ago

@artista_14 I tried to read some fields of the ValidationContext class.Found a property that can be read to the attribute.I'm trying to trigger model validation manually.This seems to work.

Collectives™ on Stack Overflow

How to implement Custom Model Validator in .NET Core

2 Answers 2

2 Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related