c# - 如何: Parameter binding from multiple sources

Question

目前我正在尝试创建一个基于 asp.net core 2.0 的 web api，我想创建一个嵌套路由。如果是放置请求，它会在路由中发送一部分信息，在正文中发送另一部分信息。

要求

需要调用的 url 是

https://localhost/api/v1/master/42/details

如果我们想在我们的 master 42 下面创建一个新的细节，我希望在 master 的 id 从路由中出来时在 body 中发送细节的数据。

curl -X POST --header 'Content-Type: application/json' \
--header 'Accept: application/json' \
-d '{ \ 
   "name": "My detail name", \ 
   "description": "Just some kind of information" \ 
 }' 'https://localhost/api/v1/master/42/details'

请求的输出响应将是

{
    "name": "My detail name",
    "description": "Just some kind of information",
    "masterId": 42,
    "id": 47
}

和响应 header 中的位置 url，如

{
    "location": "https://localhost/api/v1/master/42/details/47
}

到目前为止完成的工作

为了让它工作，我创建了这个 Controller :

[Produces("application/json")]
[Route("api/v1/master/{masterId:int}/details")]
public class MasterController : Controller
{
    [HttpPost]
    [Produces(typeof(DetailsResponse))]
    public async Task<IActionResult> Post([FromBody, FromRoute]DetailCreateRequest request)
    {
        if(!ModelState.IsValid)
            return BadRequest(ModelState);

        var response = await Do.Process(request);

        return CreatedAtAction(nameof(Get), new { id = response.Id }, response);
    }
}

它使用这些类:

public class DetailCreateRequest
{
    public int MasterId { get; set; }
    public string Name { get; set; }
    public string Description { get; set; }
}

public class DetailResponse
{
    public int Id { get; set; }
    public int MasterId { get; set; }
    public string Name { get; set; }
    public string Description { get; set; }
}

问题

到目前为止，大部分内容都按预期工作。唯一真正不起作用的是将路由中的 MasterId 合并到来自正文的 DetailCreateRequest 中。

首先尝试:在参数上使用两个属性

我试图通过这个 Action 调用将这两件事结合起来:

public async Task<IActionResult> Post([FromBody, FromRoute]DetailCreateRequest request)

但是传入对象只有一个 MasterId 为零。如果我更改这两个属性的顺序，那么只会采用路由中的 id，并且忽略正文中的所有值(因此似乎是第一个属性获胜)。

第二次尝试:在 Action 中使用两个不同的参数

我尝试的另一种方法是此操作调用:

public async Task<IActionResult> Post([FromRoute]int masterId, [FromBody]DetailCreateRequest request)

在第一个位置这看起来没问题，因为现在我在 Controller 操作中有两个值。但我对这种方法的最大问题是模型验证。正如你在上面的代码中看到的，我检查了 ModelState.IsValid，它是通过 FluentValidation 的一些检查填充的，但是这些检查不能真正完成，因为对象是'由于缺少主 ID 而正确构建。

(无效)想法:使用合并参数创建自己的属性

试图实现这样的东西:

public async Task<IActionResult> Post([FromMultiple(Merge.FromBody, Merge.FromRoute)]DetailCreateRequest request)

如果我们已经有了这样的东西，那就太好了。属性中参数的顺序将给出合并(以及可能的覆盖)发生的顺序。

我已经开始实现此属性并为所需的 IValueProvider 和 IValueProviderFactory 创建框架。但这似乎是相当多的工作。特别是找到所有漂亮的细节，使它能够与我正在使用的 asp.net 核心和其他库的整个管道无缝地工作(比如通过 swashbuckle 招摇过市)。

所以我的问题是，asp.net core 中是否已经存在某种机制来实现这样的合并，或者是否有人知道已经存在的解决方案或关于如何实现这种野兽的好例子。

到目前为止的解决方案:自定义 ModelBinder

从Merchezatter得到答案后我研究了如何创建 custom model binder并想出了这个实现:

public class MergeBodyAndValueProviderBinder : IModelBinder
{
    public Task BindModelAsync(ModelBindingContext bindingContext)
    {
        if (bindingContext == null)
            throw new ArgumentNullException(nameof(bindingContext));

        var body = bindingContext.HttpContext.Request.Body;
        var type = bindingContext.ModelMetadata.ModelType;
        var instance = TryCreateInstanceFromBody(body, type, out bool instanceChanged);
        var bindingFlags = BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic;
        var setters = type.GetProperties(bindingFlags).Where(property => property.CanWrite);

        foreach (var setter in setters)
        {
            var result = bindingContext.ValueProvider.GetValue(setter.Name);

            if (result != ValueProviderResult.None)
            {
                try
                {
                    var value = Convert.ChangeType(result.FirstValue, setter.PropertyType);
                    setter.SetMethod.Invoke(instance, new[] { value });
                    instanceChanged = true;
                }
                catch
                { }
            }
        }

        if (instanceChanged)
            bindingContext.Result = ModelBindingResult.Success(instance);

        return Task.CompletedTask;
    }

    private static object TryCreateInstanceFromBody(Stream body, Type type, out bool instanceChanged)
    {
        try
        {
            using (var reader = new StreamReader(body, Encoding.UTF8, false, 1024, true))
            {
                var data = reader.ReadToEnd();
                var instance = JsonConvert.DeserializeObject(data, type);
                instanceChanged = true;
                return instance;
            }
        }
        catch
        {
            instanceChanged = false;
            return Activator.CreateInstance(type);
        }
    }
}

它尝试将主体反序列化为所需的对象类型，然后尝试应用来自可用值提供者的更多值。为了让这个模型绑定(bind)器工作，我必须用 ModelBinderAttribute 装饰目标类并将 MasterId 设为内部，这样 swagger 就不会宣布它并且 JsonConvert 不会反序列化它:

[ModelBinder(BinderType = typeof(MergeBodyAndValueProviderBinder))]
public class DetailCreateRequest
{
    internal int MasterId { get; set; }
    public string Name { get; set; }
    public string Description { get; set; }
}

在我的 Controller 中， Action 方法参数仍然包含 [FromBody] 标志，因为 swagger 使用它来宣布如何调用该方法，但它永远不会被调用，因为我的模型 Binder 具有更高的优先级。

public async Task<IActionResult> Post([FromBody]DetailCreateRequest request)

所以它并不完美，但到目前为止效果很好。

Answer 1

这看起来是个正确的选择:

[HttpPost]
[Produces(typeof(DetailsResponse))]
public async Task<IActionResult> Post([FromRoute]int masterId, [FromBody]DetailCreateRequest request) {
    //...
}

但是如果您在域模型验证方面遇到一些问题，请创建不带主 ID 的自定义 Dto 对象。否则，您可以使用自定义模型绑定(bind)器，然后使用来自操作和绑定(bind)上下文的参数。