如何使用 MapRoute 捕获所有区域

Question

我是 MVC 的新手，正在编辑现有的应用程序。目前我在 RouteConfig.cs 中看到以下内容：

public class RouteConfig
{
    public static void RegisterRoutes(RouteCollection routes)
    {
        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

        routes.MapRoute(
            "Util",
            "util/{action}",
            new {controller = "util"});

        routes.MapRoute(
            "Catchall",
            "{*url}",
            new {controller = "Main", action = "CatchUrl"});
    }
}

在主控制器内部有一个逻辑，基本上执行 RedirectToRoute 并将区域、控制器、操作和名为 location 的查询字符串设置为特定值。

public class MainController : Controller
{
    public ActionResult CatchUrl()
    {
        var agencyId = 9;

        var routeValues = new RouteValueDictionary
        {
            {"area", "area1"},
            {"controller", "dashboard"},
            {"action", "index"},
            {"location", "testLocation"}
        };

        return RedirectToRoute(routeValues );
    }
}

这似乎工作正常，当你给它一个无效区域时，它会正确地转到默认区域。

我还看到一个名为 CustomAreaRegistration.cs:

的文件

public abstract class CustomAreaRegistration : AreaRegistration
{
    public override void RegisterArea(AreaRegistrationContext context) 
    {
        context.MapRoute(
            AreaName + "Ajax",
            AreaName + "/{controller}/{action}",
            new { action = "Index" }
        );

        context.MapRoute(
            AreaName + "ShortUrl",
            AreaName + "/{controller}",
            new {action = "Index"}
            );
    }
}

我无法理解 Area 路由的工作原理以及它如何知道如何转到正确的控制器。

此外，我正在尝试获取它，以便您访问时

/{area}/ 它执行一些逻辑并将您重定向到正确的控制器。类似于 CatchUrl 的工作方式

我的尝试：

    routes.MapRoute(
        "AreaIndex",
        "{module}/",
        new {controller = "Main", action = "Index"});

主控制器：

public class MainController : Controller
{
    public ActionResult Index()
    {
        var requestHost = HttpContext.Request.Url?.Host;
        var location= requestHost == "localhost" ? Request.QueryString["location"] : requestHost?.Split('.')[0];


        var routeValues = new RouteValueDictionary
        {
            {"area", ControllerContext.RouteData.Values["module"]},
            {"controller", "dashboard"},
            {"action", "index"},
            {"location", location}
        };

        return RedirectToRoute(routeValues );
    }

    public ActionResult CatchUrl()
    {
        var routeValues = new RouteValueDictionary
        {
            {"area", "area1"},
            {"controller", "dashboard"},
            {"action", "index"},
            {"location", "testLocation"}
        };

        return RedirectToRoute(routeValues );
    }
}

然后我得到

No route in the route table matches the supplied values.

我不确定为什么 CatchUrl 可以工作而我的不能。

Answer 1

我实际上不明白你在问什么，但通过查看代码，这不是 MVC 3,4 和 5 中 create/use Areas 的标准方法。

您不需要在每个控制器中编写逻辑并进行重定向。

在我的 RouteConfig 中，我通常只有默认路由映射。而当你有Areas的需求时，可以在Visual Studio中右击MVC web项目，点击'Add -> Area'。这将在 Web 项目根目录下的区域文件夹中创建一个具有区域名称的文件夹。在区域文件夹中，您应该找到区域名称和映射的 AreaRegistration.cs。

public class RouteConfig
{
    public static void RegisterRoutes(RouteCollection routes)
    {
        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

        routes.MapRoute(
            name: "default",
            url: "{controller}/{action}/{id}",
            defaults: new { controller = "dashboard", action = "index", id = UrlParameter.Optional },
            namespaces: new[] { "Company.Project.Web.UI.Controllers" }
        );
    }
}

假设您要创建一个名为 'Admin':

的区域

public class AdminAreaRegistration : AreaRegistration 
{
    public override string AreaName 
    {
        get 
        {
            return "admin";
        }
    }

