DataAnnotations“NotRequired”属性

时间:2012-05-23 14:49:06

标签: c# asp.net-mvc asp.net-mvc-3 data-annotations validationattribute

我的模型很复杂。

我的UserViewModel有几个属性,其中两个是HomePhoneWorkPhone。两种类型PhoneViewModel。在PhoneViewModel我有CountryCodeAreaCodeNumber所有字符串。我想将CountryCode设为可选,但AreaCodeNumber是强制性的。

这很有效。我的问题是,UserViewModel WorkPhone是强制性的,而HomePhone则不是。

通过在Require属性中设置任何属性,我是否可以在PhoneViewModel中放弃HomeWork attributs?

我试过这个:

[ValidateInput(false)]

但它仅适用于类和方法。

代码:

public class UserViewModel
{
    [Required]
    public string Name { get; set; }

    public PhoneViewModel HomePhone { get; set; }

    [Required]    
    public PhoneViewModel WorkPhone { get; set; }
}

public class PhoneViewModel
{
    public string CountryCode { get; set; }

    public string AreaCode { get; set; }

    [Required]
    public string Number { get; set; }
}

4 个答案:

答案 0 :(得分:5)

[2012年5月24日更新,以使想法更清晰]

我不确定这是正确的方法,但我认为你可以扩展这个概念,并可以创建一个更通用/可重用的方法。

在ASP.NET MVC中,验证发生在绑定阶段。将表单发布到服务器时,DefaultModelBinder是根据请求信息创建模型实例的表单,并将验证错误添加到ModelStateDictionary

在您的情况下,只要绑定发生在HomePhone验证将启动并且我认为我们无法通过创建自定义验证来做很多事情属性或类似的

我认为,当(isacode,countrycode和number或为空)形式中没有可用值时,我根本不会为HomePhone属性创建模型实例,当我们控制绑定时,我们控制验证,为此,我们必须创建一个自定义模型绑定器

自定义模型绑定器中,我们检查属性是否为HomePhone,并且表单是否包含其属性的任何值,如果不是,我们不绑定属性和验证HomePhone不会发生。简单来说,HomePhoneUserViewModel的值为空。

  public class CustomModelBinder : DefaultModelBinder
  {
      protected override void BindProperty(ControllerContext controllerContext, ModelBindingContext bindingContext, PropertyDescriptor propertyDescriptor)
      {
        if (propertyDescriptor.Name == "HomePhone")
        {
          var form = controllerContext.HttpContext.Request.Form;

          var countryCode = form["HomePhone.CountryCode"];
          var areaCode = form["HomePhone.AreaCode"];
          var number = form["HomePhone.Number"];

          if (string.IsNullOrEmpty(countryCode) && string.IsNullOrEmpty(areaCode) && string.IsNullOrEmpty(number))
            return;
        }

        base.BindProperty(controllerContext, bindingContext, propertyDescriptor);
      }
  }

最后,您必须在global.asax.cs中注册自定义模型绑定器。

  ModelBinders.Binders.Add(typeof(UserViewModel), new CustomModelBinder());

所以现在你有一个以UserViewModel为参数的动作

 [HttpPost]
 public Action Post(UserViewModel userViewModel)
 {

 }

我们的自定义模型活页夹发挥作用且形式不会为HomePhone发布 areacode,countrycode和number 的任何值,不会出现任何验证错误, userViewModel.HomePhone为空。如果表单至少发布了这些属性的任何一个值,那么HomePhone将按预期进行验证。

答案 1 :(得分:3)

我一直在使用这个动态注释的神奇的nuget:ExpressiveAnnotations

它允许您在

之前做一些不可能的事情
[AssertThat("ReturnDate >= Today()")]
public DateTime? ReturnDate { get; set; }

甚至

public bool GoAbroad { get; set; }
[RequiredIf("GoAbroad == true")]
public string PassportNumber { get; set; }

更新:在单元测试中编译注释以确保不存在错误

