理解 ASP.NET Web API 中的 HttpParameterBinding

背景

　　问题的起因是这样的。群里面一个哥们儿发现在使用 ASP.NET WebAPI 时，不能在同一个方法签名中使用多次 FromBodyAttribute 这个 Attribute 。正好我也在用 WebAPI，不过我还没有这种需求。所以就打算研究一下。

 

异常信息

　　当使用多个 FromBodyAttribute 时，会收到下面的异常信息：

{
  "Message": "An error has occurred.",
  "ExceptionMessage": "Can't bind multiple parameters ('a' and 'b') to the request's content.",
  "ExceptionType": "System.InvalidOperationException",
  "StackTrace": "   在 System.Web.Http.Controllers.HttpActionBinding.ExecuteBindingAsync(HttpActionContext actionContext, CancellationToken cancellationToken)\r\n   在 System.Web.Http.Controllers.ActionFilterResult.<ExecuteAsync>d__2.MoveNext()\r\n--- 引发异常的上一位置中堆栈跟踪的末尾 ---\r\n   在 System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)\r\n   在 System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   在 System.Web.Http.Dispatcher.HttpControllerDispatcher.<SendAsync>d__1.MoveNext()"
}

意思就是不能参数 a 和 b 绑定到当前请求。

 

源代码追踪

　　通过异常信息可以发现是在 HttpActionBinding 这个类里面抛出了这个异常。立马去源代码中找这个类。下面是源代码：

通过 1，2，3 这三个点，发现是参数绑定类里面的验证失败。接着看了 HttpParameterBinding 是个抽象类。没有看到太多可用信息。去 FromBodyAttribute 里面看看有没有什么可用信息。

发现这里需要提供一个 HttpParameterBinding 的实例。从箭头标记的方法根进去接着看。

　　这里可以看到返回了一个 FormatterParameterBinding 的实例。并且需要三个参数。

• parameter：从命名可以看出来是参数描述信息；
• formatters：这个应该比较熟悉了，是格式化器；
• bodyModelValidator：这个是对应参数的验证器；

　　以上三个参数的意义基本就是看命名+大概阅读源代码得到的（所以写代码，命名很重要）。接着进入 FormatterParameterBinding 的源代码。这个类里面的代码也就 100 多行，逻辑就是从 HttpContent 中读取内容并设置为当前参数的值。

　　到了这儿算是理清了一点：原来在参数上打的这些 Attribute 都是从 ParameterBindingAttribute 继承的，又通过实现 GetBinding(HttpParameterDescriptor parameter); 方法将请求的参数与方法的参数进行绑定。

　　但是，在哪儿标记了不能使用多个 FromBodyAttribute 呢？既然是在 HttpActionBinding 中进行的验证，那就顺着 HttpActionBinding 往上找。通过 HttpActionBinding 的构造函数，发现只有 DefaultActionValueBinder 调用了它。接着往下看，看谁使用了这个 new 出来的实例。紧挨着就看到了 EnsureOneBodyParameter 这个方法，有点儿可疑，进去看一下。

　　

　　这个地方的 WillReadBody 如果为 true 并且 idxFromBody 大于 0 ，就会给 ParameterBinding 设置错误消息。看了一下消息内容，就是最上面的异常消息的模板。到这里应该算是找到根儿上了。

　　现在来梳理一下：也就是说 HttpParameterBinding 的 WillReadBody 如果返回 true 就不能在一个方法的签名中使用多次，一旦使用多次，就会把这个错误。刚才上面看到的 FormatterParameterBinding 里面的 WillReadBody 是直接返回的 true ，而且是只读的，并且在执行绑定时是直接读取的 HttpContent 的内容，设置为当前参数的值了。假如要执行的 action 的方法签名中有多个参数就绑定不成功了。

 

定制开发

　　知道了这个原理，那么想在一个有多个参数的 action 中进行参数的灵活绑定，就有了办法。分两步走：

1. 自定义一个 Attribute 从 ParameterBindingAttribute 继承；
2. 自定义一个 ParameterBinding 从 HttpParameterBinding 继承；在 ExecuteBindingAsync 方法中绑定 action 的参数的值。并把这个自定义的类的 WillReadBody 设置为 false 。