前言

DbUtility v3 是一個開源的輕量級資料庫訪問框架，原始碼通過 Apache 協議釋出，可以用於商業用途。最新的版本可以通過 NuGet 進行下載，專案及原始碼下載地址：

DbUtility 第一個版本公開於七年前，關於 DbUtility 的歷史和 DbUtility 的使用，請參考下面這篇部落格：

作為一個開源專案，DbUtility 不僅僅致力於幫助大家簡化資料庫訪問，也非常歡迎和期待大家的共同參與，不論是提交 Bug 或者單元測試，或是新的特性需求，以及自己動手為 DbUtility 增加更多有趣的功能，都是參與開源專案的方式。這篇文章面向所有有志於為 DbUtility 增添自定義功能的程式設計師，介紹 DbUtility 的擴充套件架構。

基本結構

DbUtility v3 相較於之前版本的最大區別，也是 DbUtility v3 傲視其他輕量級資料庫訪問框架的地方，就是其優良的擴充套件架構。正如之前的介紹所述，DbUtility 將一個數據庫查詢分為三個部分：

• 查詢執行器
• 查詢構建器
• 結果構建器

這三個部分各有一個關鍵的介面，分別為：

• IDbExecutor where T : IDbQuery 定義某種型別查詢的查詢執行器。
• IDbQuery 定義特定的資料庫查詢
• IDbExecuteContext 定義資料庫查詢執行上下文，其中包括 DataReader 物件。

譬如說 SqlDbUtility 型別便是面向 SQL Server 資料庫的查詢執行器實現型別，其宣告為：

public class SqlDbUtility :
  IAsyncDbExecutor<ParameterizedQuery>,
  IAsyncDbExecutor<StoredProcedureQuery>,
  IDbTransactionProvider<SqlDbUtility>

IAsyncDbExecutor 是 IDbExecutor 的非同步版本，表示可以非同步執行指定型別的查詢。可以看出來SqlDbUtility實現了兩個查詢執行器介面，分別是 IAsyncDbExecutor<ParameterizedQuery>

擴充套件查詢構建器

接下來我們嘗試擴充套件一個查詢構建方法，就像T( "SELECT * FROM Users" )一樣。

假定我們經常會遇到一個場景，需要獲取某個表的所有資料，如果直接使用T來構建引數化查詢，則所需寫的SQL語句很多： SELECT * FROM TableName ，我們希望簡化為 DT( "TableName" ) 的形式，該如何做呢？

首先我們要確定我們是否需要構建一種新的查詢型別，因為構建新的查詢型別，需要同時修改查詢執行器，在本例中暫不涉及這麼深入的問題。我們假定暫且借用引數化查詢物件，只是簡化其生成程式碼。

那麼首先我們需要了解的一個事實是，所有的查詢構建方法其實都是擴充套件方法，針對特定的查詢執行器，對其進行擴充套件。如果我們生成的是一個引數化查詢，那麼我們需要一個引數化查詢執行器才能執行，所以我們要針對引數化查詢執行器進行擴充套件。首先新建一個擴充套件方法所需的靜態型別：

public static class MyExtensions
{

}

值得注意的是定義擴充套件方法的型別必須是靜態型別。

然後我們新增一個擴充套件方法，因為我們最終生成的查詢型別是引數化查詢，所以我們需要對可以執行引數化查詢的物件進行擴充套件，像這樣：

public static void DT( this IDbExecutor<ParameterizedQuery> executor, string tableName )
{
  throw new NotImplementedException();
}

請注意我這邊的返回值型別還沒有填寫，因為這裡涉及到另一個問題，單純的查詢物件是不能被執行的，為了達到 db.DT( "Users" ).ExecuteDataTable() 這樣的效果，我們需要把查詢物件和查詢執行器捆綁起來，這個捆綁後的物件的型別為 IDbExecutableQuery （意為可執行的查詢），所以我們需要把返回值設定為 IDbExecutableQuery 型別：

public static IDbExecutableQuery DT( this IDbExecutor<ParameterizedQuery> executor, string tableName )
{
  throw new NotImplementedException();
}

DbUtility 已經為我們提供了現成的 IDbExecutableQuery 的實現，即 DbExecutableQuery<T> 型別，我們只需要構建一個查詢物件，再連同查詢執行器一起呼叫這個型別的建構函式即可：

public static IDbExecutableQuery DT( this IDbExecutor<ParameterizedQuery> executor, string tableName )
{
  ParameterizedQuery query = null;
  return new DbExecutableQuery<ParameterizedQuery>( executor, query );
}

最後，我們需要構建一個引數化查詢物件，引數化查詢物件作為基礎查詢物件，有很多種方式來構建，最常見的就是利用模板來構建，如果直接呼叫 db.T 方法，事實上構建出來的是 DbExecutableQuery<ParameterizedQuery> 型別的物件，好在系統提供了一個靜態型別 Db 來對這些常見任務提供支援：

public static IDbExecutableQuery DT( this IDbExecutor<ParameterizedQuery> executor, string tableName )
{
  ParameterizedQuery query = Db.T( "SELECT * FROM " + tableName );
  return new DbExecutableQuery<ParameterizedQuery>( executor, query );
}

至此，我們的第一個擴充套件就已經完成了，馬上來試一下：

  var db = SqlDbUtility.Create( "Database" );
  var data = db.DT( "Users" ).ExecuteDataTable();

尾聲

事實上你知道嗎，db.T 這個方法，其內部實現就是這樣的
以下摘自DbUtility v3原始碼：

public static DbExecutableQuery<ParameterizedQuery> Template( this IDbExecutor<ParameterizedQuery> executor, string template, params object[] parameters )
{
  return new DbExecutableQuery<ParameterizedQuery>( executor, TemplateParser.ParseTemplate( template, parameters ) );
}
public static DbExecutableQuery<ParameterizedQuery> T( this IDbExecutor<ParameterizedQuery> executor, string template, params object[] parameters )
{
  return Template( executor, template, parameters );
}

接下來，我們把這個方法再進一步擴充套件，我們希望使用者呼叫這個方法的時候，不再返回一個可執行的查詢物件，而是直接執行查詢，並將 DataTable 返回就好了，相信聰明的你應該很快就能想到怎樣寫了：

  public static class MyExtensions
  {
    public static DataTable DT( this IDbExecutor<ParameterizedQuery> executor, string tableName )
    {
      ParameterizedQuery query = Db.T( "SELECT * FROM " + tableName );
      return new DbExecutableQuery<ParameterizedQuery>( executor, query ).ExecuteDataTable();
    }
  }

沒錯，藉助優秀的可擴充套件架構，DbUtility可以被任意改造為任何你所喜歡 API 的形式，這種逆天的擴充套件性，是深深的植入在 DbUtility 整體架構模型設計中的。構成了 DbUtility 無與倫比的體驗。