OData 8.0.11下同名多控制器的路由配置问题求助

问题根源 #

OData 8.x 重构了路由匹配逻辑，和 7.x 完全不同。默认情况下 ASP.NET Core 路由系统会优先匹配非 OData 控制器，哪怕你给 OData 控制器加了[ODataRouteComponent("odata")]，只要两个控制器同名，就会出现路由混淆，导致/odata/Messages请求被错误转发到 API 控制器，最终返回 404。

修复步骤 #

方案一：用命名空间区分同名控制器（保留原类名） #

如果必须保留两个MessagesController类：

1. 将两个控制器放到不同命名空间，比如：

   • API 控制器：YourApp.Controllers.Api.MessagesController（继承ControllerBase）
   • OData 控制器：YourApp.Controllers.OData.MessagesController（继承ODataController）

2. 在 Program.cs 中配置 OData 和 MVC 路由，分别指定各自的控制器命名空间：

   var builder = WebApplication.CreateBuilder(args);
   
   // 配置OData服务，指定仅扫描OData控制器所在命名空间
   builder.Services.AddControllers().AddOData(options =>
   {
       options.Select().Filter().OrderBy();
       options.AddRouteComponents("odata", GetEdmModel(), services =>
       {
           services.AddSingleton<IAssemblyProvider>(sp =>
               new AssemblyProvider(sp, new[] { typeof(YourApp.Controllers.OData.MessagesController).Assembly })
           );
       });
   });
   
   // 配置MVC路由，限定API控制器的命名空间
   builder.Services.Configure<MvcOptions>(options =>
   {
       options.Conventions.Add(new NamespaceRoutingConvention("YourApp.Controllers.Api", "api"));
   });
   
   var app = builder.Build();
   
   app.UseRouting();
   app.UseEndpoints(endpoints =>
   {
       endpoints.MapControllers();
       endpoints.MapODataRoute("odata", "odata", GetEdmModel());
   });
   
   app.Run();
   
   // 定义EDM模型（根据你的实体调整）
   IEdmModel GetEdmModel()
   {
       var modelBuilder = new ODataConventionModelBuilder();
       modelBuilder.EntitySet<Message>("Messages");
       return modelBuilder.GetEdmModel();
   }
   

   配套的自定义路由约定类：

   public class NamespaceRoutingConvention : IControllerModelConvention
   {
       private readonly string _namespace;
       private readonly string _routePrefix;
   
       public NamespaceRoutingConvention(string ns, string routePrefix)
       {
           _namespace = ns;
           _routePrefix = routePrefix;
       }
   
       public void Apply(ControllerModel controller)
       {
           if (controller.ControllerType.Namespace == _namespace)
           {
               controller.Selectors.Add(new ControllerSelectorModel
               {
                   AttributeRouteModel = new AttributeRouteModel(new RouteAttribute($"{_routePrefix}/[controller]"))
               });
           }
       }
   }
   

方案二：重命名OData控制器（更简单） #

如果可以修改控制器类名，这是最省心的方式：

1. 将OData控制器改名为MessagesODataController，添加[ControllerName("Messages")]确保OData路由对外显示还是Messages：

   [ODataRouteComponent("odata")]
   [ControllerName("Messages")]
   public class MessagesODataController : ODataController
   {
       [EnableQuery]
       public IActionResult Get()
       {
           // 处理OData查询请求
       }
   }
   

2. API控制器保持原样，明确标记路由前缀：

   [ApiController]
   [Route("api/[controller]")]
   public class MessagesController : ControllerBase
   {
       [HttpGet("{id:guid}")]
       public IActionResult GetById(Guid id)
       {
           // 处理API的GUID查询请求
       }
   }
   

3. Program.cs中OData配置无需额外修改，正常配置EDM模型即可：

   builder.Services.AddControllers().AddOData(options =>
   {
       options.Select().Filter().OrderBy();
       options.AddRouteComponents("odata", GetEdmModel());
   });
   

验证 #

• 测试/api/Messages/[GUID]：应正常返回API控制器的响应
• 测试/odata/Messages?$filter=...：应返回OData格式的查询结果，不再出现404

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