asp.net core webapi项目配置全局路由的方法示例

一、前言

在ASP.NET Core WebAPI项目的开发过程中，你可能会遇到这样一个问题：当你的项目逐渐壮大，控制器数量增多，或者需要进行版本迭代时，每一个接口的路由都需要手动修改，这无疑是一种痛苦。如果能够进行全局路由配置，将极大地提高工作效率。接下来，让我们一起跟随长沙网络推广来看看如何实现全局路由配置吧！

二、配置之旅

在开始之前，我们先来看看默认的接口路由前缀是什么样的。通过Swagger工具，我们可以清晰地看到每个接口的路由情况。接下来，我们要用到IApplicationModelConvention接口，这个接口位于Microsoft.AspNetCore.Mvc.ApplicationModels命名空间下，主要用于定义MVC框架的约定。通过实现这个接口的Apply方法，我们可以对全局路由进行修改或添加新的约定。

让我们深入了解这个接口的核心内容：ApplicationModel对象。这个对象包含了丰富的信息，如ApiExplorerModel（包括描述信息、群组信息、可见性等），ControllerModel（主要关于Controller的默认约定，包括控制器名称、路由值、Actions等）。我们接下来的配置工作将主要围绕这些内容进行。

配置步骤：

第一步，定义一个类，实现IApplicationModelConvention接口。这个类将用于全局路由前缀的配置。我们称之为RouteConvention。

在这个类中，我们需要定义一个路由前缀变量_centralPrefix，并在构造函数中通过IRouteTemplateProvider传入指定的路由前缀。

接下来，实现接口的Apply方法。在这个方法中，我们将遍历所有的Controller。对于已经标记了RouteAttribute的Controller，我们需要注意一点：如果在控制器中已经标注了路由，那么我们的全局路由前缀将会在这个已标注的路由前面再添加指定的内容。这样，我们就可以实现全局路由的配置，只需修改一处即可统一调整所有接口的路由。

代码解读：

该段代码主要处理MVC控制器的路由配置，分为两部分：一部分是对有路由配置的控制器进行操作，另一部分是对没有路由配置的控制器进行操作。具体来说，它首先筛选出带有路由配置的控制器和没有路由配置的控制器，然后针对这两种情况分别进行处理，为它们的路由模型添加前缀。通过定义一个扩展方法，方便在Startup.cs文件中配置全局路由。

一、保持原有功能的基础上，对代码进行美化和注释，提高代码的可读性。

```csharp

// 对带有路由配置的控制器进行处理

var matchedSelectors = controller.Selectors

.Where(selector => selector.AttributeRouteModel != null)

.ToList();

if (matchedSelectors.Any())

{

foreach (var selectorModel in matchedSelectors)

{

// 为当前路由添加路由前缀

selectorModel.AttributeRouteModel = AttributeRouteModelbineAttributeRouteModel(_centralPrefix, selectorModel.AttributeRouteModel);

}

}

// 对没有路由配置的控制器进行处理

var unmatchedSelectors = controller.Selectors

.Where(selector => selector.AttributeRouteModel == null)

.ToList();

if (unmatchedSelectors.Any())

{

foreach (var selectorModel in unmatchedSelectors)

{

// 为这些控制器添加默认路由前缀

selectorModel.AttributeRouteModel = _centralPrefix;

}

}

```

二、定义MvcOptionsExtensions类，创建扩展方法，方便配置全局路由。

```csharp

public static class MvcOptionsExtensions

{

///

/// MvcOptions对象

/// 自定义的路由属性

public static void UseCentralRoutePrefix(this MvcOptions opts, IRouteTemplateProvider routeAttribute)

{

opts.Conventions.Insert(0, new RouteConvention(routeAttribute));

}

}

```

三、在Startup.cs文件中使用上述扩展方法配置全局路由。

```csharp

region 配置全局路由

// 在各控制器中添加前缀（对于没有特定路由的控制器添加前缀）

services.AddMvc(opt =>

{

// 应用全局路由前缀，此处可自定义前缀内容

opt.UseCentralRoutePrefix(new RouteAttribute("lg/v1/[action]"));

// 可根据需要添加其他路由配置

// opt.UseCentralRoutePrefix(new RouteAttribute("api/[controller]/[action]"));

});

endregion

```

一、初步准备

在完成前三步的基础上，我们已经为项目的路由配置打下了坚实的基础。现在，我们将进行第四步操作，对控制器路由前缀进行调整。

二、具体步骤

1. 保留原先的路由前缀

在修改之前，我们先了解一下目前项目中路由前缀的设置情况，以确保我们能够在修改过程中保持其它功能的正常运行。这个步骤是为了避免在修改过程中可能出现的不必要的错误。

2. 去除原先的路由前缀

接下来，我们将进行实际的修改操作。根据项目的需求，我们需要去除原先的路由前缀。这个步骤需要我们仔细核对每一个路由的配置，确保在去除前缀的不会影响到项目的正常运行。

三、完成修改

至此，我们已经成功实现了全局路由配置前缀的修改。现在，你可以测试一下项目的运行情况，确保修改后的路由配置能够正常工作。完成这一步后，你就可以放心地进行后续的开发工作了。

本文的内容就到这里结束了，希望本文对你学习相关知识有所帮助。如果你有任何疑问或者需要进一步的指导，请随时联系我们。也希望大家能够支持我们的狼蚁SEO，我们会继续努力为大家提供更多有价值的内容。

五、渲染结束

以上就是本文的全部内容，希望大家能够喜欢。使用cambrian.render('body')结束本次的渲染。让我们期待更多精彩的内容，共同学习，共同进步。