[水煮 ASP.NET Web API2 方法论]（1-6）Model Validation

问题

想要 ASP.NET Web API 执行模型验证，同时可以和 ASP.NET MVC 共享一些验证逻辑。

解决方案

ASP.NET Web API 与 ASP.NET MVC 支持一样的验证机制，都是通过System.ComponentModel.DataAnnoataions 的属性验证。使用框架提供的相关验证属性，已足够来用来验证模型。

想要更细粒度的验证，我们可以选择在我们的模型中实现 IValudateObject（来自于System.ComponentModel.DataAnnotations）。如果所有的属性都验证通过，ASP.NET Web API 将会调用接口的Validate 方法，在这里我们可以进行更进一步的进行实体验证。这是和 MVC 里面的行为一样，并且，我们甚至可以在 Web API 和 MVC 中使用同一个 DTO。

还有另一种方法，就是可以使用一个叫做 FluentValidation（NuGet 中可以下载FluentValidation）的第三方程序库,他可以构建更强大的验证场景。在这样的情况下，我们仍然需在我们的模型中实现 IValidateObject 接口，同时需要依赖于FluentValidation 验证器，而不是内嵌的验证逻辑。

小提示 ASP.NET Web API 的验证行为在跨宿主机上是相同的。

工作原理

为了从 HTTP 请求 Body 中读取的模型并执行验证，ASP.NET Web API 依赖于一个 IBodyModelValidator 的服务。接口的大致描述如清单 1-17 所示，然而，他是一个可替代的服务，正常情况下，默认实现（DefaultBodyModelValidator）足够我们使用，在HttpConfiguration 被设置为自启动。

清单 1-17. IBodyModelValidator 接口


1

2

3

4

5

public interface IBodyModelValidator

{

    bool Validate(object model, Type type, ModelMetadataProvider metadataProvider,

    HttpActionContext actionContext, string keyPrefix);

}

有一个叫做FormatrtParameterBinding 的服务，在 HTTP 请求 Body 绑定到 Action 参数的处理请求时，DefaultBodyModelValidator 的 Validate 方法会被调用。对于验证程序，他会递归验证整个对象图谱，验证每一个属性以及嵌套属性。Web API 通过使用DataAnnotationModelValidatorProviderr 来支持声明。如果我们的模型使用WCF 方式的 DataMemberAttribute 声明，那么，我们需要使用框架的 DataMemberValidatorProvider。

最后，我们的模型可以实现IValidatableObject 接口，这个接口只暴露了一个简单的方法如清单1-18所示。如果实现了接口，那就需要我们自己提供额外的验证逻辑。只要所有的属性验证通过，ASP.NET Wwb API 就会调用IValidateableObject接口的 Validate 方法，

清单1-18. IValidateableObject 接口的定义


1

2

3

4

public interface IValidateableObject

{

    IEnumerable<ValidationResult> Validate(ValidationContext validationContext);

}

验证结果是通过 ASP.NET Web API 的  ModelStateDictionary 形式表示，在这里 ModelState 也是可以用的。这个和 ASP.NET MVC 中的概念是完全一样的，但是使用的对象是不同的，因为 Web API 使用自己版本的System.Web.Http.Modelbinding。ModelStateDictionary 暴露了IsValid 属性，这个属性可以用来检查 Action 内Model 验证的状态。

声明的验证机制也很好的整合到了 ASP.NET Web API Help Page，可以提供对 API 语义上的描述。我们将会在7-11 的时候详细讨论他。

小提示 在 API 中最好的做法是使用不同的模型作为 Request 和Response 实体。例如，实体 ID 一般仅仅是 Response 模型需要的，如果 Request 中需要的话，是可以从 URI 中拿到的。

代码

清单 1-19 展示了一个模型有多种验证的情况：

RequiredAttribute，MaxLengthAttribute 和

RangeAttribute。接下来，我们就可以利用 ModelState 来验证 Controller 中的验证状态，同时响应适当的提示信息给调用端。

清单 1-19. 简单的 Web API 模型验证


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

public class Album

{

