web-dev-qa-db-ja.com

ASP.NET MVC:DataAnnotationによるカスタム検証

文字列型の4つのプロパティを持つモデルがあります。 StringLengthアノテーションを使用して、単一のプロパティの長さを検証できることを知っています。ただし、4つのプロパティを組み合わせた長さを検証したいと思います。

データ注釈でこれを行うMVCの方法は何ですか?

私はこれを求めています。なぜなら、MVCが初めてであり、独自のソリューションを作成する前に正しい方法でそれを実行したいからです。

104

カスタム検証属性を書くことができます:

public class CombinedMinLengthAttribute: ValidationAttribute
{
    public CombinedMinLengthAttribute(int minLength, params string[] propertyNames)
    {
        this.PropertyNames = propertyNames;
        this.MinLength = minLength;
    }

    public string[] PropertyNames { get; private set; }
    public int MinLength { get; private set; }

    protected override ValidationResult IsValid(object value, ValidationContext validationContext)
    {
        var properties = this.PropertyNames.Select(validationContext.ObjectType.GetProperty);
        var values = properties.Select(p => p.GetValue(validationContext.ObjectInstance, null)).OfType<string>();
        var totalLength = values.Sum(x => x.Length) + Convert.ToString(value).Length;
        if (totalLength < this.MinLength)
        {
            return new ValidationResult(this.FormatErrorMessage(validationContext.DisplayName));
        }
        return null;
    }
}

次に、ビューモデルを作成し、そのプロパティの1つをそれで装飾します。

public class MyViewModel
{
    [CombinedMinLength(20, "Bar", "Baz", ErrorMessage = "The combined minimum length of the Foo, Bar and Baz properties should be longer than 20")]
    public string Foo { get; set; }
    public string Bar { get; set; }
    public string Baz { get; set; }
}
166
Darin Dimitrov

自己検証モデル

モデルは、インターフェイスIValidatableObjectを実装する必要があります。検証コードをValidateメソッドに追加します。

public class MyModel : IValidatableObject
{
    public string Title { get; set; }
    public string Description { get; set; }

    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        if (Title == null)
            yield return new ValidationResult("*", new [] { nameof(Title) });

        if (Description == null)
            yield return new ValidationResult("*", new [] { nameof(Description) });
    }
}

注意してください:これはサーバー側検証です。クライアント側では機能しません。検証は、フォームの送信後にのみ実行されます。

86
Andrei

ExpressiveAnnotations はそのような可能性を与えます:

[Required]
[AssertThat("Length(FieldA) + Length(FieldB) + Length(FieldC) + Length(FieldD) > 50")]
public string FieldA { get; set; }
22
jwaliszko

背景:

モデルの検証は、受け取ったデータが有効で正しいことを確認して、このデータを使用してさらに処理を行うために必要です。アクションメソッドでモデルを検証できます。組み込みの検証属性は、Compare、Range、RegularExpression、Required、StringLengthです。ただし、組み込み属性以外の検証属性が必要なシナリオもあります。

カスタム検証属性

public class EmployeeModel 
{
    [Required]
    [UniqueEmailAddress]
    public string EmailAddress {get;set;}
    public string FirstName {get;set;}
    public string LastName {get;set;}
    public int OrganizationId {get;set;}
}

カスタム検証属性を作成するには、ValidationAttributeからこのクラスを派生させる必要があります。

public class UniqueEmailAddress : ValidationAttribute
{
    private IEmployeeRepository _employeeRepository;
    [Inject]
    public IEmployeeRepository EmployeeRepository
    {
        get { return _employeeRepository; }
        set
        {
            _employeeRepository = value;
        }
    }
    protected override ValidationResult IsValid(object value,
                        ValidationContext validationContext)
    {
        var model = (EmployeeModel)validationContext.ObjectInstance;
        if(model.Field1 == null){
            return new ValidationResult("Field1 is null");
        }
        if(model.Field2 == null){
            return new ValidationResult("Field2 is null");
        }
        if(model.Field3 == null){
            return new ValidationResult("Field3 is null");
        }
        return ValidationResult.Success;
    }
}

お役に立てれば。乾杯!

参考文献

9
Yasser

ダリンの答えを改善するには、少し短くすることができます。

public class UniqueFileName : ValidationAttribute
{
    private readonly NewsService _newsService = new NewsService();

    public override bool IsValid(object value)
    {
        if (value == null) { return false; }

        var file = (HttpPostedFile) value;

        return _newsService.IsFileNameUnique(file.FileName);
    }
}

モデル:

[UniqueFileName(ErrorMessage = "This file name is not unique.")]

エラーメッセージが必要であることに注意してください。そうでない場合、エラーは空になります。

8
Jamie

少し遅れて答えましたが、だれが検索していますか。これを行うには、データアノテーションで追加のプロパティを使用します。

public string foo { get; set; }
public string bar { get; set; }

[MinLength(20, ErrorMessage = "too short")]
public string foobar 
{ 
    get
    {
        return foo + bar;
    }
}

本当にそれだけです。検証エラーも特定の場所に表示したい場合は、ビューにこれを追加できます。

@Html.ValidationMessage("foobar", "your combined text is too short")

ローカライズを行う場合は、ビューでこれを行うと便利です。

お役に立てれば!

1
Leo Muller