    public override void RegisterArea(AreaRegistrationContext context) 
    {
        context.MapRoute(
            "admin_default",
            "admin/{controller}/{action}/{id}",
            new { action = "index", id = UrlParameter.Optional },
            namespaces: new[] { "Company.Project.Web.UI.Areas.Admin.Controllers" }
        );
    }
}

最后，我认为屏幕截图可能会有所帮助。

--更新--

根据评论，如果你想让路由/apple?location=home转到Apple Controller及其Home方法，而路由/orange?location=dashbard转到Orange Controller及其Dashboard方法，则更好在 RouteConfig 中定义路线。

理想情况下，您希望在 RouteConfig 中拥有这样的东西：

        routes.MapRoute(
            name: "Area-CatchAll",
            url: "{area}?location={controller}"
        );

但这是不可能的，因为 MVC 会出错并显示 "The route URL cannot start with a '/' or '~' character and it cannot contain a '?' character."。

相反，您可以将流量定向到控制器，并且可以将区域和位置定义为参数。

routes.MapRoute(
    name: "Area-CatchAll",
    url: "{area}",
    defaults: new { controller = "Area", action = "Translate" }
);

public class AreaController : Controller
{
    // The {area} from route template will be mapped to this area parameter.
    // The location query string will be mapped to this location parameter.

    public ActionResult Translate(string area, string location)
    {
        // This also assumes you have defined "index" method and
        // "dashboard" controller in each area.

        if (String.IsNullOrEmpty(location))
        {
            location = "dashboard";
        }
        return RedirectToAction("index", location, new { area = area });
    }
}

同样，如果不需要的话，我不会创建这样的路线来将流量重定向到区域。

Answer 2

I am trying to get it so that when you visit

/{area}/ it does some logic and redircts you to the correct controller. Similar to how CatchUrl works

首先要明确这一点。包罗万象的路线不是 routing，而是 redirecting。它向浏览器发出 HTTP 302 响应，告诉浏览器在您的服务器上查找新位置。这种事情不是很有效，因为它需要额外的网络往返，但这是让浏览器中的 URL 从服务器端更改的唯一方法（如果这是你想要的）做）。

路由，另一方面，接受初始请求并将其直接发送到特定资源（控制器操作）而不在不更改浏览器中的 URL 的情况下，额外的网络往返。

您的路线已经设置好可以使用

/Area/Controller

在此处路由到正确的控制器：

public abstract class CustomAreaRegistration : AreaRegistration
{
    public override void RegisterArea(AreaRegistrationContext context) 
    {
        context.MapRoute(
            AreaName + "Ajax",
            AreaName + "/{controller}/{action}",
            new { action = "Index" }
        );

        context.MapRoute(
            AreaName + "ShortUrl",
            AreaName + "/{controller}",
            new {action = "Index"}
        );
    }
}

（假设每个设置 AreaName 的区域都有一个子类）。

如果你确实想将 /module/ URL 路由（而不是重定向）到相应区域中的 DashboardController.Index 方法，你可以更改你的 ShortUrl 以使controller 可选，默认为 DashboardController.

public abstract class CustomAreaRegistration : AreaRegistration
{
    public override void RegisterArea(AreaRegistrationContext context) 
    {
        context.MapRoute(
            AreaName + "Ajax",
            AreaName + "/{controller}/{action}",
            new { action = "Index" }
        );

        context.MapRoute(
            AreaName + "ShortUrl",
            AreaName + "/{controller}",
            new { controller = "Dashboard", action = "Index" }
        );
    }
}

这会将 URL /Foo/ 发送到 Foo 区域的 DashboardController.Index 方法，但是将 URL /Foo/Bar/ 发送到 Foo 区域的 BarController.Index方法。

The above assumes that you are diligent enough to ensure that none of your AreaNames are the same as controller names in the non-area part of your project. If they are, you will never be able to reach those non-area controllers without some extra configuration such as a route constraint.

根本不需要 MainController.Index 方法（除非您有某些特定原因想要在浏览器中更改 URL）。

如何使用 MapRoute 捕获所有区域

How to catch all areas with MapRoute

c#

asp.net-mvc

asp.net-mvc-routing