ASP.NET Core中[FromQuery]的使用及URL格式咨询

嘿，我来帮你梳理清楚[FromQuery]在这个场景下的正确用法以及对应的URL格式～

首先，先明确[FromQuery]的作用：它告诉ASP.NET Core框架，要从URL的查询字符串（就是?后面的部分）中提取数据，绑定到你指定的Book对象上。你的控制器方法里，shelfID是从路由（URL里的{shelfID}部分）获取的，而bookinfo则完全从查询参数里取值，这个搭配是没问题的。

一、正确的URL请求格式 #

你只需要把Book类的属性作为查询参数拼在URL后面就行，格式如下：

api/v1/ShelfID/{你的shelfID值}/BookCollection?ID={书籍ID}&Name={书籍名称}&Author={作者名}&PublishDate={出版日期}

举个具体的例子，假设shelfID是SH001，要查询ID为B007、名为《哈利波特与魔法石》、作者是J.K.罗琳、出版日期为1997-06-26的书籍，URL就是：

api/v1/ShelfID/SH001/BookCollection?ID=B007&Name=哈利波特与魔法石&Author=J.K.罗琳&PublishDate=1997-06-26

二、使用时的注意事项 #

• 参数可选性：不需要传递所有属性，比如你只想按作者过滤，URL可以简化成：

  api/v1/ShelfID/SH001/BookCollection?Author=J.K.罗琳
  

  此时bookinfo里未传递的属性（ID、Name、PublishDate）会是null（因为是string类型）。
• 大小写问题：ASP.NET Core默认对查询参数名称不区分大小写，但建议保持和Book类属性名一致，避免不必要的问题。比如你写id=B007也能绑定到ID属性，但统一写法更规范。
• 自定义参数名（可选）：如果想让前端用不同的参数名（比如更符合REST风格的短名称），可以给Book的属性加[FromQuery(Name = "别名")]，比如：

  public class Book {
      [FromQuery(Name = "book-id")]
      public string ID{ get; set; }
      // 其他属性...
  }
  

  对应的URL就变成：

  api/v1/ShelfID/SH001/BookCollection?book-id=B007&Name=哈利波特与魔法石
  

• 属性可访问性：确保Book类的属性是公共可读写的（你当前的代码已经满足，这点很重要，框架需要通过setter来赋值）。

三、控制器方法里的使用示例 #

在你的GetAllBooks方法里，就可以直接使用绑定好的bookinfo对象来做业务逻辑，比如过滤书籍：

[HttpGet]
[Route("api/v1/ShelfID/{shelfID}/BookCollection")]
public async Task<IActionResult> GetAllBooks(string shelfID, [FromQuery] Book bookinfo) {
    // 比如根据bookinfo里的非空属性过滤书架上的书籍
    var filteredBooks = await _bookRepository.GetBooksByShelfAndFilters(shelfID, bookinfo);
    return Ok(filteredBooks);
}

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