ASP.Net Core自定义JSON模型绑定器求助：解决参数绑定为null问题

我懂你遇到的麻烦了——你的请求JSON是一个外层包含emails数组的对象，但API方法直接接收Email[]类型的参数，默认模型绑定器没法识别这种嵌套结构，所以才会一直拿到null值。下面给你两种解决方案，其中包含你需要的自定义模型绑定器实现：

这是最简单的解决办法，不需要自定义绑定器，只需要创建一个包装类来匹配你的JSON结构：

// 定义匹配请求JSON结构的DTO
public class EmailRequest
{
    public Email[] Emails { get; set; }
}

然后修改你的API方法，接收这个DTO作为参数：

[HttpPost, Route("Send")]
public async Task<IActionResult> Send([FromBody] EmailRequest request)
{
    if (request?.Emails == null || request.Emails.Length == 0)
    {
        return BadRequest("No valid emails provided");
    }

    var toSave = request.Emails.Select(email => new EmailQueueItem
    {
        Html = true,
        To = email.To,
        Subject = email.Subject,
        Body = email.Body
    });

    await Database.BulkInsert(toSave.ToArray());
    return Ok();
}

这个方法直接利用默认模型绑定器的能力，代码改动最小，推荐优先考虑。

如果你必须保持API方法的参数是Email[]类型，那可以实现自定义模型绑定器来处理嵌套的JSON结构：

1. 创建自定义模型绑定器类 #

这个类负责读取请求体，解析出emails数组并绑定到参数：

using Microsoft.AspNetCore.Mvc.ModelBinding;
using System.Text.Json;
using System.Threading.Tasks;

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

        // 读取请求体的原始JSON内容
        using var reader = new StreamReader(bindingContext.HttpContext.Request.Body);
        var requestBody = await reader.ReadToEndAsync();

        if (string.IsNullOrEmpty(requestBody))
        {
            bindingContext.Result = ModelBindingResult.Failed();
            return;
        }

        try
        {
            // 解析JSON并提取emails数组
            var rootElement = JsonSerializer.Deserialize<JsonElement>(requestBody);
            if (rootElement.TryGetProperty("emails", out var emailsElement))
            {
                var emails = JsonSerializer.Deserialize<Email[]>(emailsElement.GetRawText());
                bindingContext.Result = ModelBindingResult.Success(emails);
            }
            else
            {
                bindingContext.ModelState.AddModelError(bindingContext.ModelName, "Missing 'emails' property in request");
                bindingContext.Result = ModelBindingResult.Failed();
            }
        }
        catch (JsonException ex)
        {
            bindingContext.ModelState.AddModelError(bindingContext.ModelName, $"Invalid JSON format: {ex.Message}");
            bindingContext.Result = ModelBindingResult.Failed();
        }
    }
}

2. 创建模型绑定器提供器 #

这个类告诉ASP.NET什么时候使用我们的自定义绑定器：

using Microsoft.AspNetCore.Mvc.ModelBinding;
using Microsoft.AspNetCore.Mvc.ModelBinding.Binders;

public class EmailArrayModelBinderProvider : IModelBinderProvider
{
    public IModelBinder GetBinder(ModelBinderProviderContext context)
    {
        if (context == null)
            throw new ArgumentNullException(nameof(context));

        // 当参数类型是Email[]时，使用自定义绑定器
        if (context.Metadata.ModelType == typeof(Email[]))
        {
            return new BinderTypeModelBinder(typeof(EmailArrayModelBinder));
        }

        return null;
    }
}

3. 注册绑定器提供器 #

在项目的配置文件中（.NET 6+用Program.cs，旧版本用Startup.cs）注册这个提供器：

.NET 6+ Program.cs #

builder.Services.AddControllers(options =>
{
    // 把自定义提供器插入到最前面，确保优先被使用
    options.ModelBinderProviders.Insert(0, new EmailArrayModelBinderProvider());
});

旧版本 Startup.cs #

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers(options =>
    {
        options.ModelBinderProviders.Insert(0, new EmailArrayModelBinderProvider());
    });
}

4. 修改API方法（可选） #

你可以在参数上加上[ModelBinder]属性明确指定使用自定义绑定器，或者依赖提供器的自动匹配：

[HttpPost, Route("Send")]
public async Task<IActionResult> Send(
    [ModelBinder(typeof(EmailArrayModelBinder))] Email[] emails)
{
    if (emails == null || emails.Length == 0)
    {
        return BadRequest("No valid emails provided");
    }

    var toSave = emails.Select(email => new EmailQueueItem
    {
        Html = true,
        To = email.To,
        Subject = email.Subject,
        Body = email.Body
    });

    await Database.BulkInsert(toSave.ToArray());
    return Ok();
}

这样改造后，API就能正确绑定你的JSON请求体了。

内容的提问来源于stack exchange，提问作者MRP