ASP.NET MVC 5 Web API自定义模型绑定器传参及参数接收问题

我来帮你搞定这个参数绑定的问题！默认的模型绑定器没办法自动把URL里用分号分隔的GUID字符串转换成IList<Guid>，咱们只需要自定义一个模型绑定器就能解决这个问题，具体步骤如下：

1. 创建自定义GUID列表模型绑定器 #

首先写一个实现IModelBinder接口的类，负责把分号分隔的字符串解析成GUID列表：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.Http.ModelBinding;

public class GuidListModelBinder : IModelBinder
{
    public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext)
    {
        // 从请求中获取参数的原始值
        var valueProviderResult = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
        if (valueProviderResult == null)
        {
            return false;
        }

        var rawGuidString = valueProviderResult.RawValue as string;
        if (string.IsNullOrWhiteSpace(rawGuidString))
        {
            bindingContext.ModelState.AddModelError(bindingContext.ModelName, "请提供有效的GUID列表");
            return false;
        }

        // 按分号分割字符串，过滤空项
        var guidParts = rawGuidString.Split(';', StringSplitOptions.RemoveEmptyEntries);
        var guidList = new List<Guid>();

        foreach (var part in guidParts)
        {
            if (Guid.TryParse(part.Trim(), out Guid parsedGuid))
            {
                guidList.Add(parsedGuid);
            }
            else
            {
                bindingContext.ModelState.AddModelError(bindingContext.ModelName, $"无效的GUID格式：{part}");
                return false;
            }
        }

        // 将解析后的列表赋值给模型
        bindingContext.Model = guidList;
        return true;
    }
}

2. 在Action参数上指定绑定器 #

修改你的CompatibilityController，在organizationIds参数上添加[ModelBinder]特性，指定咱们刚才写的绑定器：

using System;
using System.Collections.Generic;
using System.Web.Http;
using System.Web.Http.ModelBinding;

[RoutePrefix("API/Compatibility")]
public class CompatibilityController : ApiController
{
    [Route("{organizationIds}")]
    public IHttpActionResult Get([ModelBinder(typeof(GuidListModelBinder))] IList<Guid> organizationIds)
    {
        // 这里处理你的业务逻辑
        if (organizationIds == null || organizationIds.Count == 0)
        {
            return BadRequest("未提供有效的GUID");
        }

        // 示例：返回第一个GUID，你可以替换成自己的逻辑
        return Ok(organizationIds[0]);
    }
}

3. （可选）全局注册绑定器 #

如果你的多个接口都需要处理这种分号分隔的GUID列表，可以把绑定器注册到全局，这样就不用每个参数都加特性了：

打开App_Start/WebApiConfig.cs，添加绑定器注册代码：

using System;
using System.Collections.Generic;
using System.Web.Http;
using System.Web.Http.ModelBinding;

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // 全局注册GUID列表模型绑定器
        config.BindParameter(typeof(IList<Guid>), new GuidListModelBinder());

        // 其他Web API配置
        config.MapHttpAttributeRoutes();
    }
}

这样处理后，你访问http://localhost/API/Compatibility/59dd2c60-c340-4735-8ecb-85efc60c7b14;d126d9b3-4516-46ca-bd6c-1a8c23740b90时，organizationIds参数就能正确获取到两个GUID的列表了。

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