T4 簡(jiǎn)介

T4，全稱 Text Template Transformation Toolkit，早在 VS2005 中就存在的東西，只是沒有高度集成，VS2010 在托管項(xiàng)目中新增了添加 Text Template 文件的模板，但是并沒有代碼顏色和智能感知，可以說它是 Visual Studio 一個(gè)“隱藏”的特性。T4 一般用來從某種“模型”自動(dòng)生成好用的代碼，例如從XML模型生成操作它的強(qiáng)類型代碼。不知道是不是 C++ 的宏和模板實(shí)在太強(qiáng)大，貌似這種代碼生成器用在托管語言中用得廣泛多，其實(shí)我想在 C++ 中用這個(gè)也是跟托管程序有關(guān)。

一般來說，在托管的項(xiàng)目中添加一個(gè) .tt 后綴名的文本文件即可用到 T4，如圖：

對(duì)于生成什么擴(kuò)展名的文件，其實(shí)并沒有限制，可以在 .tt 文件的處理指令中指定：

<#@ template language="C#" #>
<#@ output extension=".generated.cs" #>

然后就基本好像寫 PHP 或者 ASP 那樣了，不同之處在于 T4 的生成步驟是在一個(gè)方法中的，如果要自定一些幫助函數(shù)，需要用 <#+ 和 #> 包圍。參見 MSDN 上一個(gè)簡(jiǎn)單的例子：Walkthrough: Generating Code by using Text Templates。

嘗試在 C++ 項(xiàng)目中添加

第一步，肯定要先添加一個(gè) .tt 文件。很不幸地發(fā)現(xiàn)，魔法沒有自動(dòng)出現(xiàn)，.tt 文件是在那里了，但是沒有自動(dòng)生成的文件，IDE 也沒有顯示什么文件跟這個(gè) .tt 有關(guān)聯(lián)關(guān)系。很顯然，需要告訴 IDE 更多事情。

其實(shí)在嘗試這個(gè)東西之前，我是有想過最終的成功率的，根據(jù)我的了解，1) Visual Studio 使用 MSBuild 的項(xiàng)目文件，2) VS2010 構(gòu)建 C++ 項(xiàng)目使用 MSBuild，3）T4 可以作為 MSBuild 中的一個(gè) Custom Build Tool 介入。從這三點(diǎn)理解的話，可知只要修改項(xiàng)目文件，即使 VS 不支持某些東西，只要它不亂改我們?cè)陧?xiàng)目文件中的設(shè)置，就可以保證構(gòu)建的項(xiàng)目是正確的。

有了上面的知識(shí)，可以開始下一步的嘗試了：新建一個(gè) C# 項(xiàng)目，添加一個(gè) .tt 文件，然后觀察項(xiàng)目文件如何變化，其實(shí)稍微了解 MSBuild 項(xiàng)目文件的結(jié)構(gòu)是怎么樣的話，很快就知道了。我的項(xiàng)目需要的是根據(jù)“舊的”文件自動(dòng)生成上萬個(gè)包裝函數(shù)，而這個(gè)“舊的”意思是，這個(gè)文件會(huì)在其他社區(qū)不斷地更新，增加更多函數(shù)，我做了這個(gè)自動(dòng)生成的就無需每次都根據(jù)新文件手動(dòng)查找替換修改了。于是我修改成這個(gè)樣子：

<!-- Items that use T4 -->
<ItemGroup>
  <None Include="Scripting.tt">
    <Generator>TextTemplatingFileGenerator</Generator>
    <FileType>Asax</FileType>
  </None>
  <ClInclude Include="Scripting.h">
    <AutoGen>True</AutoGen>
    <DependentUpon>Scripting.tt</DependentUpon>
    <DesignTime>True</DesignTime>
  </ClInclude>
  <None Include="Scripting_.h" />
</ItemGroup>

其實(shí)，這段東西的重點(diǎn)在于，.tt 有一個(gè) Generator 子標(biāo)簽，內(nèi)容是 TextTemplatingFileGenerator，標(biāo)簽 None 它表示不參與到 Build 中，只是 T4 用的。ClInclude 表示我生成的 .h 文件在 Build 過程中是頭文件，AutoGen 表示這個(gè)文件由工具自動(dòng)生成，DependentUpon 可以使 Visual Studio 知道這兩個(gè)家伙有聯(lián)系。

現(xiàn)在重新載入項(xiàng)目，可以看到 Visual Studio 將他們關(guān)聯(lián)了，但是趕出了 Header Files，而我就將它們放到一個(gè)新的 Filter 中去：

快搞定了！

但是我們拿這個(gè)編輯過的項(xiàng)目文件構(gòu)建的時(shí)候，并沒有看到有輸出文件。也就是說，T4 其實(shí)還沒有介入。而在托管的項(xiàng)目中，當(dāng)你保存 .tt 文件的時(shí)候，或者點(diǎn)擊 Solution Explorer 上運(yùn)行 Transform 的時(shí)候，T4 引擎就會(huì)自動(dòng)運(yùn)行生成輸出，如果你改變 output 指令的 extension 參數(shù)，輸出文件的擴(kuò)展名還會(huì)自動(dòng)更改，確切地說，舊的文件會(huì)被移到回收站。正當(dāng)我快要放棄的時(shí)候，突然發(fā)現(xiàn) MSDN 文檔中有一節(jié)：Code Generation in a Build Process，其中表示，只要裝上 Visual Studio Visualization and Modeling SDK 然后在項(xiàng)目文件差不多最后的地方加上以下代碼即可：

<!-- Enable TransformOnBuild for Msbuild -->
<Import Project="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\TextTemplating\v10.0\Microsoft.TextTemplating.targets" />
<PropertyGroup>
  <TransformOnBuild>True</TransformOnBuild>
</PropertyGroup>

噢，終于勝利了！最后發(fā)現(xiàn)，仍然不能直接只在 .tt 文件中修改輸出指令的 extension 參數(shù)，VS 不會(huì)幫你自動(dòng)更改，需要自己動(dòng)手修改項(xiàng)目文件，不過這個(gè)就無所謂了，因?yàn)槲业哪康倪_(dá)到了，思想也驗(yàn)證了。

最后附上示例項(xiàng)目文件。