.NET Core Web API中FromQuery无法映射复杂对象求助

问题概述 #

在.NET Core Web API开发中，使用[FromQuery]将请求参数绑定到QueryModel复杂对象时，Ordinal和BatchSize属性可以正常获取参数值，但SortBy集合的元素数量始终为0，无法正确映射请求中的排序参数。

相关代码 #

模型定义 #

/// <summary>
/// QueryModel类用于建模记录集的排序、分批需求。
/// </summary>
public class QueryModel
{
    /// <summary>
    /// SortBy列表用于存储所有作为记录排序依据的属性。
    /// 例如：Resource, Diagram No, Days Run, Dates。
    /// </summary>
    public List<SortBy> SortBy { get; set; }

    /// <summary>
    /// Ordinal表示记录在分批次中的位置。
    /// </summary>
    public int Ordinal { get; set; }

    /// <summary>
    /// 表示可传输的记录总数。
    /// </summary>
    public int BatchSize { get; set; }
}

/// <summary>
/// 该类作为排序驱动模型，以其成员为排序依据。
/// </summary>
public class SortBy
{
    private string _columnHeaderName;
    private SortOrder _sortOrder;

    /// <summary>
    /// 表示来自UI的列标题名称。
    /// </summary>
    public string ColumnNameAndSortOder
    {
        get
        {
            return string.Format("{0}, {1}", _columnHeaderName, _sortOrder);
        }
        set
        {
            string[] temp = value.Split(',');
            _columnHeaderName = temp[0].Trim();
            _sortOrder = (SortOrder)Enum.Parse(typeof(SortOrder), temp[1].Trim());
        }
    }

    /// <summary>
    /// 记录排序所需的枚举。
    /// </summary>
    internal enum SortOrder
    {
        None,
        Asc,
        Desc,
    }
}

控制器方法 #

public async Task<ActionResult<List<MapHeader>>> GetMaps([FromQuery, BindRequired] string geoCode,
                                                         [FromQuery, BindRequired] string geoId,
                                                         [FromQuery, BindRequired] QueryModel queryModelParams)

排查与解决方案 #

• 修正请求参数格式：.NET Core的QueryString绑定集合需要使用索引化的参数命名格式，针对SortBy集合，请求参数应写成：

  SortBy[0].ColumnNameAndSortOder=Resource,Asc&SortBy[1].ColumnNameAndSortOder=Days Run,Desc
  

  必须通过[索引]明确指定集合中每个元素的位置，模型绑定器才能正确识别并填充集合。

• 修改SortOrder枚举的访问修饰符：当前SortOrder是internal枚举，模型绑定器无法访问该类型进行值解析，将其改为public：

  public enum SortOrder
  {
      None,
      Asc,
      Desc,
  }
  

• 添加无参构造函数：为SortBy类显式添加无参构造函数，确保模型绑定器能够实例化对象：

  public SortBy() { }
  

• 排查属性逻辑问题：当前ColumnNameAndSortOder的setter逻辑依赖逗号分割的字符串，如果请求参数的格式不符合（比如缺少逗号、枚举值大小写不匹配），会导致解析失败。可以先简化该属性的逻辑，用普通属性测试绑定是否正常，再逐步恢复业务逻辑。

• 检查模型绑定配置：确认项目中没有自定义的模型绑定器覆盖默认的Query绑定行为，在Program.cs中确保builder.Services.AddControllers()启用了默认的模型绑定支持，没有额外的过滤或替换配置。

内容的提问来源于stack exchange，提问作者Aԃιƚყα Gυɾαʋ