如何使用不同的参数在同一个控制器中调用不同的 GET 方法？

Question

我有一个控制器，它包含两个不同的 Get 方法。一个采用int 值，而另一个采用String 值，如下所示：

public class AccountController : ApiController
{
    public String GetInfoByString(String sUserInput)
    {
        return "GetInfoByString received: " + sUserInput;
    }

    public String GetInfoByInt(int iUserInput)
    {
        return "GetInfoByInt received: " + iUserInput;
    }
}

我的RouteConfig.cs没有改动，如下：

public static void RegisterRoutes(RouteCollection routes)
{
    routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

    routes.MapRoute(
        name: "Default",
        url: "{controller}/{action}/{id}",
        defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
    );
}

我的WebApiConfig.cs也没有动过，如下：

public static void Register(HttpConfiguration config)
{
    config.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );
}

我希望能够通过使用单个链接来访问 Web API：

// Hit GetInfoByInt
http://localhost:XXXX/api/account/1

// Hit GetInfoByString
http://localhost:XXXX/api/account/abc

我可以很好地打第一种情况，但是每当我尝试打第二种情况时，我都会收到以下错误：

<Error>
    <Message>The request is invalid.</Message>
        <MessageDetail>
            The parameters dictionary contains a null entry for parameter 'id' of 
            non-nullable type 'System.Int64' for method  'TestProject.String GetInfoByInt(Int64)' in 'TestProject.Controllers.AccountController'. 
            An optional parameter must be a reference type, a nullable type, or be declared as an optional parameter.
        </MessageDetail>
 </Error>

有没有办法根据用户提供String 或int 来点击Get 方法？我假设需要在 RouteConfig 或 WebApiConfig 中进行更改，但我不太确定如何解决这个问题。也许这毕竟只是一个简单的解决方案？

另外，如果重要的话，我希望能够使用包含字母和数字的 String 来访问 GetInfoByString，例如 'ABC123' 或 '123ABC'。 GetInfoByInt 可以是 '123'

如果可能的话，我真的很想坚持一个控制器，而不是把它分成多个控制器。

提前感谢您的帮助。

Answer 1

如果您想将这两个操作分开，这是一种处理方式：

config.Routes.MapHttpRoute("GetAccountInfoByInt", "api/account/{iUserInput}", new { controller = "account", action = "GetInfoByInt" }, new { iUserInput = @"\d+" });
config.Routes.MapHttpRoute("GetAccountInfoByString", "api/account/{sUserInput}", new { controller = "account", action = "GetInfoByString" });

请注意，我们计划在未来通过在 Web API 的下一版本中引入属性路由来简化此类事情：

https://aspnetwebstack.codeplex.com/wikipage?title=Attribute%20routing%20in%20Web%20API

如果您愿意使用我们的夜间版本，它应该已经可用。那么你所要做的就是添加几个属性：

[HttpGet("api/account/{sUserInput}")]
public String GetInfoByString(String sUserInput)

[HttpGet("api/account/{iUserInput:int}")]
public String GetInfoByInt(int iUserInput)

Answer 2

以下代码适用于我，注意 ActionName 和 HttpGet 属性，也不是在您需要定义 action 参数的配置中接口。

public class AccountController : ApiController
{
    [HttpGet]
    [ActionName("GetInfoByString")]
    public String GetInfoByString(String sUserInput)
    {
        return "GetInfoByString received: " + sUserInput;
    }

    [HttpGet]
    [ActionName("GetInfoByInt")]
    public String GetInfoByInt(int iUserInput)
    {
        return "GetInfoByInt received: " + iUserInput;
    }
}

在 Config for Api 中做同样的事情

public static void RegisterRoutes(RouteCollection routes)
{
    routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

    routes.MapHttpRoute("DrawWebService",
                "api/{controller}/{action}/{value}",
                new { value = System.Web.Http.RouteParameter.Optional });

    routes.MapRoute(
        name: "Default",
        url: "{controller}/{action}/{id}",
        defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
    );
}

Answer 3

克服此限制的一种方法是使用可为空的参数，例如

public ActionResult GetInfo(string sUserInput, int? iUserInput)

...并将您的逻辑限定为非空值。

Answer 4

一种解决方法是使用可为空的参数或尝试将字符串解析为整数然后限定。

public ActionResult GetInfo(string sUserInput)
{
    var result = sUserInput.IsInt
        ? GetInfoByInt(int.Parse(sUserInput))
        : GetInfoByString(sUserInput)
    return result;
}