是否有一种开箱即用的方法可以将 HTTP 请求的整个正文绑定到 ASP.NET Core 控制器操作中的字符串参数?

Question

摘要

给定一个带有字符串正文"汉堡包">
的 HTTP 请求我希望能够将请求的整个主体绑定到控制器操作的方法签名中的字符串参数。

通过向相对 URL 发出 HTTP 请求来调用此控制器时string-body-model-binding-example/get-body我收到错误并且从未调用该操作

控制器

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
namespace MyProject
{
[Route("string-body-model-binding-example")]
[ApiController]
public class ExampleController: ControllerBase
{
[HttpPut("get-body")]
public string GetRequestBody(string body)
{
return body;
}
}
}

集成测试演示问题

using FluentAssertions;
using System;
using System.Net.Http;
using System.Threading.Tasks;
using Xunit;
public class MyIntegrationTests : MyIntegrationTestBase
{
[Fact]
public async Task String_body_is_bound_to_the_actions_body_parameter()
{
var body = "hamburger";
var uri = "string-body-model-binding-example/get-body";
var request = new HttpRequestMessage(HttpMethod.Put, uri)
{
Content = new StringContent(body, Encoding.UTF8, "text/plain")
};
var result = await HttpClient.SendAsync(request); 
var responseBody = await result.Content.ReadAsStringAsync();
responseBody.Should().Be(body,
"The body should have been bound to the controller action's body parameter");
}
}

注意：在上面的测试示例中，HttpClient是使用Microsoft.AspNetCore.Mvc.Testing https://learn.microsoft.com/en-us/aspnet/core/test/integration-tests?view=aspnetcore-3.1 设置的。我在操作方法签名中使用 POCO 模型的其他控制器操作是可以访问的，因此我知道我尝试进行模型绑定的方式有问题。

编辑：我尝试过的事情：

• 将 [FromBody] 添加到参数 => 415 不支持的媒体类型
• 从控制器中删除 [ApiController] => 操作命中但正文为空
• 将 [FromBody] 添加到参数并从控制器中删除 [ApiController] => 415 不支持的媒体类型
• 将 [Consumptions("text/plain"(] 添加到 wout [ApiController] 和 wout [FromBody] 的操作中
• 使用应用程序/json 的内容类型发送请求，其中包含上述任何组合 => 错误或 null，具体取决于选项

令我惊讶的是，字符串不是支持的原语之一

Answer 1

不确定这是否可以通过框架实现，但您可以为此创建自定义模型绑定器

public class RawBodyModelBinder : IModelBinder
{
public async Task BindModelAsync(ModelBindingContext bindingContext)
{
using (var streamReader = new StreamReader(bindingContext.HttpContext.Request.Body))
{
string result = await streamReader.ReadToEndAsync();
bindingContext.Result = ModelBindingResult.Success(result);
}
}
}

并像这样使用它

[HttpPut("get-body")]
public string GetRequestBody([ModelBinder(typeof(RawBodyModelBinder))] string body)
{
return body;
}

或者，您可以使用IModelBinderProvider告诉框架以更优雅的方式使用模型绑定器。首先引入新BindingSource作为单例

public static class CustomBindingSources
{
public static BindingSource RawBody { get; } = new BindingSource("RawBod", "Raw Body", true, true);
}

并创建我们的[FromRawBody]属性

[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
public class FromRawBodyAttribute : Attribute, IBindingSourceMetadata
{
public BindingSource BindingSource => CustomBindingSources.RawBody;
}

框架以特殊方式处理IBindingSourceMetadata属性，并为我们获取其BindingSource值，以便可以在模型绑定器提供程序中使用。

然后创建IModelBinderProvider

public class RawBodyModelBinderProvider : IModelBinderProvider
{
public IModelBinder GetBinder(ModelBinderProviderContext context)
{
//use binder if parameter is string
//and FromRawBody specified
if (context.Metadata.ModelType == typeof(string) && 
context.BindingInfo.BindingSource == CustomBindingSources.RawBody)
{
return new RawBodyModelBinder();
}
return null;
}
}

在Startup中添加模型绑定提供程序

services
.AddMvc(options =>
{
options.ModelBinderProviders.Insert(0, new RawBodyModelBinderProvider());
//..
}

按如下方式使用它

[HttpPut("get-body")]
public string GetRequestBody([FromRawBody] string body)
{
return body;
}