代码生成和 T4 文本模板

  • 项目

在 Visual Studio 中，T4 文本模板是文本块与可生成文本文件的控制逻辑的混合体。 控制逻辑被编写为 Visual C# 或 Visual Basic 中的程序代码的片段。 可以在 T4 模板指令中使用 C# 6.0 版本功能。 所生成的文件可以是文本，例如网页、资源文件或任何语言的程序源代码。

对于特定于域的语言 (DSL)，旨在表达特定问题空间中的语句，请了解如何从特定于域的语言生成代码

T4 文本模板有两种类型：运行时和设计时

运行时 T4 文本模板

运行时模板也称为“预处理”模板。 在应用程序中运行模板以生成文本字符串，作为其输出的一部分。 例如，你可以创建一个模板来定义 HTML 页：

<html><body>
 The date and time now is: <#= DateTime.Now #>
</body></html>

注意：该模板与生成的输出类似。 该模版与生成的输出的相似性有助于避免在想要更改时出现错误。

此外，该模板包含程序代码的片段。 你可使用这些片段来重复文本节、创建条件节以及显示应用程序数据。

若要生成输出，应用程序将调用由此模板生成的函数。 例如：

string webResponseText = new MyTemplate().TransformText();

应用程序可在未安装 Visual Studio 的计算机上运行。

若要创建运行时模板，将“预处理过的文本模板” 文件添加到你的项目中。 你也可以添加一个纯文本文件，并将其“自定义工具”属性设置为 TextTemplatingFilePreprocessor。

有关详细信息，请参阅使用 T4 文本模板的运行时文本生成。 有关模板语法的详细信息，请参阅编写 T4 文本模板。

设计时 T4 文本模板

设计时模板用于定义部分源代码以及应用程序的其他资源。 通常，你会使用多个模块读取单个输入文件或数据库中的数据，然后生成部分 .cs 文件、.vb 文件或其他源文件。 每个模板生成一个文件，并在 Visual Studio 或 MSBuild 中生成。

例如，输入数据可能是配置数据的 XML 文件。 每当在开发过程中编辑 XML 文件时，文本模板都会重新生成部分应用程序代码。 其中一个模板可能类似于以下示例：

<#@ output extension=".cs" #>
<#@ assembly name="System.Xml" #>
<#
 System.Xml.XmlDocument configurationData = ...; // Read a data file here.
#>
namespace Fabrikam.<#= configurationData.SelectSingleNode("jobName").Value #>
{
  ... // More code here.
}

生成的 .cs 文件基于 XML 文件值采用以下格式：

namespace Fabrikam.FirstJob
{
  ... // More code here.
}

再如，该输入可能是业务活动中的工作流关系图。 当用户更改其业务工作流，或当你开始与拥有不同工作流的新用户协作时，很容易重新生成代码以适应新模型。

注意

术语 “模型” 有时用来描述由一个或多个模板所读取的数据。 该模型可以是任何格式、任何类型的文件或数据库。 而不必是 UML 模型或域特定语言模型。 “模型”仅表示可以业务概念的形式定义的数据，而不是类似的代码。 随着需求的变化更改配置时，设计时模板更快速、更可靠。 通常，输入根据业务需求定义（如工作流示例所示）。 设计时模板也成为敏捷开发过程中的有用工具。

若要创建运行时模板，请将“文本模版” 文件添加到你的项目中。 或者，你也可以添加一个纯文本文件，并将其“自定义工具” 属性设置为 TextTemplatingFileGenerator。

有关详细信息，请参阅使用 T4 文本模板生成设计时代码。 有关模板语法的详细信息，请参阅编写 T4 文本模板。

文本模板转换功能命名为 T4。

另请参阅