使用System.ComponentModel.DataAnnotations验证字段数据正确性

在.NET MVC 中，当页面提交model到Action的时候，自动填充ModelState。使用ModelState.IsValid进行方便快捷的数据验证，其验证也是调用命名空间System.ComponentModel.DataAnnotations中的各种方法进行验证。但是使用非MVC架构时，就需要写很多if判断或者正则表达式，当有多个字段需要验证的的时候不知道有多少人和我一样很厌烦这种用if判断的方式。这里记录一个方法，使用System.ComponentModel.DataAnnotations来实现自己的验证model抛出相应的错误信息。
C#文档地址：System.ComponentModel.DataAnnotations

 

这里我们先实现一个Person类，里面包含几个简单的属性，然后指定几个Attribute

public class Person
{
    [Required(ErrorMessage = "{0} 必须填写")]
    [DisplayName("姓名")]
    public string Name { get; set; }

    [Required(ErrorMessage = "{0} 必须填写")]
    [RegularExpression(@"[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}", ErrorMessage = "邮件格式不正确")]
    public string Email { get; set; }

    [Required(ErrorMessage = "{0} 必须填写")]
    [Range(, , ErrorMessage = "超出范围")]
    public int Age { get; set; }

    [Required(ErrorMessage = "{0} 必须填写")]
    [StringLength(, MinimumLength = , ErrorMessage = "{0}输入长度不正确")]
    public string Phone { get; set; }

    [Required(ErrorMessage = "{0} 必须填写")]
    [Range(typeof(decimal), "1000.00", "2000.99")]
    public decimal Salary { get; set; }
}

然后实现一个ValidatetionHelper静态类,这里主要用到的是Validator.TryValidateObject方法。

public static class ValidatetionHelper
{
    public static ValidResult IsValid(object value)
    {
        ValidResult result = new ValidResult();
        try
        {
            var validationContext = new ValidationContext(value, null, null);
            var results = new List<ValidationResult>();
            var isValid = Validator.TryValidateObject(value, validationContext, results, true);

            if (!isValid)
            {
                result.IsVaild = false;
                result.ErrorMembers = new List<ErrorMember>();
                foreach (var item in results)
                {
                    result.ErrorMembers.Add(new ErrorMember()
                    {
                        ErrorMessage = item.ErrorMessage,
                        ErrorMemberName = item.MemberNames.FirstOrDefault()
                    });
                }
            }
            else
            {
                result.IsVaild = true;
            }
        }
        catch (Exception ex)
        {
            result.IsVaild = false;
            result.ErrorMembers = new List<ErrorMember>();
            result.ErrorMembers.Add(new ErrorMember()
            {
                ErrorMessage = ex.Message,
                ErrorMemberName = "Internal error"
            });
        }

        return result;
    }
}

其中需要的返回结果类

public class ValidResult
{
    public List<ErrorMember> ErrorMembers { get; set; }
    public bool IsVaild { get; set; }
}

public class ErrorMember
{
    public string ErrorMessage { get; set; }
    public string ErrorMemberName { get; set; }
}

实现一个测试代码，这里看到对应验证数据比使用多个if简洁很多，整个代码也十分美观。

static void Main(string[] args)
{
    Person person = new Person();
    person.Name = "";
    person.Email = "121 212 K";
    person.Phone = "";
    person.Salary = ;
    var result = ValidatetionHelper.IsValid(person);
    if (!result.IsVaild)
    {
        foreach (ErrorMember errorMember in result.ErrorMembers)
        {
            Console.WriteLine(errorMember.ErrorMemberName + "：" + errorMember.ErrorMessage);
        }
    }
    Console.Read();
}

通过测试，可以看到得到正确的验证结果。

后续有时间，把DisplayName给显示上去，那就更完美了。

参考：使用System.ComponentModel.DataAnnotations验证字段数据正确性