    public int Id { get; set; }

    [Required(ErrorMessage = "{0} is required")]

    [MaxLength(30)]

    public string Artist { get; set; }

    [Required(ErrorMessage = "{0} is required")]

    [MaxLength(40)]

    public string Title { get; set; }

    [Range(0, 10, ErrorMessage = "{0} in the range of {1}-{2} is required.")]

    public int Rating { get; set; }

}

public class AlbumController : ApiController

{

    public HttpResponseMessage Post(Album album)

    {

        if (!ModelState.IsValid)

        {

            throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.BadRequest,

            ModelState));

        }

        //omitted for brevity

    }

}

负责处理 ModelState 代码的一般验证可以很容易从 Controller 提取到成公共的部分，使其可以被很好的重用，不过这一部分我们将在 5-4 的时候再详细介绍。

现在，我们考虑一下这个场景，如果我们要在模型上增加增加两个额外的属性 Rating 和 Starred，同时扩展模型验证，验证的要求是这两个属性至少有一个是必填的。虽然，在两个属性之间纠缠的验证很难使用声明的方式来表示，但是，不要忘记 IValidateableObject 可以帮我们。我们可以使用接口中的 Validata 的方法去检查整个模型的状态，同时返回相应的 ValidationResult。我们要做的修改如清单 1-20 所示的代码。

清单 1-20. 修改 ASP.NET Web API 依赖于 IValidateableObject 的验证


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

public class Album : IValidatableObject

{

    public int Id { get; set; }

 

    [Required(ErrorMessage = "{0} is required")]

    [MaxLength(30)]

    public string Artist { get; set; }

 

    [Required(ErrorMessage = "{0} is required")]

    [MaxLength(40)]

    public string Title { get; set; }

 

    public int? Rating { get; set; }

    public bool? Starred { get; set; }

 

    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)

    {

        if (!(Rating.HasValue && Rating > 0 && Rating < 10) || (Starred.HasValue && Starred.Value))

        {

            yield return new ValidationResult("You must set either the Rating in the 0-9 range orStarred flag.");

        }

    }

}
时间： 2024-10-09 20:00:07

[水煮 ASP.NET Web API2 方法论]（1-6）Model Validation的相关文章

[水煮 ASP.NET Web API2 方法论]（3-9）空气路由的设置

阅读导航 问题 解决方案 工作原理 代码演示 在此解释一下,空气路由,是本人臆想出来,觉着更能表达 IgnoreRoute 的意图,如果看着辣眼睛^^,请见谅. 问题 我们在之定义过集中式路由,集中式路由有一个特点就是短路,但是现在我们不想让某些路由工作(匹配并由路由引擎处理请求).那么我们应该怎么办呢? 解决方案 其实思路很简单,就是想把某些路由忽略了.ASP.NET WEB API 提供了一个叫做的 StopRoutingHandler 的处理器,简单说,他就是一个消息处理器,可以通过他来强

[水煮 ASP.NET Web API2 方法论]（1-5）ASP.NET Web API Scaffolding（模板）

问题 我们想快速启动一个 ASP.NET Web API 解决方案. 解决方案 APS.NET 模板一开始就支持 ASP.NET Web API.使用模板往我们的项目中添加 Controller,在我们解决方案的 Controllers 文件夹上右键,选择"添加"->"Scaffolding". 即用模式,可以从下面选择一个: Web API2 Controller Web API2 Controller with      actions, using En

[水煮 ASP.NET Web API2 方法论]（3-2）直接式路由/属性路由

问题 怎么样可以使用更贴近资源(Controller,Action)的方式定义路由. 解决方案 可以使用属性路由直接在资源级别声明路由.只要简单的在 Action 上使用属性路由 RouteAttribute,然后传一个相关路由模板就可以.属性路由与集中式路由在路由模板含义上基本是一样的,所有路由参数应该使用花括号,同时要与使用的 Action 相匹配.直接式路由支持默认路由,可选参数,约束.详细分析请往下走. 1 [Route("api/teams/{id}")] 2 public

[水煮 ASP.NET Web API2 方法论]（12-3）OData 查询

