AspにNet MVCおよびWebApiルーティング優先度の追加

30835 ワード

一、なぜルーティング優先度が必要なのか
私たちがAspにいることはみんな知っています.Net MVCプロジェクトまたはWebApiプロジェクトにルーティングを登録するのは優先度がありません.プロジェクトが大きい場合、または複数の領域がある場合、または複数のWebプロジェクトがある場合、またはプラグインフレームワークで開発されている場合、私たちのルーティング登録は1つのファイルに書かれているのではなく、多くの異なるプロジェクトのファイルに分散している可能性があります.これにより、ルーティングの優先度の問題が明らかになります.
例えば、App_Start/RouteConfig.cs中
routes.MapRoute(
    name: "Default",
    url: "{controller}/{action}/{id}",
    defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
);

Areas/Admin/AdminAreaRegistration.cs中
context.MapRoute(
    name: "Login",    
url: "login", defaults: new { area = "Admin", controller = "Account", action = "Login", id = UrlParameter.Optional }, namespaces: new string[] { "Wenku.Admin.Controllers" } );

上の共通のdefaultルーティングを先に登録し、このloginのルーティングを登録すると、いずれにしても、最初の条件を満たすルーティング、すなわち2番目のルーティング登録が無効になります.この問題の原因は、この2つのルーティング登録の順序の問題であり、Asp.Net MVCやWebApiではルーティングの登録に優先度という概念はありませんので、今日はルーティングの登録時に優先度の概念を加えることを自分で実現します.
二、解決構想
1、まずルート登録の入り口を分析し、例えばmvc 4を新設する.0の項目
public class MvcApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        AreaRegistration.RegisterAllAreas();

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

Mvcルーティングの登録エントリは2つある:a.AreaRegistration.RegisterAllAreas();登録エリアルーティングb.RouteConfig.RegisterRoutes(RouteTable.Routes);プロジェクトルーティングの登録
WebApiルーティング登録エントリには、WebApiConfigがあります.Register(GlobalConfiguration.Configuration);WebApiルーティングの登録
2、登録ルートの処理クラス分析
ルーティングを登録する際には,主にこの3つのクラスが処理ルーティングを登録する.
3、ルーティング優先度スキームa、ルーティングを変更する登録エントリb、ルーティングをカスタマイズする構造クラスRoutePriorityおよびHttpRoutePriority.この2つのクラスの下には、Priorityという属性cがあり、RegistrationContextを1つカスタマイズしてルーティングを登録し、登録対象は上記カスタムルーティングである.d、すべてのルーティング登録が完了した後、RouteCollectionおよびHttpRouteCollectionに優先順位で追加して実際に有効にする.
三、具体的な実現
1、ルート定義
public class RoutePriority : Route
{
    public string Name { get; set; }
    public int Priority { get; set; }

    public RoutePriority(string url, IRouteHandler routeHandler)
        : base(url,routeHandler)
    {

    }
}

public class HttpRoutePriority
{
    public string Name { get; set; }
    public int Priority { get; set; }
    public string RouteTemplate{get;set;}
    public object Defaults{get;set;}
    public object Constraints{get;set;} 
    public HttpMessageHandler Handler{get;set;}
}

2、ルーティング登録のインタフェースを定義する
public interface IRouteRegister
{
    void Register(RegistrationContext context);
}

3、ルーティング登録コンテキストクラスの定義
public class RegistrationContext
{
    #region mvc
    public List<RoutePriority> Routes = new List<RoutePriority>();

    public RoutePriority MapRoute(string name, string url,int priority=0)
    {
        return MapRoute(name, url, (object)null /* defaults */, priority);
    }

    public RoutePriority MapRoute(string name, string url, object defaults, int priority = 0)
    {
        return MapRoute(name, url, defaults, (object)null /* constraints */, priority);
    }

    public RoutePriority MapRoute(string name, string url, object defaults, object constraints, int priority = 0)
    {
        return MapRoute(name, url, defaults, constraints, null /* namespaces */, priority);
    }

    public RoutePriority MapRoute(string name, string url, string[] namespaces, int priority = 0)
    {
        return MapRoute(name, url, (object)null /* defaults */, namespaces, priority);
    }

    public RoutePriority MapRoute(string name, string url, object defaults, string[] namespaces,int priority=0)
    {
        return MapRoute(name, url, defaults, null /* constraints */, namespaces, priority);
    }

    public RoutePriority MapRoute(string name, string url, object defaults, object constraints, string[] namespaces, int priority = 0)
    {
        var route = MapPriorityRoute(name, url, defaults, constraints, namespaces, priority);
        var areaName = GetAreaName(defaults);
        route.DataTokens["area"] = areaName;

        // disabling the namespace lookup fallback mechanism keeps this areas from accidentally picking up
        // controllers belonging to other areas
        bool useNamespaceFallback = (namespaces == null || namespaces.Length == 0);
        route.DataTokens["UseNamespaceFallback"] = useNamespaceFallback;

        return route;
    }

    private static string GetAreaName(object defaults)
    {
        if (defaults != null)
        {
            var property = defaults.GetType().GetProperty("area");
            if (property != null)
                return (string)property.GetValue(defaults, null);
        }

        return null;
    }

