Routing in ASP.Net MVC

Introduction

 

ASP.NET MVC uses ASP.NET routing to map incoming browser requests to controller action methods. It is a pattern-matching system for mapping incoming requests to specified MVC Controllers and Actions. If it fails to map the route for a incoming request then MVC will show a 404 error. ASP.NET Routing uses a route table. A route table is created when your web application first starts. When an MVC application first starts, the Application_Start() method is called. This method, in turn, calls the RegisterRoutes() method. The RegisterRoutes() method creates the route table and registers one or more route patterns to the route table. If we create an application using MVC 4 or MVC 5, it has a default route register in Route.config as in the following.

 

Global.asax File 

protected void Application_Start()
{
   AreaRegistration.RegisterAllAreas();

   WebApiConfig.Register(GlobalConfiguration.Configuration);
   FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
   RouteConfig.RegisterRoutes(RouteTable.Routes);
   BundleConfig.RegisterBundles(BundleTable.Bundles);
}

RouteConfig 

public static void RegisterRoutes(RouteCollection routes)
{
   routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
   routes.MapRoute(
   name: "Default",
   url: "{controller}/{action}/{id}",
   defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
   );
}

These lines of code would register a “Default” route with a pattern as "{controller}/{action}/{id}”. MVC also has default values for controllers and actions. That means that if we hit a URL like http:// <ApplicationDomain> / without a controller then it would get “HomeController” and “Index” as the action. If we hit a URL having only Controller name then it will get “Index” as the action. “Id” is a parameter that is passed to the action method and kept optional for this route. We saw that MVC Routing consists of the following three parts.

• Controller Name
• Action Method Name
• Parameter that is passed to the action method

Please note that in case you are registering more than one route in your application then the route name must be unique for each route. With this default route we can have the following types of URL that can be served by MVC.

Route	Controller	Action	id
http://<ApplicationDomain>/	HomeController	Index	Null
http://<ApplicationDomain>/Home/	HomeController	Index	Null
http://<ApplicationDomain>/Home/index	HomeController	Index	Null
http://<ApplicationDomain>/Home/index/10	HomeController	Index	10
http://<ApplicationDomain>/Home/index?id=10	HomeController	Index	10

We can also tell the framework to ignore some kinds of requests using routes.IgnoreRoute(). Suppose we don’t want MVC to serve the following request:

 

http://<ApplicationDomain>/Home/

http://<ApplicationDomain>/Home/index

http://<ApplicationDomain>/Home/index/10

 

For this we need to ignore that route with routes.IgnoreRoute(). 

public static void RegisterRoutes(RouteCollection routes)
{
   routes.IgnoreRoute("Home/*pathInfo}");

   routes.MapRoute(
   name: "Default",
   url: "{controller}/{action}/{id}",
   defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
);

}

Now try the entire URL listed in the above table. Only first would be served by the Server and we would get 404 for the other requests.

 

 

 

Adding Custom Route and Constraints

 

Now to test the Route constraint I have added a new controller as Department with action as Details.

public ActionResult Details(int DepartmentID)
{
return Content("received the DepartmentID as : "+ Convert.ToString(DepartmentID));
}

Now add a new route for Department as:

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

   routes.MapRoute(
   name: " Department",
   url: "Department/{DepartmentID}",
   defaults: new { controller = "Department", action = "Details"}
   );

   routes.MapRoute(
   name: "Default",
   url: "{controller}/{action}/{id}",
   defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
   );
}

Please note we should register a specific route before general route. Whenever the application receives a request the framework matches it with the fist register route in the routing table and if it is ok then directs the request to the corresponding controller and action else tries with the next route in the routing table and so on. If no route matches the incoming request then the server issues a 404 to the client.

 

Now if you hit http://localhost:[Port]/Department/[int value] then you would get output as in the following.

 

 

 

If you try to pass a string then you would get the following error. As DepartmentID is expected as Integer.

 

 

 

When adding the route we can also define the constraints to the route. We can add constraints to a route using:

• Regular expressions
• An object that implements IRouteConstraint interface 

Now we want to restrict our user to pass only a numeric value to call the same action. For this we need to add a constraint from DepartmentID. We can do it using a Regular Expression aka RegEx. We can define the constraint as DepartmentID=@"\d+". So our route becomes:

routes.MapRoute(
name: "Department",
url: "Department/{DepartmentID}",
defaults: new { controller = "Department", action = "Details" },
constraints: new { DepartmentID=@"\d+"}
);

Now again hit both URLs. First run it as-is. But the output for the second URL would change to 404 errors since MVC can’t find the matching route in the Route table.

 

 

 

Please note that it is very possible to add a RegEx constraint to any part of the Route i.d. Controller or Action or Parameter.

 

We can also create a route using IRouteConstraint. It is a member of System.Web.Routing and has one method with the signature as:

public bool Match(HttpContextBase httpContext, Route route, string parameterName, RouteValueDictionary values, RouteDirection routeDirection)

Suppose we need to restrict our user to enter a DepartmentID only in the certain range, say it should be between 20 and 30.

 

To do that we need to create a class that implements IRouteConstraint as in the following.

public class MyConstraint :IRouteConstraint
{

   public bool Match(HttpContextBase httpContext, Route route, string parameterName, RouteValueDictionary values, RouteDirection routeDir   ection)
   {
      int id=0;
      int.TryParse(values[parameterName].ToString(), out id);
      if (20 <= id && id <= 30)
      return true;
      else
      return false;
   }
}

Now we need to add this constraint with our route as in the following:

routes.MapRoute(
name: "Department",
url: "Department/{DepartmentID}",
defaults: new { controller = "Department", action = "Details" },
constraints: new { DepartmentID=new MyConstraint()}
);

Now test the constraint and see the output.