ASP.NET是否有字典URL表示法？WebApi URL支持哪些数据结构？

嘿，刚好对ASP.NET Web API的参数绑定这块比较熟悉，给你详细说说：

字典的URL传递方式 #

当然有对应的格式！Web API支持两种主流的URL格式来传递字典参数，框架会自动帮你绑定到Dictionary<TKey, TValue>类型的参数上：

• 索引式绑定（推荐）
  假设你的Action参数是Dictionary<string, string> searchParams，可以这样构造URL：

  ?searchParams[Name]=Alice&searchParams[Age]=30&searchParams[City]=Seattle
  

  要是键是数值类型（比如Dictionary<int, string>），直接用数字作为索引就行：?items[1]=Apple&items[2]=Banana。

• 扁平化键值对（适合简单场景）
  如果你的字典没有固定参数名，也可以直接传递多个键值对，然后在Action里手动解析，但这种方式需要自己处理，不如索引式省心，毕竟框架能自动绑定。

Web API支持的其他数据结构 #

除了字典、数组，这些数据结构也能通过URL传递并自动绑定：

• 自定义复杂对象
  只要URL参数名和类的属性名对应，框架会自动填充。比如你有个Order类：

  public class Order {
      public int Id { get; set; }
      public decimal Amount { get; set; }
      public DateTime CreateTime { get; set; }
  }
  

  直接用?Id=1001&Amount=99.9&CreateTime=2024-05-20就能绑定到Action的Order order参数上。

• 数组/集合
  传递数组有两种常用写法：

  • 重复参数名：?productIds=101&productIds=102&productIds=103，对应int[] productIds或者List<int> productIds
  • 索引式：?productIds[0]=101&productIds[1]=102，这种方式对集合类型同样有效

• 嵌套对象
  对于有嵌套属性的类，用.来层级指定。比如Order里有Customer属性：

  public class Customer {
      public string Name { get; set; }
      public string Phone { get; set; }
  }
  

  可以这样传递：?Id=1002&Customer.Name=Bob&Customer.Phone=123456789

• 枚举类型
  直接传枚举的名称或者数值都可以，比如枚举public enum OrderStatus { Pending, Paid, Shipped }，用?Status=Paid或者?Status=1都能正确绑定到OrderStatus status参数。

额外小技巧 #

如果遇到参数绑定失败的情况，可以在Action参数上加上[FromUri]特性，明确告诉框架从URL中读取参数，比如：

public IHttpActionResult GetOrders([FromUri] Dictionary<string, string> filters) {
    // 业务逻辑
}

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