登峰造极的 ASP.NET

文本模板转换工具包和 ASP.NET MVC

K. Scott Allen

Microsoft Visual Studio 包含一个称为 T4（文本模板转换工具包的缩写）的代码生成引擎。您或许已在 Visual Studio 中使用 T4 模板，甚至还不知道这些模板已在后台工作。在本文中，我将简单介绍 T4 模板并说明 ASP.NET MVC 如何使用此项技术。同时我还会为您介绍如何自定义 T4 模板以使用 MVC 框架提高您的日常工作效率。

该模板工具包背后的基本理念是分析输入文件并将其转换为输出文件。输入文件是一个模板（文件扩展名为 .tt 的文本文件）。输出文件还会包含文本，文本可以是 C# 代码、Visual Basic 代码、Web 窗体代码、标记或您需要生成的任何其他内容。

观看 T4 演示的最简单方法是在 Visual Studio 中创建一个新项目。我将在本文中生成 C# 代码，因此您可以使用编译 C# 代码的任何项目类型。打开项目后，右键单击该项目，然后选择“添加”|“新建项目”。从“添加新项”对话框中选择“文本文件”（Visual Studio 2008 中没有专用于 T4 的项目模板，但 Visual Studio 2010 中将提供），然后将文件命名为 Simple.tt（确保使用 .tt 扩展名）。将该文件加载到项目后，您会立即在“解决方案资源管理器”窗口中看到 Simple.cs 文件显示在 Simple.tt 之后。（请参见图 1）。

图 1 T4 模板后面的 C# 文件

Simple.tt 和 Simple.cs 文件一开始都是空文件。如果您右键单击 Simple.tt 文件，然后选择“属性”，您将看到 Visual Studio 将 TextTemplatingFileGenerator 指定为文件的自定义工具（请参见图 2）。此生成器是 T4 引擎，会将模板文件转换为一个完全由 C# 代码组成的文件。

图 2 T4 模板的属性

若要使该模板执行所需操作，请添加以下代码：

<#@ template language="c#v3.5" #>
<#@ assembly name="System.Web.Mvc.DLL" #>
<#@ import namespace="System.Web.Mvc" #>

public class Test
{
<# for(int i = 0; i < 5; i++) { #> 
  public int Prop<#= i #> { get; set; }
<# } #>
}

该代码以某些指令开始。这些指令允许您指定该模板的编程语言并将代码所需的命名空间和程序集包含在该模板内。我想强调的是我所谈论的是执行模板中的代码所需的设置，而不是项目本身包含的代码。您还可以使用指令指定输出文件的扩展名。默认的是 C#，但正如我之前提到的，您可以生成 Visual Basic 代码、XML、HTML 或任何其他文本项目。

我正在使用的指令指示模板引擎使用随 Microsoft .NET Framework 3.5 一同提供的 C# 编译器。它还指示模板引擎引用 ASP.NET MVC 程序集并将 System.Web.Mvc 命名空间引入作用域。MVC 程序集和命名空间不是模板中的简单代码实际需要的，但是我把它们作为一个示例放在模板中。

在指令后面，您看到的不在 <# 和 #> 分隔符之间的文本被逐字放到输出文件中。位于 <# 和 #> 之间的文本是 C# 代码。模板引擎将分析该代码，然后将其添加到类以便执行（最终由 Microsoft.VisualStudio.TextTemplating 程序集中的 TextTransformation 类派生的类）。此过程类似于 ASP.NET 视图引擎过程，在该过程中将 .aspx 文件中的代码和标记添加到最终由 System.Web.UI.Page 派生的类。如果您已使用 Web 窗体视图引擎编写您的 MVC 视图，则创建模板将得心应手。在 .aspx 文件中，您可以使用 C# 代码生成 HTML。在 .tt 文件中，我使用 C# 代码生成 C# 代码。

Simple.tt 中的代码将在 Simple.tt.cs 中生成以下 C# 输出：

public class Test
{
  public int Prop0 { get; set; }
  public int Prop1 { get; set; }
  public int Prop2 { get; set; }
  public int Prop3 { get; set; }
  public int Prop4 { get; set; }
}

当然，Test 类毫无用处且完全没有意义，但我希望它能帮助您了解 T4 模板所具备的某些功能。由于您正在编写模板中的 C# 代码，因此您可以连接到数据库、读取文件系统中的数据、分析 XML 或使用任何 .NET 类连接或读取存在于您环境中的元数据。此元数据（类似于数据库架构或其他程序集内部的类型）是您可以用于生成类的信息。这些类将成为当前项目的一部分，因此他们将编译到当前程序集并且您可以在您的应用程序中使用这些类。

T4 编辑

当您编辑 Visual Studio 中的 T4 模板时，IDE 中的语言服务（例如 IntelliSense 和突出显示的语法）对您没有任何帮助。有两种解决方案可以解决这种问题。一种是 Clarius Consulting 提供的 Visual T4 编辑器 (visualt4.com)。另一种解决方案是 Tangible Engineering 提供的 Tangible T4 编辑器 (t4-editor.tangible-engineering.com)。

对 T4 模板的工作方式有了基本了解后，让我们来看一下 MVC 框架使用 T4 模板的方式。

ASP.NET MVC 中的 T4

每次使用“添加视图”或“添加控制器”功能时，您都在 ASP.NET MVC 项目中使用 T4 模板。这些模板位于 Common7\IDE\ItemTemplates\CSharp\Web\MVC 2\CodeTemplates 文件夹的 Visual Studio 安装中。另外还提供了模板的 Visual Basic 版本，但是我将其作为读者推断文件夹名称的一个练习。

这些模板本身足以说明 T4 的价值和功能。例如，以下是 CodeTemplates 的 AddView 子文件夹中 List.tt 的一段摘录：

  if(!String.IsNullOrEmpty(mvcViewDataTypeGenericString)) {
    Dictionary<string, string> properties = 
      new Dictionary<string, string>();
    FilterProperties(mvcHost.ViewDataType, properties);
  #>
    <table>
      <tr>
        <th></th>
  <#
    foreach(KeyValuePair<string, string> property in properties) {
  #>
        <th>
          <#= property.Key #>
        </th>
  <#
    }
  #>

public class <#= mvcHost.ControllerName #> : Controller
{
  // GET: /<#= mvcHost.ControllerRootName #>/

  public ActionResult List()
  {
    return View();
  }
...

<% Html.RenderPartial(MVC.Shared.Views.LogOnUserControl); %>

之前，您可能已使用了字符串文本：

<% Html.RenderPartial("LogOnUserControl"); %>