C#配置RESTful路由异常：{id}正常{email}路由参数绑定失败

这个问题的核心在于你的两条RESTful路由模板结构完全一致，ASP.NET的路由引擎没办法根据传入的参数值类型自动区分应该匹配哪一个Action方法。当你传入邮箱字符串时，它还是试图把这个值绑定到int类型的id参数上——字符串没法转换成整数，自然就抛出了参数为null的错误，毕竟非可空值类型不能接受null。

下面给你几种可行的解决方案，按RESTful规范友好度排序：

方案1：给路由参数添加类型/格式约束 #

通过给路由参数添加约束，让路由引擎能根据传入值的特征匹配对应的Action。这是最推荐的方式，既保持了路由的简洁性，又能明确区分不同的请求。

比如修改你的Controller代码：

public class ImageController : ApiController
{
    // 匹配int类型的id参数
    [HttpGet]
    [Route("v1/images/{id:int}")]
    public HttpResponseMessage Get(int id, int? size)
    {
        // 这里写根据id获取图片的逻辑
        return Request.CreateResponse(HttpStatusCode.OK);
    }

    // 匹配符合邮箱格式的参数
    [HttpGet]
    [Route("v1/images/{email:regex(^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$)}")]
    public HttpResponseMessage GetByEmail(string email, int? size)
    {
        // 这里写根据email获取图片的逻辑
        return Request.CreateResponse(HttpStatusCode.OK);
    }
}

• 当你访问v1/images/1?size=100时，1符合int约束，会匹配第一个Action；
• 当你访问v1/images/foo@domain.com?size=100时，邮箱字符串符合正则约束，会匹配第二个Action。

如果觉得正则写在路由里太冗长，你还可以自定义路由约束：

public class EmailRouteConstraint : IRouteConstraint
{
    private readonly Regex _emailRegex = new Regex(@"^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$", RegexOptions.Compiled);

    public bool Match(HttpContextBase httpContext, Route route, string parameterName, RouteValueDictionary values, RouteDirection routeDirection)
    {
        if (values.TryGetValue(parameterName, out var value) && value is string email)
        {
            return _emailRegex.IsMatch(email);
        }
        return false;
    }
}

然后在WebApiConfig里注册约束：

config.Routes.MapHttpRoute(
    name: "GetImageById",
    routeTemplate: "v1/images/{id:int}",
    defaults: new { controller = "Image", action = "Get" }
);

config.Routes.MapHttpRoute(
    name: "GetImageByEmail",
    routeTemplate: "v1/images/{email}",
    defaults: new { controller = "Image", action = "GetByEmail" },
    constraints: new { email = new EmailRouteConstraint() }
);

这种方式更干净，也方便复用约束逻辑。

方案2：给路由添加区分性的前缀段 #

如果不想用约束，也可以直接修改路由模板，给两种请求添加不同的前缀，让路由结构完全不同：

public class ImageController : ApiController
{
    [HttpGet]
    [Route("v1/images/id/{id}")]
    public HttpResponseMessage Get(int id, int? size)
    {
        // 根据id获取图片逻辑
        return Request.CreateResponse(HttpStatusCode.OK);
    }

    [HttpGet]
    [Route("v1/images/email/{email}")]
    public HttpResponseMessage GetByEmail(string email, int? size)
    {
        // 根据email获取图片逻辑
        return Request.CreateResponse(HttpStatusCode.OK);
    }
}

此时访问路径就变成v1/images/id/1?size=100和v1/images/email/foo@domain.com?size=100，路由引擎能直接区分，不会出现绑定错误。

方案3：在单个Action里处理两种参数（不推荐，不够RESTful） #

如果不想修改路由结构，也可以写一个通用的Action，接收字符串类型的参数，然后在方法内部判断是id还是邮箱：

[HttpGet]
[Route("v1/images/{identifier}")]
public HttpResponseMessage Get(string identifier, int? size)
{
    if (int.TryParse(identifier, out var id))
    {
        // 执行根据id获取图片的逻辑
        return Request.CreateResponse(HttpStatusCode.OK);
    }
    else if (IsValidEmail(identifier))
    {
        // 执行根据email获取图片的逻辑
        return Request.CreateResponse(HttpStatusCode.OK);
    }
    else
    {
        return Request.CreateErrorResponse(HttpStatusCode.BadRequest, "无效的参数格式");
    }
}

private bool IsValidEmail(string email)
{
    try
    {
        var addr = new System.Net.Mail.MailAddress(email);
        return addr.Address == email;
    }
    catch
    {
        return false;
    }
}

这种方式虽然能解决问题，但违背了RESTful的单一职责原则，Action的逻辑会变得复杂，也不利于后续维护，所以仅作为临时解决方案。

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