是否有一种开箱即用的方式将 HTTP 请求的整个主体绑定到 ASP.NET Core 控制器操作中的字符串参数？

Question

概括

给定一个带有字符串主体“hamburger”的 HTTP 请求
我希望能够将请求的整个主体绑定到控制器操作方法签名中的字符串参数。

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

控制器

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://docs.microsoft.com/en-us/aspnet/core/test/integration-tests?view=aspnetcore-3.1设置的。 我在操作方法签名中使用POCO模型的其他控制器操作是可以访问的，所以我知道我尝试进行模型绑定的方式有问题。

编辑：我尝试过的事情：

• 将 [FromBody] 添加到参数 => 415 不支持的媒体类型
• 从控制器中删除 [ApiController] => 动作被命中但主体为空
• 将 [FromBody] 添加到参数并从控制器中移除 [ApiController] => 415 Unsupported Media type
• 将 [Consumes("text/plain")] 添加到不带 [ApiController] 和不带 [FromBody] 的动作
• 发送内容类型为 application/json 的请求，具有上述任何组合 => 错误或空值，具体取决于选项

令我惊讶的是 string 不是支持的原语之一

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;
}