验证模型发送到 Web API 控制器

Question

在对 Web API 服务的调用中，我需要将以下类属性发送到其控制器方法：

public class FindBookingRequestModel 
{
    public string ReservationNumber { get; set; }
    public string CreditCardNumber { get; set; }
    public string EmailAddress { get; set; }
    public string Origin { get; set; }
    public string Destination { get; set; }
    public DateTime? StartDate { get; set; }
}

每个用例，我需要验证发送到 Web api 控制器的模型并确保填充以下类属性的三个场景，否则我需要抛出 BadRequest 异常。

1. 用例：

   {
       "ReservationNumber": "WERTSDFFSDF",
       "CreditCardNumber" : "3333"
   }   
   

2. 用例

   {
       "ReservationNumber" : "WERTSDFFSDF",
       "EmailAddress" : "somene@gmail",
       "Origin" : "FRA",
       "Destination" : "MUN"
   }
   

3. 用例

   {
       "StartDate" : "2015-12-15",
       "EmailAddress" : "somene@gmail",
       "Origin" : "FRA",
       "Destination" : "MUN"
   }
   

所以如果我们将此模型发送到控制器应该是错误的：

{
    "ReservationNumber": "WERTSDFFSDF",
    "Origin" : "FRA",
} 

或者这个：

{
    "EmailAddress" : "somene@gmail",
     "StartDate" : "2015-12-15",
}

确保按照上述用例传递字段的最有效方法是什么？

Answer 1

您可以实现IValidatableObject 来执行跨属性验证，可能也值得考虑单个属性值验证。

我建议在可能的情况下对属性值使用正则表达式（它们只会在属性值不为 null 时运行，因为您没有所有有效类型的任何必填字段，请避免使用 [Required] 属性）和然后使用Validate 方法进行跨属性验证：

public class FindBookingRequestModel : IValidatableObject
{
    [RegularExpression("[A-Z]+")]
    public string ReservationNumber { get; set; }

    [RegularExpression("...")] // Find a regex online
    public string CreditCardNumber { get; set; }

    [RegularExpression("...")] // Find a regex online
    public string EmailAddress { get; set; }

    [RegularExpression("[A-Z]{3}")]
    public string Origin { get; set; }

    [RegularExpression("[A-Z]{3}")]
    public string Destination { get; set; }

    public DateTime? StartDate { get; set; }

    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        if (!string.IsNullOrWhiteSpace(this.ReservationNumber) 
            && !string.IsNullOrWhiteSpace(this.Origin))
        {
            yield return new ValidationResult(
                "You cannot search using Reservation Number and Origin", 
                new[] { "ReservationNumber", "Origin" });
        }

        if (!string.IsNullOrWhiteSpace(this.EmailAddress) 
            && this.StartDate != null)
        {
            yield return new ValidationResult(
                "You cannot search using Email Address and Start Date", 
                new[] { "EmailAddress", "StartDate" });
        }

        yield break;
    }
}

如果无效组合太多，您可以这样做：

    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        if (!string.IsNullOrWhiteSpace(this.ReservationNumber) 
            && !string.IsNullOrWhiteSpace(this.CreditCardNumber)
            && this.EmailAddress == null
            && this.Origin == null
            && this.Destination == null
            && this.StartDate == null)
        {
            // OK - Only reservation number and credit card number specified
            yield break;
        }

        /// ...

        yield return new ValidationResult(
            "Invalid combination of search terms");
    }