正如@diego所提到的,在字符串中编写代码可能会令人生畏,但以下是我用于单元测试查找编译错误的所有验证的内容。

namespace UnitTest
{
    public static class ExpressiveAnnotationTestHelpers
    {
        public static IEnumerable<ExpressiveAttribute> CompileExpressiveAttributes(this Type type)
        {
            var properties = type.GetProperties()
                .Where(p => Attribute.IsDefined(p, typeof(ExpressiveAttribute)));
            var attributes = new List<ExpressiveAttribute>();
            foreach (var prop in properties)
            {
                var attribs = prop.GetCustomAttributes<ExpressiveAttribute>().ToList();
                attribs.ForEach(x => x.Compile(prop.DeclaringType));
                attributes.AddRange(attribs);
            }
            return attributes;
        }
    }
    [TestClass]
    public class ExpressiveAnnotationTests
    {
        [TestMethod]
        public void CompileAnnotationsTest()
        {
            // ... or for all assemblies within current domain:
            var compiled = Assembly.Load("NamespaceOfEntitiesWithExpressiveAnnotations").GetTypes()
                .SelectMany(t => t.CompileExpressiveAttributes()).ToList();

            Console.WriteLine($"Total entities using Expressive Annotations: {compiled.Count}");

            foreach (var compileItem in compiled)
            {
                Console.WriteLine($"Expression: {compileItem.Expression}");
            }

            Assert.IsTrue(compiled.Count > 0);
        }


    }
}

答案 2 :(得分:2)

我不会选择modelBinder;我使用自定义ValidationAttribute:

public class UserViewModel
{
    [Required]
    public string Name { get; set; }

    public HomePhoneViewModel HomePhone { get; set; }

    public WorkPhoneViewModel WorkPhone { get; set; }
}

public class HomePhoneViewModel : PhoneViewModel 
{
}

public class WorkPhoneViewModel : PhoneViewModel 
{
}

public class PhoneViewModel 
{
    public string CountryCode { get; set; }

    public string AreaCode { get; set; }

    [CustomRequiredPhone]
    public string Number { get; set; }
}

然后:

[AttributeUsage(AttributeTargets.Property]
public class CustomRequiredPhone : ValidationAttribute
{
    protected override ValidationResult IsValid(object value, ValidationContext validationContext)
    {
        ValidationResult validationResult = null;

        // Check if Model is WorkphoneViewModel, if so, activate validation
        if (validationContext.ObjectInstance.GetType() == typeof(WorkPhoneViewModel)
         && string.IsNullOrWhiteSpace((string)value) == true)
        {
            this.ErrorMessage = "Phone is required";
            validationResult = new ValidationResult(this.ErrorMessage);
        }
        else
        {
            validationResult = ValidationResult.Success;
        }

        return validationResult;
    }
}

如果不清楚,我会提供解释,但我认为这是不言自明的。

答案 3 :(得分:1)

只是一些观察:如果绑定不仅仅是简单的归档,下面的代码就会出现问题。我有一个案例,在对象中有嵌套对象,它会跳过它,并且有些文件没有被绑定在嵌套对象中。

可能的解决方案是

protected override void BindProperty(ControllerContext controllerContext, ModelBindingContext bindingContext, PropertyDescriptor propertyDescriptor)
     {
         if (!propertyDescriptor.Attributes.OfType<RequiredAttribute>().Any())
         {
             var form = controllerContext.HttpContext.Request.Form;

             if (form.AllKeys.Where(k => k.StartsWith(string.Format(propertyDescriptor.Name, "."))).Count() > 0)
             {
                 if (form.AllKeys.Where(k => k.StartsWith(string.Format(propertyDescriptor.Name, "."))).All(
                         k => string.IsNullOrWhiteSpace(form[k])))
                     return;
             }
         }

         base.BindProperty(controllerContext, bindingContext, propertyDescriptor);
     }

非常感谢Altaf Khatri