如何配置ASP.NET API中的路由文件？

ASP.NET API 路由配置文件是一个定义应用程序路由规则的文件，通常位于项目根目录下的 App_Start 文件夹中。该文件使用 MapRoute 方法来指定 URL 与控制器和操作之间的映射关系。

ASP.NET API 路由配置文件

在ASP.NET Web API项目中，路由配置是一个重要的部分，它负责将HTTP请求映射到相应的控制器和操作方法，本文将详细介绍ASP.NET Web API的路由配置文件，包括如何定义、配置和使用路由，以实现灵活且高效的API开发。

一、基本概念

在ASP.NET Web API中，路由用于将URL请求映射到特定的控制器和操作方法，通过定义路由规则，开发者可以创建清晰、简洁且符合RESTful原则的API接口。

路由表

路由表是一个包含多个路由规则的集合，每个路由规则定义了URL模式与控制器操作之间的映射关系，ASP.NET Web API使用HttpRouteCollection来管理这些路由规则。

路由模板

路由模板定义了URL的模式，并包含占位符变量，用于匹配请求的URL，默认情况下，ASP.NET Web API提供了一个基本的路由模板：api/{controller}/{id?}，这个模板意味着所有的请求都会映射到名称为{controller}的控制器，并且可以选择性地包含一个ID参数。

二、配置路由

在ASP.NET Web API项目中，路由的配置通常在WebApiConfig类中进行，该类位于项目的App_Start文件夹中，包含了一个名为Register的方法，该方法接收一个HttpConfiguration对象作为参数，并对其进行配置。

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // 属性路由
        config.MapHttpAttributeRoutes();
        // 公约路由
        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );
    }
}

在上面的代码中，config.MapHttpAttributeRoutes()启用了属性路由功能，而config.Routes.MapHttpRoute则定义了一个默认的公约路由，这意味着，如果控制器上没有定义具体的路由属性，那么它将使用这个公约路由。

三、属性路由

属性路由是一种更加灵活和强大的路由方式，它允许开发者在控制器的操作方法上直接使用特性来定义路由信息，这种方式不仅提高了代码的可读性和可维护性，还使得路由的定义更加直观和易于管理。

定义属性路由

要使用属性路由，首先需要在控制器的操作方法上使用[Route]或[RoutePrefix]特性来定义路由信息。

[RoutePrefix("customers")]
public class CustomersController : ApiController
{
    [Route("{customerId:int}/orders")]
    public IEnumerable<Order> GetCustomerOrders(int customerId)
    {
        // 获取客户订单的逻辑
    }
    [Route("{customerId:int}/details")]
    public CustomerGetCustomerDetails(int customerId)
    {
        // 获取客户详情的逻辑
    }
}

在这个例子中，[RoutePrefix("customers")]定义了一个公共的前缀，而[Route("{customerId:int}/orders")]和[Route("{customerId:int}/details")]则分别定义了两个具体的操作方法的路由，这样，当收到形如/customers/123/orders或/customers/123/details的请求时，ASP.NET Web API就会将这些请求映射到相应的操作方法上。

需要注意的是，属性路由中的参数名必须与操作方法的参数名一致，否则会导致模型绑定失败，还可以在[Route]特性中添加约束（Constraints），以确保参数满足特定的条件。{customerId:int}表示customerId参数必须是整数类型。

属性路由的优势

属性路由相比公约路由具有以下几个优势：

灵活性高：可以在控制器的操作方法上直接定义路由信息，无需遵循固定的命名约定。

可读性好：路由信息紧挨着操作方法，一目了然，便于理解和维护。

易于管理：对于复杂的URI模式或需要多级资源嵌套的情况，属性路由提供了更好的支持。

四、高级路由配置

除了基本的路由配置外，ASP.NET Web API还支持一些高级的路由配置选项，以满足更复杂的应用场景。

路由约束

路由约束用于限制参数的取值范围或格式，只允许某些特定的值或格式通过路由，可以通过在[Route]特性中使用constraints属性来实现路由约束：

[Route("api/users/{userId:guid}")]
public IHttpActionResult GetUserById(string userId)
{
    // 根据GUID获取用户信息的逻辑
}

在这个例子中，{userId:guid}表示userId参数必须是GUID格式，如果请求中的userId不是有效的GUID，那么ASP.NET Web API将返回404 Not Found错误。

可选参数

我们可能需要让路由中的某个参数成为可选的，这可以通过在Route特性中设置默认值来实现。

[Route("api/products/{category?}")]
public IEnumerable<Product> GetProductsByCategory(string category = null)
{
    if (string.IsNullOrEmpty(category))
    {
        return GetAllProducts();
    }
    else
    {
        return GetProductsByCategory(category);
    }
}

在这个例子中，{category?}表示category参数是可选的，如果请求中没有提供category参数，那么它将使用默认值null，根据category的值是否为空，我们可以决定是返回所有产品还是返回特定分类下的产品。

自定义路由约束

除了内置的路由约束外，ASP.NET Web API还允许开发者创建自定义的路由约束，这需要实现IHttpRouteConstraint接口，并在Register方法中注册自定义的约束解析器：

public class NonZeroConstraint : IHttpRouteConstraint
{
    public bool Match(HttpRequestMessage request, IHttpRoute route, string parameterName, IDictionary<string, object> values, HttpRouteDirection routeDirection)
    {
        object value;
        if (values.TryGetValue(parameterName, out value) && value != null)
        {
            long longValue;
            if (value is long)
            {
                longValue = (long)value;
                return longValue != 0;
            }
            string valueString = Convert.ToString(value, CultureInfo.InvariantCulture);
            if (Int64.TryParse(valueString, NumberStyles.Integer, CultureInfo.InvariantCulture, out longValue))
            {
                return longValue != 0;
            }
        }
        return false;
    }
}
public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        var constraintResolver = new DefaultInlineConstraintResolver();
        constraintResolver.ConstraintMap.Add("nonzero", typeof(NonZeroConstraint));
        config.MapHttpAttributeRoutes(constraintResolver);
        config.Routes.MapHttpRoute(...); // 其他配置保持不变
    }
}

在这个例子中，NonZeroConstraint类实现了IHttpRouteConstraint接口，用于检查参数是否为非零值，然后在WebApiConfig类的Register方法中，我们将这个自定义约束添加到了约束解析器中，并将其命名为"nonzero"，在定义路由时，我们可以使用"nonzero"作为约束的名称：

[Route("api/items/{id:nonzero}")]
public Item GetItemById(int id)
{
    // 根据ID获取项目信息的逻辑
}

这样，当请求的ID为零时，ASP.NET Web API将不会映射到这个操作方法上。

五、归纳与FAQs

ASP.NET Web API的路由配置文件是API开发的核心部分之一，它决定了如何将HTTP请求映射到控制器和操作方法上，通过合理地配置路由规则，可以实现清晰、简洁且符合RESTful原则的API接口，属性路由作为一种更加灵活和强大的路由方式，进一步提高了代码的可读性和可维护性，高级路由配置选项如路由约束、可选参数和自定义路由约束等也为复杂应用场景提供了有力的支持。

到此，以上就是小编对于“asp.net api 路由配置文件”的问题就介绍到这了，希望介绍的几点解答对大家有用，有任何问题和不懂的，欢迎各位朋友在评论区讨论，给我留言。