ASP.Net Web Api Core：如何根据查询字符串参数路由至对应Action

这个问题是ASP.NET Core路由系统的常见坑——默认情况下，路由匹配只看HTTP方法和路由模板，不会检查查询参数，所以两个[HttpGet("search")]的Action会被视为同一个端点，导致AmbiguousMatchException。下面给你几个可行的解决思路：

方案1：给Action设置不同的路由模板 #

最直接的方式是给两个搜索Action分配不同的路由段，让路由系统能直接区分它们：

// 按lobSettingsId搜索的路由
[HttpGet("search-by-lob")]
[ProducesResponseType(StatusCodes.Status200OK)]
public async Task<List<LoadFactorResource>> GetByLobSettingsId([FromQuery]Guid lobSettingsId) {
    return await _service.GetByLobSettingsId(lobSettingsId);
}

// 按cedentId搜索的路由
[HttpGet("search-by-account")]
[ProducesResponseType(StatusCodes.Status200OK)]
public async Task<List<LoadFactorResource>> GetByAccountId([FromQuery]Guid cedentId) {
    return await _service.GetByCedentId(cedentId);
}

对应的请求URL就变成：

• 按lobSettingsId：http://baseURL/api/v1.0/loadfactors/search-by-lob?lobSettingsId=xxx
• 按cedentId：http://baseURL/api/v1.0/loadfactors/search-by-account?cedentId=xxx

优点：路由规则清晰，易于理解和维护，符合RESTful API的设计习惯；缺点：需要修改前端请求的URL路径。

方案2：自定义查询参数匹配约束 #

如果必须保持search这个统一的路由路径，可以通过自定义Action约束，让路由系统根据查询参数的存在来匹配对应的Action：

首先创建一个自定义的路由约束属性：

public class QueryParameterExistsAttribute : ActionMethodSelectorAttribute
{
    private readonly string _requiredParamName;

    public QueryParameterExistsAttribute(string requiredParamName)
    {
        _requiredParamName = requiredParamName;
    }

    public override bool IsValidForRequest(RouteContext routeContext, ActionDescriptor actionDescriptor)
    {
        // 检查请求中是否包含指定的查询参数
        return routeContext.HttpContext.Request.Query.ContainsKey(_requiredParamName);
    }
}

然后给两个Action加上这个约束：

[HttpGet("search")]
[ProducesResponseType(StatusCodes.Status200OK)]
[QueryParameterExists("lobSettingsId")] // 只有当请求包含lobSettingsId时匹配这个Action
public async Task<List<LoadFactorResource>> GetByLobSettingsId([FromQuery]Guid lobSettingsId) {
    return await _service.GetByLobSettingsId(lobSettingsId);
}

[HttpGet("search")]
[ProducesResponseType(StatusCodes.Status200OK)]
[QueryParameterExists("cedentId")] // 只有当请求包含cedentId时匹配这个Action
public async Task<List<LoadFactorResource>> GetByAccountId([FromQuery]Guid cedentId) {
    return await _service.GetByCedentId(cedentId);
}

这样当请求携带lobSettingsId参数时，路由系统会自动匹配第一个Action；携带cedentId时匹配第二个。如果两个参数都携带或者都不携带，会返回404或者其他错误，你可以根据需求补充异常处理逻辑。

优点：保持了统一的路由路径；缺点：需要额外编写自定义约束代码，增加了一点复杂度。

方案3：合并成单个Action处理两种查询 #

把两个搜索逻辑合并到同一个Action中，通过判断参数的存在情况来调用对应的服务方法：

[HttpGet("search")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<IActionResult> SearchLoadFactors([FromQuery]Guid? lobSettingsId, [FromQuery]Guid? cedentId) {
    // 校验参数：只能提供其中一个查询参数
    if (lobSettingsId.HasValue && cedentId.HasValue)
    {
        return BadRequest("Please provide either lobSettingsId or cedentId, not both.");
    }
    else if (!lobSettingsId.HasValue && !cedentId.HasValue)
    {
        return BadRequest("Please provide either lobSettingsId or cedentId.");
    }

    List<LoadFactorResource> result;
    if (lobSettingsId.HasValue)
    {
        result = await _service.GetByLobSettingsId(lobSettingsId.Value);
    }
    else
    {
        result = await _service.GetByCedentId(cedentId.Value);
    }

    return Ok(result);
}

优点：减少了Action的数量，逻辑集中处理；缺点：如果后续需要增加更多查询条件，这个方法会变得越来越臃肿，需要注意代码的可维护性。

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