ASP.NET MVC выборочная проверка нескольких полей

Question

Я разрабатываю аннотацию пользовательских данных ASP.NET MVC 5.2.3 для проверки в Visual Studio 2015. Для этого необходимо выполнить любое количество полей и убедиться, что, если у вас есть значение, все они должны иметь ценность; если все они пустые/пустые, все должно быть в порядке.

Несколько примеров помогли:

• ASP.NET MVC implement custom validator use IClientValidatable
• MVC Form Validation on Multiple Fields
• http://www.macaalay.com/2014/02/24/unobtrusive-client-and-server-side-age-validation-in-mvc-using-custom-data-annotations/

Однако, я не уверен, как это сделать на стороне клиента проверки, где у вас есть неизвестное количество проверяемых полей.

Как передать это клиенту, используя реализацию метода GetClientValidationRules() интерфейса IClientValidatable?

Также, как применить эту новую аннотацию данных к свойствам моей модели представления? Будет ли это выглядеть так?

[MultipleRequired("AppNumber", "UserId", /* more fields */), ErrorMessage = "Something..."] 
[DisplayName("App #")] 
public int AppNumber { get; set; } 

[DisplayName("User ID")] 
public int UserId { get; set; } 

Вот насколько я мог бы получить с MultipleRequiredAttribute пользовательского класса аннотаций данные:

public class MultipleRequiredAttribute : ValidationAttribute, IClientValidatable 
{ 
    private readonly string[] _fields; 
    public MultipleRequiredAttribute(params string[] fields) 
    { 
     _fields = fields; 
    } 

    protected override ValidationResult IsValid(object value, ValidationContext validationContext) 
    { 
     // If any field has value, then all must have value 
     var anyHasValue = _fields.Any(f => !string.IsNullOrEmpty(f)); 

     if (!anyHasValue) return null; 

     foreach (var field in _fields) 
     { 
      var property = validationContext.ObjectType.GetProperty(field); 
      if (property == null) 
       return new ValidationResult($"Property '{field}' is undefined."); 

      var fieldValue = property.GetValue(validationContext.ObjectInstance, null); 

      if (string.IsNullOrEmpty(fieldValue?.ToString())) 
       return new ValidationResult(FormatErrorMessage(validationContext.DisplayName)); 
     } 

     return null; 
    } 

    public IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context) 
    { 
     yield return new ModelClientValidationRule 
     { 
      ErrorMessage = ErrorMessage, 
      ValidationType = "multiplerequired" 
     }; 
    } 
} 

Спасибо.

Answer 1

Для того, чтобы получить подтверждение на стороне клиента, вам нужно передать значения «других свойств» в ModelClientValidationRule с помощью .Add() метода правил ValidationParameters свойств, а затем записать на стороне клиента сценарии для добавления правил $.validator.

Но сначала есть несколько других проблем, связанных с вашим атрибутом. Сначала вы должны выполнить цикл foreach, только если значение свойства, которое вы применили, это null. Во-вторых, возвращая ValidationResult, если одно из «других свойств» не существует, является путаным и бессмысленным для пользователя, и вы должны просто игнорировать его.

Код атрибута должен быть (заметьте, я изменил имя атрибута)

public class RequiredIfAnyAttribute : ValidationAttribute, IClientValidatable 
{ 
    private readonly string[] _otherProperties; 
    private const string _DefaultErrorMessage = "The {0} field is required"; 

    public RequiredIfAnyAttribute(params string[] otherProperties) 
    { 
     if (otherProperties.Length == 0) // would not make sense 
     { 
      throw new ArgumentException("At least one other property name must be provided"); 
     } 
     _otherProperties = otherProperties; 
     ErrorMessage = _DefaultErrorMessage; 
    } 

    protected override ValidationResult IsValid(object value, ValidationContext validationContext) 
    { 
     if (value == null) // no point checking if it has a value 
     { 
      foreach (string property in _otherProperties) 
      { 
       var propertyName = validationContext.ObjectType.GetProperty(property); 
       if (propertyName == null) 
       { 
        continue; 
       } 
       var propertyValue = propertyName.GetValue(validationContext.ObjectInstance, null); 
       if (propertyValue != null) 
       { 
        return new ValidationResult(FormatErrorMessage(validationContext.DisplayName)); 
       } 
      } 
     } 
     return ValidationResult.Success; 
    } 
    public IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context) 
    { 
     var rule = new ModelClientValidationRule 
     { 
      ValidationType = "requiredifany", 
      ErrorMessage = FormatErrorMessage(metadata.GetDisplayName()), 
     }; 
     /pass a comma separated list of the other propeties 
     rule.ValidationParameters.Add("otherproperties", string.Join(",", _otherProperties)); 
     yield return rule; 
    } 
} 

Сценарии затем будет

sandtrapValidation = { 
    getDependentElement: function (validationElement, dependentProperty) { 
     var dependentElement = $('#' + dependentProperty); 
     if (dependentElement.length === 1) { 
      return dependentElement; 
     } 
     var name = validationElement.name; 
     var index = name.lastIndexOf(".") + 1; 
     var id = (name.substr(0, index) + dependentProperty).replace(/[\.\[\]]/g, "_"); 
     dependentElement = $('#' + id); 
     if (dependentElement.length === 1) { 
      return dependentElement; 
     } 
     // Try using the name attribute 
     name = (name.substr(0, index) + dependentProperty); 
     dependentElement = $('[name="' + name + '"]'); 
     if (dependentElement.length > 0) { 
      return dependentElement.first(); 
     } 
     return null; 
    } 
} 

$.validator.unobtrusive.adapters.add("requiredifany", ["otherproperties"], function (options) { 
    var element = options.element; 
    var otherNames = options.params.otherproperties.split(','); 
    var otherProperties = []; 
    $.each(otherNames, function (index, item) { 
     otherProperties.push(sandtrapValidation.getDependentElement(element, item)) 
    }); 
    options.rules['requiredifany'] = { 
     otherproperties: otherProperties 
    }; 
    options.messages['requiredifany'] = options.message; 
}); 

$.validator.addMethod("requiredifany", function (value, element, params) { 
    if ($(element).val() != '') { 
     // The element has a value so its OK 
     return true; 
    } 
    var isValid = true; 
    $.each(params.otherproperties, function (index, item) { 
     if ($(this).val() != '') { 
      isValid = false; 
     } 
    }); 
    return isValid; 
});