功能強大的T4文本模版
希望您至少能意識到即使有代碼自動生成器,但數據庫結構變更等因素也會給我們帶來不少的麻煩。這種直接放到項目里.tt文件的好處自然不用多說了。有特別的業務需求,在.用partial類來實現,免得模板文件自動更新代碼時將手寫的代碼覆蓋掉。
T4文本模版到底有什么用?什么時候用?
看一下下面這個示例你應該就會明白了:
新建一個控制臺應用程序,刪除里面的所有文件,新建一個Program.tt的文件,并輸入如下內容:
- <#@ template language="C#"debug="true"#>
- <#@ output extension=".cs"encoding="utf-8"#>
- <#
- stringClassName = "Program";
- #>stringClassName = "Program";
- #>
- namespaceHelloAngel
- {
- usingSystem;
- class<#=ClassName #>
- {
- staticvoidMain(string[] args)
- {
- Console.WriteLine("Hello Angel");
- }
- }
- }
保存后我們會看到解決方案資源管理器中是這個樣式的:
此時的Program.cs文件正是我們的Program.tt文件生成的,其內容如下:
- namespaceHelloAngel
- {
- usingSystem;
- classProgram
- {
- staticvoidMain(string[] args)
- {
- Console.WriteLine("Hello Angel");
- }
- }
- }
看看下面兩個指令:
- <#@ template language="C#"debug="true"#>
- <#@ output extension=".cs"encoding="utf-8"#>
<#@ template #>指令中language指定了我們模板運行使用的語言,可以是VB,或C#,debug聲明了是否使用調試,如果用不到調試,可以設置為false.
<#@ output #>指令中extension指定了輸出文件的擴展名,encoding指定輸出文件的編碼方案。
也就是說,我們可以使用C#語言來寫此模板文件中的邏輯,模板將會輸出一個與模板文件名相同,擴展名為.cs編碼為utf-8的文件。
這里稍作了解下,接下來看看指令的語法吧:
指令的語法如下所示:
- <#@ DirectiveName [AttributeName = "AttributeValue"] ... #>
必須將所有特性值放在雙引號內。如果值本身包含引號,則必須使用 字符對這些引號進行轉義。
指令通常是模板文件或包含的文件中的第一個元素。不應將它們放置在代碼塊 <#...#> 內,也不應放置在類功能塊 <#+...#> 之后。
T4 模板指令
<#@ template [language="VB"] [hostspecific="true"] [debug="true"] [inherits="templateBaseClass"] [culture="code"] [compilerOptions="options"] #>
T4 參數指令
<#@ parameter type="Full.TypeName"name="ParameterName"#>
T4 輸出指令
<#@ output extension=".fileNameExtension"[encoding="encoding"] #>
T4 程序集指令
<#@ assembly name="[assembly strong name|assembly file name]"#>
T4 導入指令
<#@ import namespace="namespace"#>
T4 包含指令
<#@ include file="filePath"#>
看了上面的指令后,就試著寫個模板文件生成一些類來練習一下吧:
- <#@ template language="C#"debug="true"#>
- <#@ output extension=".cs"encoding="utf-8"#>
- <#@ import namespace="System.Collections.Generic"#>
- <#
- List<List<string>classNames =
- new List<string>()
- {
- "Hello",
- "Test"
- };
- List<string>callMethods = new List<string>();
- #>
- namespace HelloAngel
- {
- using System;
- <#
- foreach (string className in classNames)
- {
- callMethods.Add(string.Format("{0}.Show();", className));
- #>foreach (string className in classNames)
- {
- callMethods.Add(string.Format("{0}.Show();", className));
- #>
- class <#=className #>
- {
- /// <summary>
- /// <#=className #>的注釋
- /// </summary>
- public static void Show()
- {
- Console.WriteLine("ClassName:<#=className #>");
- }
- }
- <#
- #>}
- #>
- class Program
- {
- /// <summary>
- /// 入口方法的注釋
- /// </summary>
- static void Main(string[] args)
- {
- <#
- foreach (string callMethod in callMethods)
- {
- #>foreach (string callMethod in callMethods)
- {
- #>
- // <#=callMethod #>調用
- <#=callMethod #>
- <#
- }
- #>}
- #>
- }
- }
- }
我們一般的項目多是分了簡單三層,有了上面的一些經驗,你應該會想。要是只寫三個類.tt文件,就能自動給我們把整個三層維護好那多令人興奮啊!確實,我就是這樣做了一個項目給大家分享一下:
看看現在整個項目成什么樣子了:
這里不止三個項目了。我加了個UnitTest的項目,一個Adapters的項目,看項目名稱不難看出來,UnitTest項目就是一個測試項目。而Adapters項目呢,是實體適配器項目。先不管它們了。
就這么點東西,已經完成三層的架設了,只是還是Paramter方式的。沒有對存儲過程的支持。十一如果沒有人陪我過的話,我會將對存儲過程的支持添加上去。
建項目的時候建的是.net 4的,這里我把它改為.net2.0的了。不過本人只裝有visual stuido 2010,如果您使用的是Visual studio 2008請您自行將項目文件中的版本號更正,此方法網上有許多。我就不多啰嗦了。
原文鏈接:http://www.cnblogs.com/javennie/archive/2011/09/24/t4.html