jquery - 通过 jquery $.ajax 发布时的 ASP.NET MVC 验证框架？

Question

有很多非常好的帖子和解释如何使用 ASP.NET MVC 实现验证，我更喜欢其中之一:

• xVal
• Validation with Service layer
• Data Annotation attributes

但是，我真的很喜欢通过 jquery $.ajax 方法调用 ActionMethods。我想使用 $.ajax 的原因之一是因为会有很多部分 View 通过 $.ajax 调用动态加载到页面中(甚至是用于实体创建的表单)，而我不能只返回 View -我将丢失所有动态加载的内容。

为了让您更好地了解问题，我将发布一些简单的代码来解释我如何调用 Controller 操作并处理客户端 jquery 代码中的响应。

Controller 的ActionMethod:

    public ActionResult CreateCustomer(string name, string accountNumber)
    {
        try
        {
            CustomerService.InsertCustomer(name, accountNumber);

            return Json(new ActionInfo()
            {
                Success = true,
                Message = "Customer Is Successfully Created"
            });

        }
        catch (Exception ex)
        {
            return Json(new ActionInfo()
            {
                Success = false,
                Message = ex.Message
            });
        }
    }

客户端代码中的调用和处理:

$.ajax({
type: "POST",
url: $form.attr('action'),// /MyController/CreateCustomer
data: $form.serialize(),
error: HandleUnespectedError,
dataType: "json",
success: function(response) {

    if (response.Success)
        alert("Success: " + response.Message);
    else
        alert("Error: " + response.Message);
}});

有没有一个好的方法可以让其中一些验证框架按照我需要的方式工作？我知道我可以在 ActionInfo 中添加验证错误，然后在客户端中处理它，但这会我相信，这已经是我的一个验证的建筑。

Answer 1

我通过 AJAX 使用数据注释属性进行验证取得了巨大成功。为了检查数据的有效性，您需要使用 Controller 的 ModelState 属性，该属性有一个名为 IsValid 的自己的属性。我强烈建议看一下 data annotations validation attributes tutorial来自官方 ASP.NET MVC 站点。

首先，您需要修改 Controller 操作以接受模型对象作为参数，而不是单独的名称和帐号。这将使执行验证变得更加简单，我将在下面演示这一点。从您的示例来看，我最好的猜测是您的模型对象是或将被称为“客户”。您可能有以下代码来定义模型对象和 Controller 操作...

// model object
public class Customer
{
  public Int32 Id {get; set;}
  public String Name {get; set;}
  public String AccountNumber {get; set;}
}

// controller
public class CustomerController : Controller
{
  public ActionResult CreateCustomer( [Bind(Exclude = "Id")] Customer customer )
  {
     // controller action code
  }
}

确保表单字段的命名与 Customer 对象的属性名称相匹配，以便 ASP.NET MVC 可以自动绑定(bind)它们。在本例中，“Bind”属性告诉 ASP.NET MVC 在将表单字段绑定(bind)到模型属性时忽略 Customer 类的“Id”属性。由于这是一个新客户，我们还没有 Id，因此我们可以安全地将 Id 保留为默认值，并让数据层确定如何最好地生成它。

一旦 Controller 为操作方法构造了模型对象，就可以通过 ModelState.IsValid 属性轻松检查其有效性。正如人们所期望的，如果模型属性有效，它将返回 true，如果 1 个或多个属性无效，它将返回 false。

从最初的问题来看，当验证失败时，CustomerService.InsertCustomer 方法似乎会引发异常。这是完全没有必要的。 InsertCustomer 应该只需要执行插入新记录所需的任何数据操作。除非您希望抽象实现特定的异常(例如 SqlException)，否则 InsertCustomer 不应该真正需要捕获或抛出任何异常，但很可能只是让任何异常冒泡到 Controller (或调用者可能是谁)。

所有这一切的最终结果可能是如下所示的 Controller 操作:

public ActionResult CreateCustomer( [Bind(Exclude = "Id")] Customer customer )
{
  // model is invalid
  if (!ModelState.IsValid)
  {
    return Json(new ActionInfo()
    {
      Success = false,
      Message = "Validation failed" // you will probably want a more robust message :-)
    });
  }

  // service method accepts a Customer object rather than arbitrary strings  
  CustomerService.InsertCustomer(customer);

  return Json(new ActionInfo()
  {
    Success = true,
    Message = "Customer created successfully."
  });

}

如果您想报告意外错误，例如与数据库相关的异常，那么您当然可以在对 InsertCustomer 的调用周围添加一个 try/catch block ，并返回将错误消息显示回客户端所需的结果。