Asp.Net Web API 2第十五课——Model Validation(模型验证)

前言

当客户端发送数据给你的Web API时，你通常希望在做其它处理之前先对数据进行验证。

Data Annotations——数据注解

 在ASP.NET Web API中，你可以使用System.ComponentModel.DataAnnotations命名空间的注解属性来设置模型属性的验证规则。考虑以下模型：

如果你曾在ASP.NET MVC中使用过模型验证，这看上去是类似的。Required注解属性说明Name属性必须不为空。Range注解属性说明Weight必须在0-999之间。

假设客户端发送了一个带有下列JSON表示的POST请求：

你可以看出，客户端并未包含被标记成required的Name属性。当Web API将该JSON转换成Product实例时，它会根据这些验证注解属性对Product进行验证。在控制器动作中，你可以检查该模型是否有效：

模型验证并不保证客户端数据是安全的。在应用程序的其它层面可能会需要附加验证（例如，数据层可能会强制外键约束）。

此处，客户端并未指定Price或Weight的值。JSON格式化器会将默认值（这里是零）赋给这些缺失的属性。

“Under-Posting（递交不足）”：当客户端遗漏了某些属性时，便会发生“Under-posting”。例如，假设客户端发送如下：

此时模型的状态是有效的，因为零是这些属性的有效值。这是否是一个问题取决于你所处的场景。例如，在一个更新操作中，你可能希望区分出“零”与“未设置”。为了强迫客户端要设置一个值，将该属性构造成nullable（可空的），并设置Required注解属性：

“Over-Posting（过份递交）”：客户端也可能发送比期望还多的数据。例如：

此处，JSON包含了Product模型中存在的属性（“Color”）。在这种情况下，JSON格式化器会简单地忽略该值（XML格式化器却不同）。若你的模型具有只读属性，Over-posting会产生问题。例如：

如果你不想让用户对IsAdmin属性进行更新，并将其提升给管理员。最安全的策略是使用一个与允许客户端发送严格匹配的模型类：

Handling Validation Errors——处理验证错误

 当验证失败时，Web API并不会自动地将错误返回给客户端。这取决于控制器动作对模型状态及响应进行适当的检查。

你也可以创建一个动作过滤器，以便在控制器动作被调用之前，检查模型的状态。以下代码演示了一个例子：

如果模型验证失败，此过滤器会返回一个含有验证错误的HTTP响应。在此情况下，不会调用控制器动作。

你可以将此过滤器全局性地运用于所有Web API控制器。在Application_Start方法中，将此过滤器添加到HttpConfiguration.Filters集合：

另一种可选办法是，通过将此过滤器作为注解属性进行添加，你可以将它运用于个别控制器或控制器动作：