使用Expression做Linq的參數化排序

Linq非常的好用，減少大量的資料庫操作手序，使用具名的類別，減少了在程式中寫SQL寫錯字的可能性，問題來了，如果我想用QueryString中的參數，作為排序的依據，但是因為是具名的類別，不能指定字串，剛開始我是用switch一個一個指定，但欄位一多就覺得這方法很笨，在搜尋更好的方法中發現使用System.Linq.Expressions.Expression可以決解這個問題。 如果各位有仔細看，會發現System.Linq.Queryable下的Method參數都有Expression，如本篇要用的OrderBy。

public static IOrderedQueryable<TSource> OrderBy<TSource, TKey>(this IQueryable<TSource> source, Expression<Func<TSource, TKey>> keySelector);
public static IOrderedQueryable<TSource> OrderBy<TSource, TKey>(this IQueryable<TSource> source, Expression<Func<TSource, TKey>> keySelector, IComparer<TKey> comparer);
public static IOrderedQueryable<TSource> OrderByDescending<TSource, TKey>(this IQueryable<TSource> source, Expression<Func<TSource, TKey>> keySelector);
public static IOrderedQueryable<TSource> OrderByDescending<TSource, TKey>(this IQueryable<TSource> source, Expression<Func<TSource, TKey>> keySelector, IComparer<TKey> comparer);

 

那什麼是Expression呢?

簡單說是動態產生Delegate，真的執行的時候才Compile，你會說在Visaul Studio明明就Compile啦，怎麼又到執行才Compile?

實際上在Visaul Studio Compile時，會先編成Expression，等到執行時再將Expression Compile成Delegate，如下面範例。

//在Visual Studio這樣寫的東西。
.OrderBy(x=>x.Name);
//Compile後其實是編成Expression(從.Net Reflector中取得後，有修改成易讀格式)。
Parameter p = Expression.Parameter(typeof(type), "x");// 參數X
Expression.Lambda<Func<type, string>>(Expression.Property(p, "Name"), p)); 
// x.Name//並不是所有的Lambda都會編成Expression，而是只有參數是Expression才會編成Expression，其他的還是直接編成Method。

 

想更了解Expression的朋友可以參考，下面的文章。

System.Linq.Expressions 命名空間

EXPRESSION TREES, TAKE TWO – INTRODUCING SYSTEM.LINQ.EXPRESSIONS V4.0

Building LINQ Queries at Runtime in C#

初识System.Linq.Expressions

 

所以也可以自己產生Expression做OrderBy的參數，範例如下:

if (!string.IsNullOrEmpty(this.Request.QueryString["Order"])){
   // 產生Expression
   var param = Expression.Parameter(typeof(Project), "x");
   var orderExpression = Expression.Lambda<Func<Project, object>>(Expression.Property(param, this.Request.QueryString["Order"]), param);
   if (this.Request.QueryString["OrderDirection"] == "Desc")
   {
       query = query.OrderByDescending(orderExpression);
   }
   else
   {
       query = query.OrderBy(orderExpression);
   }
}

 

但上面的範例遇到遇到nullable的型別會掛到所以又寫了幾個Extension來使用

public static class IQueryableExtension
{
    private static MethodInfo orderbyInfo = null;
    private static MethodInfo orderbyDecInfo = null;

    public static IQueryable<T> OrderBy<T>(this IQueryable<T> query, string property) where T : class
    {   
        Type entityType = typeof(T);
        Type entityPropertyType = entityType.GetProperty(property).PropertyType;

        var orderPara = Expression.Parameter(entityType, "o");
        var orderExpr = Expression.Lambda(Expression.Property(orderPara, property), orderPara);

        if (orderbyInfo==null)
        {
            //因為呼叫OrderBy需要知道型別，不知道的情況下無法直接呼叫，所以用反射的方式呼叫
            //泛型的GetMethod很難，所以用GetMethods在用Linq取出Method，找到後快取。
            orderbyInfo = typeof(Queryable).GetMethods().Single(x => x.Name == "OrderBy" && x.GetParameters().Length == 2);
        }

        //因為是泛型Mehtod要呼叫MakeGenericMethod決定泛型型別
        return orderbyInfo.MakeGenericMethod(new Type[] { entityType, entityPropertyType }).Invoke(null, new object[] { query, orderExpr }) as IQueryable<T>;
    }

    public static IQueryable<T> OrderByDescending<T>(this IQueryable<T> query, string property)
    {
        Type entityType = typeof(T);
        Type entityPropertyType = entityType.GetProperty(property).PropertyType;

        var orderPara = Expression.Parameter(entityType, "o");
        var orderExpr = Expression.Lambda(Expression.Property(orderPara, property), orderPara);

        if (orderbyDecInfo == null)
        {
            orderbyDecInfo = typeof(Queryable).GetMethods().Single(x => x.Name == "OrderByDescending" && x.GetParameters().Length == 2);
        }

        return orderbyDecInfo.MakeGenericMethod(new Type[] { entityType, entityPropertyType }).Invoke(null, new object[] { query, orderExpr }) as IQueryable<T>;
    }
}