限制路由到 ASP.NET Core 中的控制器命名空间

2023-12-22

我试图将 ASP.NET Core 路由的控制器限制到某个命名空间。

在 ASP.NET MVC 的早期版本中,有一个重载提供了string[] namespaces添加路由时的参数。 ASP.NET MVC 6 中缺少此功能。因此,经过一些谷歌搜索后,我尝试使用类似的东西

app.UseMvc(routes => {
    var dataTokens = new RouteValueDictionary {
        {
            "Namespaces", new[] {"ProjectA.SomeNamespace.Controllers"}
        }
    };

    routes.MapRoute(
         name: "default",
         template: "{controller=Home}/{action=Index}/{id?}",
         defaults: null,
         constraints: null,
         dataTokens: dataTokens
    );
});

但它似乎没有达到我想要的效果。有没有办法将路由引擎限制在某个命名空间?

Update

我刚刚意识到这可能与我在每个单独的控制器上使用属性路由这一事实有关?属性路由是否会破坏由以下定义的路由app.UseMvc()?

Update 2

更多细节:

我有两个完全独立的 Web API 项目。顺便说一句,两者中的一些路线是相同的(即~/api/ping)。这些项目在生产中是独立的,一个是用户的端点,一个是管理员的端点。

我也有单元测试,使用Microsoft.AspNet.TestHost。其中一些单元测试需要这两个 Web API 项目的功能(即需要“管理”端点来为“用户”完全设置测试用例)。但是当我引用这两个 API 项目时,TestHost 由于相同的路由而感到困惑,并且它抱怨“多个匹配路由”:

Microsoft.AspNet.Diagnostics.DeveloperExceptionPageMiddleware: Error: An unhandled exception has occurred while executing the request
Microsoft.AspNet.Mvc.Infrastructure.AmbiguousActionException: Multiple actions matched. The following actions matched route data and had all constraints satisfied:
    ProjectA.SomeNamespace.Controllers.PingController.Ping
    ProjectB.SomeNamespace.Controllers.PingController.Ping
at Microsoft.AspNet.Mvc.Infrastructure.DefaultActionSelector.SelectAsync(RouteContext context)
at Microsoft.AspNet.Mvc.Infrastructure.MvcRouteHandler.<RouteAsync>d__6.MoveNext()

Update:

我通过使用 ActionConstraint 找到了解决方案。您必须添加有关重复操作的自定义操作约束属性。

具有重复索引方法的示例。

第一个家庭控制器

namespace WebApplication.Controllers
{
    public class HomeController : Controller
    {
        [NamespaceConstraint]
        public IActionResult Index()
        {
            return View();
        }
    }
}

第二个家庭控制器

namespace WebApplication
{
    public class HomeController : Controller
    {
        [NamespaceConstraint]
        public IActionResult Index()
        {
            return View();
        }
    }
}

配置路由

app.UseMvc(cR =>
   cR.MapRoute("default", "{controller}/{action}", null, null, 
   new { Namespace = "WebApplication.Controllers.HomeController" }));

行动约束

namespace WebApplication
{
    public class NamespaceConstraint : ActionMethodSelectorAttribute
    {
        public override bool IsValidForRequest(RouteContext routeContext, ActionDescriptor action)
        {
            var dataTokenNamespace = (string)routeContext.RouteData.DataTokens.FirstOrDefault(dt => dt.Key == "Namespace").Value;
            var actionNamespace = ((ControllerActionDescriptor)action).MethodInfo.DeclaringType.FullName;

            return dataTokenNamespace == actionNamespace;
        }
    }
}

第一个答案:

属性路由是否会混淆 app.UseMvc() 定义的路由?

属性路由和基于约定的路由(routes.MapRoute(...)独立工作。并且属性路由比约定路由有优势。

但它似乎没有达到我想要的效果。有没有办法将路由引擎限制在某个命名空间?

开发商的答复 https://github.com/aspnet/Routing/issues/217#issuecomment-146598807:

我们建议使用区域,而不是使用命名空间列表来对控制器进行分组。您可以将控制器(无论它们位于哪个程序集中)归因于特定区域,然后为该区域创建路线。

您可以在此处查看一个测试网站,其中显示了在 MVC 6 中使用区域的示例:https://github.com/aspnet/Mvc/tree/dev/test/WebSites/RoutingWebSite https://github.com/aspnet/Mvc/tree/dev/test/WebSites/RoutingWebSite.

使用区域和基于约定的路由的示例

控制器:

//Reached through /admin/users
//have to be located into: project_root/Areas/Admin/
[Area("Admin")]
public class UsersController : Controller
{

}

配置基于约定的路由:

 app.UseMvc(routes =>
 {
         routes.MapRoute(
         "areaRoute",
         "{area:exists}/{controller}/{action}",
         new { controller = "Home", action = "Index" });
 }

使用具有基于属性的路由的区域的示例

//Reached through /admin/users
//have to be located into: project_root/Areas/Admin/
[Area("Admin")]
[Route("[area]/[controller]/[action]", Name = "[area]_[controller]_[action]")]
public class UsersController : Controller
{
    
}
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

限制路由到 ASP.NET Core 中的控制器命名空间 的相关文章

随机推荐