问题 Web API 怎么支持通用的 OData 系统查询项,例如 $select 或 $filter. 解决方案 为了在 Web API 中启用查询项,我们需要在 Action 上使用 EnableQueryAttribute. 如果 Action 没有返回集合,而是返回单个对象的实例,调用端仍然可以使用 $expand 和 $select 两个查询语句,要达到这个目的,我们必须将返回对象包装在 SingleResult<T> 中.集合和单个对象实例作为返回值的例子如订单 12-7 所示 清

[水煮 ASP.NET Web API2 方法论]（1-7）CSRF-Cross-Site Request Forgery

问题 通过 CSRF(Cross-Site Request Forgery)防护,保护从 MVC 页面提交到ASP.NET Web API 的数据. 解决方案 ASP.NET 已经加入了 CSRF 防护功能,只要通过 System.web.Helpers.AntiForgery 类(System.Web.WebPages 的一部分)就可以. 他会生成两个 Token: Cookie Token 基于字符串的 Token 基于字符串的 Token 是可以嵌入到表单或者请求头(使用 Ajax 的情况

[水煮 ASP.NET Web API2 方法论]（3-5）路由约束

问题 怎么样限制路由中参数的值. 解决方案 ASP.NET WEB API 允许我们通过 IHttpRouteConstraint 接口设置路由约束.集中式路由和直接式路由都可以使用 IHttpRouteConstraint. 框架提供了 18 个接口,他提供了大部分类型的约束,例如,路由参数长度相关的约束,可以确保值都在定义范围内,或者限制数据类型.当然也可以通过实现接口 IHttpRouteConstraint 来自定义约束逻辑. 工作原理 IHttpRoutConstraint 是一个 H

[水煮 ASP.NET Web API2 方法论]（3-4）设置路由可选项

问题 怎么样创建一个路由,不管客户端传不传这个参数,都可以被成功匹配. 解决方案 ASP.NET WEB API 的集中式路由和属性路由都支持路由声明可选参数. 在用集中式路由中可以通过 RouteParameter.Optional 指定一个可选参数,RouteParameter.Optional 等同于MVC 中的 UrlParameter.Option. 属性路由,通过在可选参数后面添加一个问好作为后缀.同时,必须为其指定默认值 工作原理 从根本上看,ASP.NET WEB API 支持的

[水煮 ASP.NET Web API2 方法论]（12-1）创建 OData

问题 怎样用在 Web API 中创建 OData 服务. 解决方案 对于我们来说,在 Web API 中使用 OData最简单的方式就是使用 ASP.NET 模板来创建Odata Controller.在 Controllers 文件夹上鼠标右键->添加->新建项. 显示一个如图 12-1 的对话框,在这里我们可以选择两个 "Web API 2 OData" 相关的模板.Vistual Studio 将会生成相关的 OData Controller,同时,从 NuGet

[水煮 ASP.NET Web API2 方法论]（1-4）从 MVC Controller 链接到 API Controller 以及反向链接

问题 想创建一个从 ASP.NET MVC controller 到 ASP.NET Web API controller 的直接链接,或者反向链接. 解决方案 可以使用 System.Web.Http.Routing.UrlHelp 的实例来创建一个指向 Controller的链接,来暴露ApiController(作为 Url 属性).着和在 RequestContext 上一样,会被附加到 HttpRequestMessage 实例.为了达到这个目的,我们需要调用链接方法或路由方法,然后传

[水煮 ASP.NET Web API2 方法论]（1-8）添加 Session 状态

问题 ASP.NET Web API 构建 Web 应用程序时,要求使用 Session 在服务器存储一些用户特定的信息 解决方案 ASP.NET Web API 不支持 Session,因为 API 根本不依赖于System.Web.他想试图摆脱伪造 Session,非 HTTP这样的概念. 然而,如果我们 在 ASP.NET 运行时中运行 ASP.NET Web API,还想启用 Session.我们可以通过两种方式来做: 全局:应用于整个 API 局部:应用于指定路由 启用全局方式,我们需