創建代碼生成器可以很簡單：如何通過T4模板生成代碼？[下篇]

作者: Artech 來源: 博客園發布時間: 2010-10-28 11:09 閱讀: 1487 次推薦: 1 原文鏈接 [收藏]

　　在《上篇》中我們通過T4模板為我們指定的數據表成功生成了我們需要的用于添加、修改和刪除操作的存儲過程。但是這是一種基于單個文件的解決方案，即我們必須為每一個生成的存儲過程建立一個模板。如果我們提供一種基于多文件的代碼生成方式，將會為編程人員帶來極大的便利。借助于T4 ToolBox這個開源工具箱，多文件的SQL Generator的實現變得異常簡單。

　　一、多文件代碼生成器會帶來多大的便利？

　　我們先來直觀的感受一下較之《上篇》提供的單一文件的代碼生成器，基于多文件的代碼生成解決方案會為開發人員帶來多大的便利。同樣對于《上篇》創建的數據表T_PRODUCT，之前我們為了生成三個不同的存儲過程，我們不得已需要創建3個不同的T4模板文件。實際上我們更需要的方式只需要創建一個T4模板，讓我們的SQL Generator自動為我們生成3個包含相應存儲過程的.sql附屬文件,如左圖所示（點擊看大圖）。

　　有的時候，基于單個數據表的存儲過程生成方式我們依然覺得不方便。如果我們能夠在T4模板文件中指定的數據表的列表，讓我們的SQL Generator為列表的每一個數據表都生成CUD三個存儲過程，這樣的方式更加具有吸引力。如右圖所示（點擊看大圖），一個訂單模塊包含兩個具有主子關系的兩張表（T_ORDER和T_ORDER_DETAIL），現在我們在一個T4模板中指定這兩個表明，通過SQL Generator可以幫助我們生成6個包含存儲過程的.sql附屬文件。

　　甚至有的時候我們連數據表列表都無需指定，讓SQL Generator為所有的表都生成相應的存儲過程。我的例子中沒有提供這樣的功能，但是實現自來不會存在任何問題。

　　二、創建自定義的Generator

　　在《上篇》中我創建了一個抽象的ProcedureTemplate類，以及三個基于生成CUD存儲過程的具體ProcedureTemplate： InsertProcedureTemplate、UpdateProcedureTemplate和DeleteProcedureTemplate。它們都將直接服務于我們今天將要提供的基于多文件的SQL Generator。

　　在《上篇》中，這四個Template分別定義在4個不同的TT文件中，3個具體的ProcedureTemplate通過<#@include>指令將抽象ProcedureTemplate模板文件包含過來。由于我們將要創建的T4模板將會使用到這四個類，如果我們用四個<#@include>指令將四個TT文件包含過來，由于T4引擎將會導致對ProcedureTemplate的4次包含，最好將會導致變異問題。個人覺得這應該算是T4引擎解析包含關系的一個局限性，為了解決這個問題我們不得不抽象的ProcedureTemplate和三個具體的ProcedureTemplate都合并成一個TT文件。

　　T4 ToolBox為類庫中為了提供了一個抽象的T4Toolbox.Generator類用于實現多文件的代碼生成。為此我們創建一個TT模板文件，定義了如下一個繼承自該類的ProcedureGenerator。ProcedureGenerator的核心是通過屬性Templates定義的類型為IEnumerable<ProcedureTemplate>的ProcedureTemplate列表，這個列表在存儲過程中進行初始化。而對于ProcedureGenerator的構造函數，處理定義了一個表示數據庫連接字符串的databaseName的參數外，要以數組參數的形式指定了生成的存儲過程基于的數據表名的列表。

<#@ import namespace="System.Collections.Generic" #>
<#@ include file="ProcedureTemplate.tt" #>
<#@ include file="T4Toolbox.tt" #>
<#+
public class ProcedureGenerator : Generator
{
public IEnumerable<ProcedureTemplate> Templates{get; private set;}

public ProcedureGenerator(string databaseName, params string[] tableNames)
{
if(null == tableNames || tableNames.Length == 0)
{
throw new ArgumentNullException("tableNames");
}

this.Templates = InitlizeTemplates(databaseName,tableNames);
}

private IEnumerable<ProcedureTemplate> InitlizeTemplates(string databaseName, string[] tableNames)
{
foreach(string tableName in tableNames)
{
yield return new InsertProcedureTemplate(databaseName, tableName);
yield return new UpdateProcedureTemplate(databaseName, tableName);
yield return new DeleteProcedureTemplate(databaseName, tableName);
}
}

protected override void RunCore()
{
foreach(ProcedureTemplate tempalte in this.Templates)
{
tempalte.RenderToFile(tempalte.GetProcedureName() + ".sql");
}
}
}
#>

　　真正的存儲過程的T-SQL腳本實現在重寫的RunCore中。由于具體的文本轉化邏輯都定義在了ProcedureTemplate中了，所以在這里我們需要遍歷的ProcedureTemplate集合中每一個Template對象，調用RenderToFile方法將相應的存儲過程的腳本寫入以存儲過程命名同名的.sql文件中。

　　三、ProcedureGenerator如何被使用？

　　我們最后來看看我們創建的ProcedureGenerator最終如何被應用于具體的代碼生成。其實很簡單，我們只需要創建相應的模板文件，通過<#@include>將定義ProcedureGenerator類的TT文件包含近來，最后以代碼語句調用塊（<#StatementCode#>）的形式實力化該對象，并調用Run方法即可。在構造函數中指定數據庫連接字符串的名稱和數據表名的列表。下面是基于但表的T4模板。

<#@ template language="C#" hostSpecific="true" debug="true" #>

<#@ include file="Templates\ProcedureGenerator.tt" #>

<#

   new ProcedureGenerator("TestDb","T_PRODUCT").Run();

#>

　　下面是基于多表的T4模板：

<#@ template language="C#" hostSpecific="true" debug="true" #>

<#@ include file="Templates\ProcedureGenerator.tt" #>

<#

   new ProcedureGenerator("TestDb","T_ORDER","T_ORDER_DETAIL").Run();

#>