    private RoutePriority MapPriorityRoute(string name, string url, object defaults, object constraints, string[] namespaces,int priority)
    {
        if (url == null)
        {
            throw new ArgumentNullException("url");
        }

        var route = new RoutePriority(url, new MvcRouteHandler())
        {
            Name = name,
            Priority = priority,
            Defaults = CreateRouteValueDictionary(defaults),
            Constraints = CreateRouteValueDictionary(constraints),
            DataTokens = new RouteValueDictionary()
        };

        if ((namespaces != null) && (namespaces.Length > 0))
        {
            route.DataTokens["Namespaces"] = namespaces;
        }

        Routes.Add(route);
        return route;
    }

    private static RouteValueDictionary CreateRouteValueDictionary(object values)
    {
        var dictionary = values as IDictionary<string, object>;
        if (dictionary != null)
        {
            return new RouteValueDictionary(dictionary);
        }

        return new RouteValueDictionary(values);
    }
    #endregion

    #region http
    public List<HttpRoutePriority> HttpRoutes = new List<HttpRoutePriority>();

    public HttpRoutePriority MapHttpRoute(string name, string routeTemplate, int priority = 0)
    {
        return MapHttpRoute(name, routeTemplate, defaults: null, constraints: null, handler: null, priority: priority);
    }

    public HttpRoutePriority MapHttpRoute(string name, string routeTemplate, object defaults, int priority = 0)
    {
        return MapHttpRoute(name, routeTemplate, defaults, constraints: null, handler: null, priority: priority);
    }

    public HttpRoutePriority MapHttpRoute(string name, string routeTemplate, object defaults, object constraints, int priority = 0)
    {
        return MapHttpRoute(name, routeTemplate, defaults, constraints, handler: null, priority: priority);
    }

    public HttpRoutePriority MapHttpRoute(string name, string routeTemplate, object defaults, object constraints, HttpMessageHandler handler, int priority = 0)
    {
        var httpRoute = new HttpRoutePriority();
        httpRoute.Name = name;
        httpRoute.RouteTemplate = routeTemplate;
        httpRoute.Defaults = defaults;
        httpRoute.Constraints = constraints;
        httpRoute.Handler = handler;
        httpRoute.Priority = priority;
        HttpRoutes.Add(httpRoute);

        return httpRoute;
    }
    #endregion
}

4、ルーティング登録処理方法をコンフィギュレーションクラスに追加する
public static Configuration RegisterRoutePriority(this Configuration config)
{
    var typesSoFar = new List<Type>();
    var assemblies = GetReferencedAssemblies();
    foreach (Assembly assembly in assemblies)
    {
        var types = assembly.GetTypes().Where(t => typeof(IRouteRegister).IsAssignableFrom(t) && !t.IsAbstract && !t.IsInterface);
        typesSoFar.AddRange(types);
    }

    var context = new RegistrationContext();
    foreach (var type in typesSoFar)
    {
        var obj = (IRouteRegister)Activator.CreateInstance(type);
        obj.Register(context);
    }

    foreach (var route in context.HttpRoutes.OrderByDescending(x => x.Priority))
        GlobalConfiguration.Configuration.Routes.MapHttpRoute(route.Name, route.RouteTemplate, route.Defaults, route.Constraints, route.Handler);

    foreach (var route in context.Routes.OrderByDescending(x => x.Priority))
        RouteTable.Routes.Add(route.Name, route);

    return config;
}

private static IEnumerable<Assembly> GetReferencedAssemblies()
{
    var assemblies = BuildManager.GetReferencedAssemblies();
    foreach (Assembly assembly in assemblies)
        yield return assembly;
}

これで大功を奏する、使用時はGlobalのみである.asax.csファイルで元の登録エントリを変更するには
public class MvcApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        WebApiConfig.Register(GlobalConfiguration.Configuration);
        FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
        RouteConfig.RegisterRoutes(RouteTable.Routes);

        Configuration.Instance()
            .RegisterComponents()
            .RegisterRoutePriority(); //       
    }
}

カスタムルーティング登録インタフェースIrouteRegisterを各プロジェクトで使用するには、次のようにします.
public class Registration : IRouteRegister
{
    public void Register(RegistrationContext context)
    {
       //          
        context.MapRoute(
          name: "Admin_Login",
          url: "Admin/login",
          defaults: new { area = "Admin", controller = "Account", action = "Login", id = UrlParameter.Optional },
          namespaces: new string[] { "Wenku.Admin.Controllers" },
          priority: 11
      );

       //            
        context.MapRoute(
            name: "Admin_default",
            url: "Admin/{controller}/{action}/{id}",
            defaults: new { area = "Admin", controller = "Home", action = "Index", id = UrlParameter.Optional },
            namespaces: new string[] { "Wenku.Admin.Controllers" },
            priority: 10
        );

       //      WebApi  
        context.MapHttpRoute(
            name: "Mobile_Api",
            routeTemplate: "api/mobile/{controller}/{action}/{id}",
            defaults: new
            {
                area = "mobile",
                action = RouteParameter.Optional,
                id = RouteParameter.Optional,
                namespaceName = new string[] { "Wenku.Mobile.Http" }
            },
            constraints: new { action = new StartWithConstraint() },
            priority: 0
        );
    }
}

四、まとめ
これは対Aspです.Net Mvcの小さな機能拡張で、小さなプロジェクトではこの機能はあまり必要ないかもしれませんが、プロジェクトが大きくなって登録されたルーティングが有効にならない場合は、ルーティング順序のせいかもしれないと考えるべきです.このとき、このルーティング優先度の機能が便利になる可能性があります.とにかく必要な友达に参考に共有します.