Extending the MVC framework

Question

I have an MVC application with some basic routes and routes can be registered dynamiccly (although), that's the id.

I just have basic MVC implementation for the routes:

public class RouteConfig
{
    #region Methods

    /// <summary>
    ///     Registers the routes.
    /// </summary>
    /// <param name="routes">The <see cref="RouteCollection" /> to which the routes will be added.</param>
    public static void RegisterRoutes(RouteCollection routes)
    {
        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

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

    #endregion
}

Now, I would like something so that it's easy to add routes to the application, but you cannot toutch the source code above for registering routes.

I was thinking about an interface somewhere and that the RouteConfig class will search all the assemblies for classes that implements this interface and than execute the logic defined in there to register the routes, but I do have the feeling that this isn't the correct approach.

I tought about something like this:

Create an interface that defines the way to register routes:

public interface IMvcRouteExtender
{
    #region Methods

    /// <summary>
    ///     Register routes for the application.
    /// </summary>
    /// <param name="routes">The <see cref="RouteCollection"/> that contains all the required routes.</param>
    void RegisterRoutes(RouteCollection routes);

    #endregion
}

Create a class that implements this interface to register the required routes

public class RouteConfig : IMvcRouteExtender
{
    #region IMvcRouteExtender

    /// <summary>
    ///     Registers the routes.
    /// </summary>
    /// <param name="routes">The <see cref="RouteCollection" /> to which the routes will be added.</param>
    public void RegisterRoutes(RouteCollection routes)
    {
        routes.MapRoute("Default", "pensions/save-and-pension", new { controller = "Home", action = "Index", id = UrlParameter.Optional });
    }

    #endregion
}

But now the issue, how can I make sure that first the IgnoreRoute registration is done, and then calling this class and then registers the rest of the routes?

This all without having strong references between the 2 route configurations?

Has anyone faced something like this and is willing to help me?

I want to avoid tight coupling the RouteConfig to another assembly.

As the SOLID principles say, the system must be open for extension, but closed for modification.

Any help is highly appreciated.

Answer 1

You could easily write the code in your sample like this:

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

    GlobalConfiguration.Configuration.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { id = RouteParameter.Optional });

    RouteTable.Routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

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

So you don't change code in RouteConfig class. Ofcourse this is not a best practice though...

Edit: Updated question's answer is in this link: How to register routes that have been defined outside Global.asax

Edit2 Please provide those steps, if you want do whatever SOLID princible says...;

1. Under your solution, create a new project .net library called "CoreRoutes"
2. Implement routes in there... ( Just abstract new class, let's say "CoreLibraryRoutes" from the routes class. )
3. Put application start - "searching and registering routes function" in the core app like link below but THE KEY IS; Define it like if a class inherited from CoreLibraryRoutes class... This is a way to do it without performance errors etc.
4. Now, you can use it without any loss...

I can't make/provide source code because you should try it to learning more... But, if you will not make it whatever you do; Then I can write it for you.

Good luck...

Answer 2

WebActivator is probably what you're looking for. This will let you create an assembly, with your routes specified within & a method marked to run when the application starts that will load your routes.