在C#中向GET方法传递多个参数是Web API开发中的常见需求。本文探讨了在ASP.NET Core中实现此目标的各种技术，重点关注清晰度、可维护性和最佳实践。
目录
通过传统路由传递参数
传统路由直接将参数合并到URL路径中。这种方法适用于少量直接标识资源的参数。
示例：根据产品ID和类别ID检索产品。
URL：/products/123/category/456
using Microsoft.AspNetCore.Mvc;
public class ProductsController : Controller
{
public IActionResult GetProduct(int productId, int categoryId)
{
// 处理productId和categoryId
return Ok($"Product ID: {productId}, Category ID: {categoryId}");
}
}
局限性：随着参数数量的增加，URL的可读性和可维护性降低。对于可选参数，灵活性较差。
使用特性路由和[FromQuery]
特性路由提供了对URL结构的更大控制。使用[FromQuery]，参数从查询字符串中提取，即使有很多参数，也能使URL更简洁易于管理。
示例：相同的产品检索示例，但使用特性路由和[FromQuery]。
URL：/products?productId=123&categoryId=456
using Microsoft.AspNetCore.Mvc;
[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
[HttpGet]
public IActionResult GetProduct([FromQuery] int productId, [FromQuery] int categoryId)
{
return Ok($"Product ID: {productId}, Category ID: {categoryId}");
}
}
此方法提高了URL的组织性和可读性。[ApiController]特性启用自动模型验证和响应处理。
处理可选参数
可选参数增强了灵活性。在控制器操作签名中使用默认值。
[HttpGet]
public IActionResult GetProduct([FromQuery] int productId, [FromQuery] int categoryId, [FromQuery] int pageSize = 10)
{
return Ok($"Product ID: {productId}, Category ID: {categoryId}, Page Size: {pageSize}");
}
这里，如果查询字符串中未提供pageSize，则默认为10。
利用模型绑定
对于多个参数，考虑创建一个专用模型。这提高了代码的组织性和可维护性。ASP.NET Core将自动将查询字符串绑定到模型的属性。
public class ProductFilter
{
public int ProductId { get; set; }
public int CategoryId { get; set; }
public int PageSize { get; set; } = 10;
}
[HttpGet]
public IActionResult GetProduct(ProductFilter filter)
{
return Ok($"Product ID: {filter.ProductId}, Category ID: {filter.CategoryId}, Page Size: {filter.PageSize}");
}
健壮的错误处理
始终处理潜在的错误，例如缺少必需的参数或无效的数据类型。使用模型验证或显式参数检查等技术来优雅地处理这些情况。
[HttpGet]
public IActionResult GetProduct(ProductFilter filter)
{
if (filter.ProductId == 0)
{
return BadRequest("Product ID is required.");
}
// ...其余逻辑...
}