悠悠楠杉
网站页面
ASP.NETCore中的属性路由与约定路由：灵活的路由策略
06/04
在ASP.NET Core中，路由是连接前端请求与后端处理逻辑的桥梁，它决定了如何根据URL路径将请求分发到相应的控制器和操作（Action）。ASP.NET Core支持两种主要的路由方式：属性路由（Attribute Routing）和约定路由（Conventional Routing）。本文将详细介绍这两种路由方式的实现方式及其在项目中的应用。
一、约定路由（Conventional Routing）
约定路由是通过在Startup.cs中的Configure方法里使用app.UseMvc()或app.UseEndpoints()来配置的。这种方式通过在Startup.cs中定义一系列的路由规则，使得应用程序的路由逻辑更加集中和易于管理。
实现步骤：
引入命名空间：
csharp using Microsoft.AspNetCore.Mvc;配置路由：
在Startup.cs的Configure方法中，使用app.UseEndpoints()来配置路由。例如：
csharp public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { // 其他配置... app.UseEndpoints(endpoints => { endpoints.MapControllerRoute( name: "default", pattern: "api/{controller=Home}/{action=Index}/{id?}"); }); }
这里定义了一个名为"default"的路由模板，它匹配形如/api/ControllerName/ActionName/ID的URL路径。
二、属性路由（Attribute Routing）
属性路由通过在控制器或操作上直接使用路由属性来定义路由规则，这种方式使得路由的配置与代码逻辑紧密结合，使得代码更加模块化和易于测试。
实现步骤：
引入命名空间：
csharp using Microsoft.AspNetCore.Mvc;使用
[Route]属性：
在控制器或操作上使用[Route]属性来定义路由模板。例如：
```csharp
[Route("api/[controller]")] // 应用于控制器级别，定义了默认的路由前缀为"api"和控制器名。
public class ProductsController : ControllerBase
{
[HttpGet("{id}")] // 应用于操作级别，定义了获取单个产品的路由。
public IActionResult GetProduct(int id) { ... }[HttpPost] // 如果没有指定模板，则继承控制器的路由前缀。
public IActionResult CreateProduct() { ... }
}
```
这样，ProductsController的GetProduct方法将匹配到/api/products/123这样的URL，而CreateProduct方法则匹配到形如/api/products/postdata的POST请求（假设使用了表单数据提交）。
三、选择与结合使用两种路由方式
在项目开发中，开发者可以根据实际需求选择使用约定路由或属性路由，或者两者结合使用。属性路由因其灵活性和与代码逻辑的紧密结合而常被用于微服务或小型项目；而约定路由因其强大的配置能力和易于维护的特点常被用于大型项目或团队开发中。结合使用两种方式可以充分发挥它们的优点，例如，对于共享的、通用的路由规则可以使用约定路由进行配置，而对于特定业务逻辑的细粒度控制则可以使用属性路由。
四、总结与最佳实践
- 清晰定义： 确保所有路由都是清晰和有意义的，避免使用模糊或易混淆的URL路径。
- 可维护性： 尽量保持路由规则的简单性，避免过于复杂的嵌套或通配符使用。
- 测试： 开发过程中应持续对路由进行测试，确保它们按预期工作，特别是在添加新控制器或修改现有逻辑时。
- 文档化： 为重要的API端点编写文档，确保其他开发者或用户能够理解其功能和用途。
