解讀ASP.NET 5 & MVC6系列（12）：基於Lamda表達式的強類型Routing實現

前面的深入理解Routing章節，我們講到了在MVC中，除了使用默認的ASP.NET 5的路由注冊方式，還可以使用基於Attribute的特性（Route和HttpXXX系列方法）來定義。本章，我們將講述一種基於Lambda表達式的強類型類型。

這種方式的基本使用示例如下：

services.Configure<MvcOptions>(opt =>
{
    opt.EnableTypedRouting();

    opt.GetRoute("homepage", c => c.Action<ProductsController>(x => x.Index()));
    opt.GetRoute("aboutpage/{name}", c => c.Action<ProductsController>(x => x.About(Param<string>.Any)));
    opt.PostRoute("sendcontact", c => c.Action<ProductsController>(x => x.Contact()));
});

從示例中可以看出，我們可以通過GetRoute或PostRoute等擴展方法來定義route，而且后面使用Lambda表達式來定Controller的類型和Action的方法。

注意，在這里獲取Action的方法名，是通過委托執行該Action方法來實現的（實際上並沒有執行，而是基於此獲取該Action的MethodInfo）。

實現原理

在Stratup.cs的ConfigureServices方法中配置services的時候，我們可以對MVC站點使用的核心配置文件MvcOptions進行配置，其中該類有一個ApplicationModelConventions屬性（List<IApplicationModelConvention>）可以保存一個IApplicationModelConvention接口的集合，改接口可以對MVC程序的程序模型進行管線處理，該接口的定義如下：

public interface IApplicationModelConvention
{
   void Apply(ApplicationModel application);
}

接口中的Apply方法所接收的參數類型是ApplicationModel，而ApplicationModel有兩個極其重要的內容可以供我們操作，一個是Controller模型集合，一個是各種Filter的集合，該類的定義如下：

public class ApplicationModel
{
    public ApplicationModel();

    public IList<ControllerModel> Controllers { get; }
    public IList<IFilter> Filters { get; }
}

這里最重要的就是ControllerModel類，該類的實例上保存了各種各樣重要而又可以操作的信息，比如該類和相關Action上的路由定義數據，API描述信息，路由約束等等，這些信息都可以進行操作。

新的IApplicationModelConvention注冊方式如下：

services.Configure<MvcOptions>(opt =>
{
   opts.ApplicationModelConventions.Add(new MyApplicationModelConvention());
});

所以我們可以利用這個方法，在合適的時機對整個MVC的程序模型做響應的調整和修改，本章節中的強類型路由就是利用這個特性來實現的。

實現步驟

首先定義一個強類型的路由模型TypedRouteModel類，該類要繼承於AttributeRouteModel，AttributeRouteModel類是基於Attribute路由的基本模型，TypedRouteModel類的代碼如下：

public class TypedRouteModel : AttributeRouteModel
{
    public TypedRouteModel(string template)
    {
        Template = template;
        HttpMethods = new string[0];
    }

    public TypeInfo ControllerType { get; private set; }

    public MethodInfo ActionMember { get; private set; }

    public IEnumerable<string> HttpMethods { get; private set; }

    public TypedRouteModel Controller<TController>()
    {
        ControllerType = typeof(TController).GetTypeInfo();
        return this;
    }

    public TypedRouteModel Action<T, U>(Expression<Func<T, U>> expression)
    {
        ActionMember = GetMethodInfoInternal(expression);
        ControllerType = ActionMember.DeclaringType.GetTypeInfo();
        return this;
    }

    public TypedRouteModel Action<T>(Expression<Action<T>> expression)
    {
        ActionMember = GetMethodInfoInternal(expression);
        ControllerType = ActionMember.DeclaringType.GetTypeInfo();
        return this;
    }

    private static MethodInfo GetMethodInfoInternal(dynamic expression)
    {
        var method = expression.Body as MethodCallExpression;
        if (method != null)
            return method.Method;

        throw new ArgumentException("Expression is incorrect!");
    }

    public TypedRouteModel WithName(string name)
    {
        Name = name;
        return this;
    }

    public TypedRouteModel ForHttpMethods(params string[] methods)
    {
        HttpMethods = methods;
        return this;
    }
}

該類主要的功能是：定義支持傳入Controller類型，支持鏈式調用。

然后再定義一個繼承IApplicationModelConvention接口的TypedRoutingApplicationModelConvention類。代碼如下：

public class TypedRoutingApplicationModelConvention : IApplicationModelConvention
{
    internal static readonly Dictionary<TypeInfo, List<TypedRouteModel>> Routes = new Dictionary<TypeInfo, List<TypedRouteModel>>();

    public void Apply(ApplicationModel application)
    {
        foreach (var controller in application.Controllers)
        {
            if (Routes.ContainsKey(controller.ControllerType))
            {
                var typedRoutes = Routes[controller.ControllerType];
                foreach (var route in typedRoutes)
                {
                    var action = controller.Actions.FirstOrDefault(x => x.ActionMethod == route.ActionMember);
                    if (action != null)
                    {
                        action.AttributeRouteModel = route;
                        //注意這里是直接替換，會影響現有Controller上的Route特性定義的路由
                        foreach (var method in route.HttpMethods)
                        {
                            action.HttpMethods.Add(method);
                        }
                    }
                }
            }
        }
    }
}

