IQueryable和IQueryProvider初嘗

前言

      相信大家對Entity Framework一定不陌生，我相信其中Linq To Sql是其最大的亮點之一，但是我們一直使用到現在卻不曾明白內部是如何實現的，今天我們就簡單的介紹IQueryable和IQueryProvider。

 

IQueryable接口

      我們先聊聊這個接口，因為我們在使用EF中經常看到linq to sql語句的返回類型是IQueryable，我們可以看下這個接口的結構：

public interface IQueryable : IEnumerable
{
      Type ElementType { get; }
      Expression Expression { get; }
      IQueryProvider Provider { get; }
}

 

 

      或許會有人很奇怪，當我們在開發過程中使用這個接口的時候，提供的方法遠遠不止這么點，因為微軟提供了強大的Queryable類，當然大家不要以為這個類是實現IQueryable然后實現了很多方法，如果是那樣那些第三方庫怎么自定義呢？所以Queryable只是一個靜態類，對IQueryable接口進行了擴展，下面是筆者在.Net Reflector截圖中一部分：

 

      如果讀者細心一點會發現linq to sql並不會導致實際的查詢，只有當我們真正開始使用的時候才從數據庫中開始查詢數據。

 

IQueryProvider接口

      如果我們調試的EF的話，會看到生成的T-SQL語句。T-SQL就是根據表達式樹分析從而得出的，而核心就是IQueryProvider接口，下面就是該接口的結構：

public interface IQueryProvider
{
        IQueryable CreateQuery(Expression expression);
        IQueryable<TElement> CreateQuery<TElement>(Expression expression);
        object Execute(Expression expression);
        TResult Execute<TResult>(Expression expression);
}

 

      其中CreateQuery就是負責解析表達式樹的，當然還要將處理后的結果返回，以便接着分析下面的語句，當然這中間只是分析，你完全可以根據表達式樹得出你自己需要的查詢語句，比如SQL或者其他什么，只有在真正使用數據的時候才會調用Execute方法，這個時候就可以根據我們自己分析的語句開始進行實際的查詢了。

 

實例分析

 

QueryProvider類

      光說不練我們永遠不能明白其中的原理，所以下面我們就簡單的舉一個例子來展示下。首先我們先實現IQueryProvider接口，其中會用到一個Query類，這個類會在后面進行介紹，首先我們新建一個QueryProvider類實現IQueryProvider接口，首先我們看下CreateQuery<S>方法：

 

      這里的expression就是傳遞給我們，並且需要我們處理的表達式樹，最后還要返回實現IQueryable<S>接口的示例，以便LINQ在此基礎上進行下面的查詢，這里我們僅僅只是創建了一個Query的實例，同時將expression傳遞給它，因為此處僅僅只是一個DEMO，所以我們沒有去真正解析表達式樹（這其中要做的工作很多）。接着還有CreateQuery方法：

 

我們可以看到下面這句話：

實際的含義就是創建Query<>的實例，並且泛型參數是elementType，參數是this和expression。

 

最后就是Execute方法了，傳遞一個Expression參數，並獲取最后的結果，筆者在這里直接是寫死的值：

 

Query類

      僅僅只有QueryProvider還沒用，我們還需要一個能夠保存表達式樹狀態的類，當然也包括了我們解析表達式后的結果也可以保存在其中，這樣我們在IQueryProvider的Execute方法中就可以根據我們解析的結果執行執行並返回結果了。

 

      這里我們可以看到Query的Expression值在創建這個實例時，如果沒有傳遞Expression參數時該值就是：

 

      但是在后面的過程中Query中的Expression將是QueryProvider中的expression值。

 

      到此我們其實就完成了一個簡單的示例了，我們就可以開始測試我們的成果了，筆者在利用如下的代碼來測試：

      OK，我們開始看看是如何分析這句LINQ語句的。

 

      首先我們看下在一開始執行時Query中Expression的返回值（如下圖）：

      在獲取到這個表達式后，就開始執行Linq，首先執行的是where item == 123。

 

分析Where item == 123

     接着我們F5，就可以看到在QueryProvider中的CreateQuery<S>命中了，並且Expression參數如下圖所示：

      我們看到里面的字符串是 Where(item => (item == 123))，通過這句話我們就可以明白其實LINQ中的where實質上就是利用Where方法，並傳遞給它對應的lambda表達式。分析完了where部分，下面就是FirstOrDefault部分了。

 

分析FirstOrDefault

      當執行到FirstOrDefault的時候我們可以查看t的值，會發現t實際上就是QueryProvider中CreateQuery<S>的返回值。

 

      接着我們開始執行下面FirstOrDefault方法，發現會再一次的去獲取Expression的值，而此時Expression的值就是上面CreateQuery<T>傳遞給我們的參數expression。

 

     然后在將這個表達式樹和由表達式樹表示FirstOrDefault方法調用的值拼接起來，並調用QueryProvider中的Execute<S>方法，我們可以看到這個時候傳遞給我們的參數expression的值。

 

      至此一個簡單的流程就結束了，最后就是返回筆者寫死的123這個值了。

 

      通過上面這個例子我們基本了解了其工作的流程，下面我們將一步一步的分析我們這個where item == 123，當然我們將會用到遞歸，所以請大家整理好自己的思路，一步一步的看如何從一個表達式樹中分析這條語句。

 

