.NET 8 Minimal API中字典的模型绑定问题求解

问题背景 #

定义包含Dictionary<string, string>类型的查询参数结构体，结合[AsParameters]和[FromQuery]特性使用时，启动Minimal API会抛出错误：

Unhandled exception. System.InvalidOperationException: Filters must have a valid TryParse method to support converting from a string. No public static bool Dictionary<string, string>.TryParse(string, out Dictionary<string, string>) method found for Filters.

即使为Dictionary<string, string>添加TryParse扩展方法也无法解决，因为模型绑定系统只会识别类型自身的静态TryParse方法，扩展方法不被视为类型成员。

解决方案 #

方法一：自定义类型转换器（TypeConverter） #

通过实现TypeConverter，让.NET模型绑定系统能将查询字符串转换为字典：

1. 创建转换器类：

using System.ComponentModel;
using System.Globalization;

public class StringDictionaryConverter : TypeConverter
{
    public override bool CanConvertFrom(ITypeDescriptorContext? context, Type sourceType)
    {
        return sourceType == typeof(string) || base.CanConvertFrom(context, sourceType);
    }

    public override object? ConvertFrom(ITypeDescriptorContext? context, CultureInfo? culture, object value)
    {
        if (value is string queryString)
        {
            var dictionary = new Dictionary<string, string>();
            if (string.IsNullOrEmpty(queryString))
                return dictionary;

            var pairs = queryString.Split('&', StringSplitOptions.RemoveEmptyEntries);
            foreach (var pair in pairs)
            {
                var keyValue = pair.Split('=', StringSplitOptions.RemoveEmptyEntries);
                if (keyValue.Length == 2)
                {
                    var key = Uri.UnescapeDataString(keyValue[0]);
                    var val = Uri.UnescapeDataString(keyValue[1]);
                    dictionary[key] = val;
                }
            }
            return dictionary;
        }
        return base.ConvertFrom(context, culture, value);
    }
}

2. 在Program.cs中注册转换器：

TypeDescriptor.AddAttributes(typeof(Dictionary<string, string>), new TypeConverterAttribute(typeof(StringDictionaryConverter)));

之后原有的QueryParameters结构体和端点方法无需修改即可正常工作。

方法二：自定义模型绑定器（IModelBinder） #

实现IModelBinder接口，为字典属性指定自定义绑定逻辑：

1. 创建绑定器类：

using Microsoft.AspNetCore.Mvc.ModelBinding;

public class DictionaryModelBinder : IModelBinder
{
    public Task BindModelAsync(ModelBindingContext bindingContext)
    {
        var modelName = bindingContext.ModelName;
        var values = bindingContext.ValueProvider.GetValue(modelName);

        if (values == ValueProviderResult.None)
        {
            bindingContext.Result = ModelBindingResult.Success(new Dictionary<string, string>());
            return Task.CompletedTask;
        }

        var dictionary = new Dictionary<string, string>();
        var queryValues = values.ToString().Split('&', StringSplitOptions.RemoveEmptyEntries);
        foreach (var pair in queryValues)
        {
            var keyValue = pair.Split('=', StringSplitOptions.RemoveEmptyEntries);
            if (keyValue.Length == 2)
            {
                var key = Uri.UnescapeDataString(keyValue[0]);
                var val = Uri.UnescapeDataString(keyValue[1]);
                dictionary[key] = val;
            }
        }

        bindingContext.Result = ModelBindingResult.Success(dictionary);
        return Task.CompletedTask;
    }
}

2. 修改QueryParameters结构体，为字典属性标记绑定器：

public struct QueryParameters
{
    [FromQuery]
    [ModelBinder(typeof(DictionaryModelBinder))]
    public Dictionary<string, string>? Filters { get; init; }
}

方法三：手动解析查询字符串 #

跳过模型绑定，直接在端点方法中从HttpContext获取并解析查询参数，适合简单场景：

public async ValueTask<IResult> GetAllAsync(HttpContext context)
{
    var filters = new Dictionary<string, string>();
    // 解析以Filters.为前缀的参数，比如Filters.Name=Alice&Filters.Age=30
    foreach (var (key, value) in context.Request.Query)
    {
        if (key.StartsWith("Filters."))
        {
            var filterKey = key["Filters.".Length..];
            filters[filterKey] = value;
        }
    }
    return TypedResults.Ok(filters);
}

这种方式无需额外定义转换器或绑定器，逻辑直接可控。

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