在該類中，保存了一個靜態變量Routes，用於保存所有以Lamda表達式方式聲明的路由，然后在現有的Controllers集合中進行查找及修改，然后替換AttributeRouteModel屬性，並設置響應的Http Method（如果不設置，則默認所有的方式都允許）。

在這里，我們只是簡單替換action.AttributeRouteModel，所以會導致一些缺陷（比如一個Action只能支持一個路由路徑，以最后一個為准），各位同學可以根據自己的能力進行優化。

優化的時候，要注意Controller上的Route集合保存在controller.Attributes屬性上，Action上的Route集合保存在action.Attributes屬性上，可以對其進行優化。

然后，在MvcOptions上，我們再為TypeRouteModel添加一些擴展方法以方便使用，代碼如下：

public static class MvcOptionsExtensions
{
    public static TypedRouteModel GetRoute(this MvcOptions opts, string template, Action<TypedRouteModel> configSetup)
    {
        return AddRoute(template, configSetup).ForHttpMethods("GET");
    }

    public static TypedRouteModel PostRoute(this MvcOptions opts, string template, Action<TypedRouteModel> configSetup)
    {
        return AddRoute(template, configSetup).ForHttpMethods("POST");
    }

    public static TypedRouteModel PutRoute(this MvcOptions opts, string template, Action<TypedRouteModel> configSetup)
    {
        return AddRoute(template, configSetup).ForHttpMethods("PUT");
    }

    public static TypedRouteModel DeleteRoute(this MvcOptions opts, string template, Action<TypedRouteModel> configSetup)
    {
        return AddRoute(template, configSetup).ForHttpMethods("DELETE");
    }

    public static TypedRouteModel TypedRoute(this MvcOptions opts, string template, Action<TypedRouteModel> configSetup)
    {
        return AddRoute(template, configSetup);
    }

    private static TypedRouteModel AddRoute(string template, Action<TypedRouteModel> configSetup)
    {
        var route = new TypedRouteModel(template);
        configSetup(route);

        if (TypedRoutingApplicationModelConvention.Routes.ContainsKey(route.ControllerType))
        {
            var controllerActions = TypedRoutingApplicationModelConvention.Routes[route.ControllerType];
            controllerActions.Add(route);
        }
        else
        {
            var controllerActions = new List<TypedRouteModel> { route };
            TypedRoutingApplicationModelConvention.Routes.Add(route.ControllerType, controllerActions);
        }

        return route;
    }

    public static void EnableTypedRouting(this MvcOptions opts)
    {
        opts.ApplicationModelConventions.Add(new TypedRoutingApplicationModelConvention());
    }
}

在上述代碼中，我們添加了一個EnableTypedRouting擴展方法，以便向MvcOptions.ApplicationModelConventions屬性上添加新的TypedRoutingApplicationModelConvention類型示例。

其它的擴展方法則都是用於聲明相關的route，大家注意，在最開頭的示例中，我們看到獲取action信息的方法是通過委托調用該action方法（但沒有真正調用），但是有的方法有參數，那怎么辦呢？為此，我們定於一個忽略參數的Param類，代碼如下：

public static class Param<TValue>
{
    public static TValue Any
    {
        get { return default(TValue); }
    }
}

這樣，我們為含有參數的About方法定於路由的時候，就可以這樣來定義了，代碼如下：

opt.GetRoute("aboutpage/{name}", c => c.Action<HomeController>(x => x.About(Param<string>.Any)));

另外，由於TypeRouteModel里很多方法都是可以鏈式調用，所以我們也可以通過這種方式為route指定一個名稱，示例代碼如下：

opt.GetRoute("homepage", c => c.Action<HomeController>(x => x.Index())).WithName("foo");

至此，整個強類型路由的功能就實現完畢了，大家在使用的時候，就多了一種選擇了。

弊端（或Bug)

我們看到，在上面實現IApplicationModelConvention接口的時候，我們只是簡單的對action.AttributeRouteModel進行替換，也就是說，如果你在Action上已經了Route特性的話，他會把你的信息給你覆蓋掉，從而導致你的route失效。比如，如果你定義了一個這樣的自定義路由：

public class ProductsController : Controller
{
    [Route("index")]
    public IActionResult Index()
    {
        return Content("Index");
    }
}

然后又通過Lamda表達式又定義了強類型路由，代碼如下：

opt.GetRoute("homepage", c => c.Action<ProductsController>(x => x.Index()));

那么，你只能通過/homepage開來訪問，而不能通過/index來訪問了，因為它把你的Route給你覆蓋掉了。

但是，上述Lamda表達式方式並沒有覆蓋Controller上定義的Route特性定義，所以如果你在ProductsController上定義了Route特性的話，兩者就會組合在一起，例如：

[Route("products")]
public class ProductsController : Controller
{    
    public IActionResult Index()
    {
        return Content("Index");
    }
}

那么你的訪問網址應該是/products/homepage，而不是/homepage。不過如果你在Lamda表達式方式里的代碼，是如下這樣的話：

opt.GetRoute("/homepage", c => c.Action<ProductsController>(x => x.Index()));

那你的訪問網址就應該是/homepage了，因為該路由字符是絕對路徑/homepage，而不是homepage。

參考：http://www.strathweb.com/2015/03/strongly-typed-routing-asp-net-mvc-6-iapplicationmodelconvention/

同步與推薦

本文已同步至目錄索引：解讀ASP.NET 5 & MVC6系列