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>http://util.cnblogs.com/InsertCode.aspx
<#
  foreach(KeyValuePair<string, string> property in properties) {
#>
      <th>
        <#= property.Key #>
      </th>
<#
  }
#>

List.tt 的工作是生成将以表格形式显示模型对象集合的 .aspx 文件。在该模板中，您可以看到编写的表、tr 和 th 标记。若要生成 .aspx 文件，该模板需要一些上下文信息，例如，应使用的母版页的名称和模型的类型。该模板可以从其宿主对象检索此信息。该宿主对象位于模板和 T4 引擎之间，并可以使模板访问资源（如本地文件）和环境设置。通常，宿主是 Visual Studio，但 MVC 团队在 Microsoft.VisualStudio.Web.Extensions 程序集中创建了类型为 MvcTextTemplateHost 的自定义宿主。这便是沿用了您在“添加视图”和“添加控制器”对话框中输入的信息的自定义宿主对象，这些对话框是您将发现的最接近 MVC 项目中的向导的事物。

List.tt 将遍历强类型化模型对象的可显示属性并创建具有每个属性列的表。该模板使用反射在 FilterProperties 方法中查找该模型的可用属性。FilterProperties 是稍后在模板文件中定义的帮助器方法。该模板还设置了导航到编辑和详细信息操作的链接，并根据您正在创建视图还是部分视图来为 .aspx 设置适当的 @ Page 或 @ Control 指令。  

当模板结束运行时，您将看到一个崭新的 .aspx 视图，该视图包含显示模型对象集合所需的所有内容。您可能会打开 .aspx 文件并进行微调以使该视图在外观上与应用程序其余部分中的视图保持一致。

如果您发现总是对这些生成的视图（或 Controller.tt 生成的控制器代码）进行相同的更改，则可以通过修改模板本身来节省时间。例如，您可以修改内置模板，以便为项目中使用的样式规则甚至更重要的内容添加类属性。请记住，修改 Visual Studio 安装目录中的模板文件将更改在您的计算机上进行的所有项目中生成的代码。如果您希望更改为单个项目生成的代码，您也可以这样做。

各个项目 T4 自定义

如果您想要基于各个项目的代码生成模板的自定义版本，则首先复制 Visual Studio 安装中的 CodeTemplates 文件夹，然后将其粘贴到您的 ASP.NET MVC 项目的根目录中。然而，不必将所有模板都复制到您的项目中。您可以只复制需要修改的模板。共有 6 个 MVC 代码生成模板，1 个用于添加控制器 (Controller.tt)，其余 5 个用于添加视图（Create.tt、Details.tt、Edit.tt、Empty.tt、List.tt）。如果您的项目中存在模板，则该模板将覆盖 Visual Studio 安装目录中的模板。

当向 Visual Studio 解决方案中添加 .tt 文件时，IDE 会自动将该 .tt 文件分配给 TextTemplatingFileGenerator 的自定义工具设置。如果您创建了我之前所述的 Simple.tt 模板，则您已看到这种情况。但是，这不是 MVC T4 模板的适当设置。Visual Studio 的 MVC 工具将在适当的时候调用这些模板并在模板处理期间创建特殊的 MvcTextTemplateHost 对象。因此，将模板复制到您的项目中后，第二步是为各个模板文件打开“属性”窗口，然后删除“自定义工具”设置（保留该设置为空）。此时，便可以自定义您的模板了。

---------------------------------------------------------------------------------------------------------------------------

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

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

<% Html.RenderPartial(MVC.Shared.Views.LogOnUserControl); %>
之前，您可能已使用了字符串文本：

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

ASP.NET MVC 中的 T4

标签：

原文地址：http://www.cnblogs.com/izhiniao/p/4761780.html