分析表達式樹實戰

      首先我們一個分析表達式樹的方法，這個方法我們暫且放在QueryProvider中：

public void AnalysisExpression(Expression exp)
        {
            switch (exp.NodeType)
            {
                case ExpressionType.Call:
                    {
                        MethodCallExpression mce = exp as MethodCallExpression;
                        Console.WriteLine("The Method Is {0}", mce.Method.Name);
                        for (int i = 0; i < mce.Arguments.Count; i++)
                        {
                            AnalysisExpression(mce.Arguments[i]);
                        }
                    }
                    break;
                case ExpressionType.Quote:
                    {
                        UnaryExpression ue = exp as UnaryExpression;
                        AnalysisExpression(ue.Operand);
                    }
                    break;
                case ExpressionType.Lambda:
                    {
                        LambdaExpression le = exp as LambdaExpression;
                        AnalysisExpression(le.Body);
                    }
                    break;
                case ExpressionType.Equal:
                    {
                        BinaryExpression be = exp as BinaryExpression;
                        Console.WriteLine("The Method Is {0}", exp.NodeType.ToString());
                        AnalysisExpression(be.Left);
                        AnalysisExpression(be.Right);
                    }
                    break;
                case ExpressionType.Constant:
                    {
                        ConstantExpression ce = exp as ConstantExpression;
                        Console.WriteLine("The Value Type Is {0}", ce.Value.ToString());
                    }
                    break;
                case ExpressionType.Parameter:
                    {
                        ParameterExpression pe = exp as ParameterExpression;
                        Console.WriteLine("The Parameter Is {0}", pe.Name);
                    }
                    break;
                default:
                    {
                        Console.Write("UnKnow");
                    }
                    break;
            }
        }

 

 

並在CreateQuery<S>中調用這個方法

      然后我們可以開始運行測試了，為了能夠讓讀者明白當前處理的表達式樹，所以在下面的截圖中將會包含AnalysisExpression中參數exp的值，這樣可以便於讀者區分當前處理的表達式樹。

 

PS：Expression類型中的NodeType是非常重要的，因為傳遞給我們的都是父類Expression類型，而我們需要根據NodeType的轉換成對應的子類，這樣我們才能夠獲取到更詳細的信息。

 

ExpressionType.Call

      我們根據一開始的exp的NodeType進入到這個分支，因為where實質上就是ss調用where方法，所以我們通過將exp轉換成對應的MethodCallExpression類型，這樣我們就可以看到調用的方法名稱了。

      當然調用一個方法必須要有參數，所以下面還需要循環Arguments去分析具體的參數，其中也包括調用這個方法的對象，自然我們首先是分析調用這個方法的對象，這里我們進行了第一次的遞歸調用，跳到了ExpressionType.Constant。

 

ExpressionType.Constant

      NodeType為這個類型，我們就可以通過ConstantExpression類型來獲取對應的參數，通過Value我們可以可以獲取到調用where方法的對象，當然到這里就不會繼續往下分析了。

 

    所以我們繼續跳到之前的for循環，開始分析第二個參數，就是 item => item == 123這個部分了。

 

ExpressionType.Quote

      如果接觸過lambda的人可能會認為類型應該是Lambda，但實際上不會直接跳轉到那，而是先跳轉到Quote，然后我們再把轉換成UnaryExpression類型，然后再繼續分析其中Operand屬性，而這個屬性的NodeType就是Lambda了。個人認為這個應該是區分lambda和普通的方法，因為where不僅僅可以接收lambda同時也可以是常規的方法，所以這里還需要這一層。

 

ExpressionType.Lambda

跳轉到這，大家就不會感覺奇怪了，這里為了簡潔。筆者並沒有分析參數，而是直接分析Body部分，因為這部分才是我們的關鍵。

 

ExpressionType.Equal

      我們看到這個lambda很簡單，就是一個相等比較，所以直接跳轉到了Equal，當然還有And、Or等對應的枚舉，而到了這一步我們就可以直接分析Left和Right，當然這里還有一個小插曲，就是在跳到這個枚舉的時候我查看exp的類型時，實際上是LogicalBinaryExpression類型，並不是BinaryExpression類型，然后用Reflector查看了下，我就呵呵了。

 

      我當時還奇怪，怎么沒有這個類型呢，最后才知道玩的是這一出。到此為止，我們繼續分析這個相等操作的左右兩邊的參數吧。

首先分析的是左邊參數item。

 

ExpressionType.Parameter

      Item挑傳到這，並將其轉換成ParameterExpression類型，筆者在此僅僅只輸出了參數的名稱。

到這左邊的參數分析完畢，我們開始分析右邊的參數。

 

ExpressionType.Constant

      我們可以輕松的想到對應的Value就是123了，到此整個表達式就分析完畢了。

 

我們看看最后控制台的輸出結果吧。

 

      在此筆者還要聲明一個問題，就是我們應該去理解我們使用的各種庫的原理，這樣便於我們以后添加符合實際開發的一些功能，當然這並不是浪費時間。而是提高今后項目開發的時間，隨着不斷的積累，我們會發現很多重復的功能並不需要我們去重復寫了，而節省下來的時間我們就可以做自己想做的事了，所以我們要做一個有思想的懶程序員。

 

源碼下載