.NET T4模板 简单介绍T4

T4模板简单介绍

      T4 ，全称为“Text Template Transformation Toolkit”是微软官方在Visual Studio 2008中开始使用的代码生成引擎。

      T4文本模板"是由一些文本块和控制逻辑组成的混合模板，它可以生成文本文件。在Visual C#或Visual Basic中，控制逻辑编写为程序代码的片段。生成的文件可以是任何类型的文本，例如网页、资源文件或任何语言的程序源代码。现在的VS中只要与代码生成相关的场景基本上都能找T4的身影，比如MVC的视图模板，Entity Framework的DataContext模板等等。

T4模板的主要2个类型

1、设计时模板
在Visual Studio中执行设计时T4文本模板，以便定义应用程序的部分源代码和其他资源。
通常，您可以使用读取单个输入文件或数据库中的数据的多个模板，并生成一些.cs、.vb或其他源文件。每个模板都生成一个文件。在Visual Studio或MSBuild内执行它们。
若要创建设计时模板，请向您的项目中添加“文本模板”文件。另外，您还可以添加纯文本文件并将其“自定义工具”属性设置为“TextTemplatingFileGenerator”。
2、运行时模板
可在应用程序中执行运行时T4文本模板（“预处理过的”模板）以便生成文本字符串（通常作为其输出的一部分）。
若要创建运行时模板，请向您的项目中添加“已预处理的文本模板”文件。另外，您还可以添加纯文本文件并将其“自定义工具”属性设置为“TextTemplatingFilePreprocessor”

T4模板的基本结构主要分为5类：

1.指令块：（Directive Block）
2.文本块：（Text Block）
3.代码语句块：（Statement Block）
4.表达式块：（Expression Block）
5.和类特性块：（Class Feature Block）

一、指令块（Directive Block）

指令块主要通过<#@…#>表示。

模板中必须的指令：<#@ template … #>，用于定义模板的基本属性。

1.<#@ template … #>T4模板指令

完整指令：<#@ template {language="C#"} {debug="false"} {hostspecific="false"}  {compilerOptions="options"} {culture="code"} {inherits="Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation"} #>

1.模板指令中所有特性均为可选的。
2.language：输出语言，有效值C#、VB，默认为C#。
3.debug：是否启用测试，有效值true、false，默认值为false。
4.hostspecific：有效值true、false，默认为false。如果将此特性的值设置为true，则会将名为Host的属性添加到由文本模板生成的类中。该属性是对转换引擎的宿主的引用，并声明为：Microsoft.VisualStudio.TextTemplating.ITextTemplatingEngineHost。
5.inherits：可以指定模板的程序代码可以继承自另一个类，这个类也可以从文本模板生成。
6.compilerOptions：有效值为任何有效的编译器选项。

举个例子：<#@ template language="C#" hostspecific="true" debug="True" #>

2.<#@ parameter... #>T4参数指令

完整指令：<#@ parameter type="Full.TypeName" name="ParameterName" #>

主要用于传参，应该是用在运行时模板

3.<#@ output... #>T4输出指令

完整指令：<#@ output extension=".txt" {encoding="utf-8"} #>

很重要的指令，主要用于设置输出文件的后缀名和文件编码

extension：输出文件扩展名
encoding：文件编码。

4、<#@ assembly #>：T4 程序集指令

完整指令：<#@ assembly name="[assembly strong name|assembly file name]" #>

如<#@ assembly name=“System.Core” #> 表示引用Core的程序集。

1.程序集指令相当于VS里面我们添加程序集引用的功能，该指令只有一个参数name，用以指定程序集名称，如果程序集已经在GAC里面注册，那么只需要写上程序集名称即可，如<#@ assembly name="System.Data.dll" #>，否则需要指定程序集的物理路径。
2.T4模板的程序集引用是完全独立的，也就是说我们在项目中引用了一些程序集，然后项目中添加了一个T4模板，T4模板所需要的所有程序集引用必须明确的在模板中使用程序集执行引用才可以。
3.T4模板自动加载以下程序集Microsoft.VisualStudio.TextTemplating.1*.dll、System.dll、WindowBase.dll，如果用到了其它的程序集需要显示的使用程序集添加引用才可以。
4.可以使用$(variableName)语法引用Visual Studio或MSBuild变量（如$(SolutionDir)），以及使用%VariableName%来引用环境变量。介绍几个常用的$(variableName)变量:
$(SolutionDir)：当前项目所在解决方案目录
$(ProjectDir)：当前项目所在目录
$(TargetPath)：当前项目编译输出文件绝对路径
$(TargetDir)：当前项目编译输出目录，即web项目的Bin目录，控制台、类库项目bin目录下的debug或release（取决于当前的编译模式）

5.<#@ import #>T4导入指令

完整指令：<#@ import namespace="System.Linq" #>

<#@ import namespace="System.Linq" #>表示引用了Linq这个命名空间。

6.<#@ include #>T4包含指令

完整指令：<#@ include file="filePath" #>

1.filePath可以是绝对的或相对于当前的模板文件。
2.filePath可以包含用"%"分割的环境变量，例如：<#@ include file="%HOMEPATH%\MyIncludeFile.t4" #>
3.所包含的文件的名称不必使用扩展名".tt"。可能需要针对包含的文件使用其他扩展名，例如：".t4"。这是因为，在您将.tt文件添加到项目中时，Visual Studio会自动将其“自定义工具”属性设置为TextTemplatingFileGenerator。您通常不希望单独转换包含的文件。
4.在处理时，被包含内容就像是包含文本模板的组成部分一样。不过，即使include指令后为普通文本块和标准控制块，也可以包括含有类功能块<#+...#>的文件。

二、文本块（Text Block）

文本块直接向输出文件插入文本。不需要添加任何的标签。从指令块结束到第一个“<#”标签之间的内容就是一段静态的文本块。

以下代码输出 “这是文本块”：

<#@ output extension=".txt" #>

“这是文本块”

<#

    .............

#>

三、代码语句块（Statement Block）

代码语句块通过<#…#>的形式来表示，中间是一段使用相应的编程语言编写的程序代码，我们可以通过代码语句块控制文本的转化流程。由于我们使用的是.NET,所以在这里代码语句块的作用主要就是写C#代码，示例如下：

<#
   for(int i=0;i<4;i++)
   {
      Write(i+",");
   }
    Write("4");
 #>

yes！

以上代码输出：1，2，3，4，5，6 ，yes！

用于运算的代码，都可以在<# #>里表示。

四、表达式块（Expression Block）

表达式块是经过计算表达式并将其转换为字符串。该字符串将插入到输出文件中。

主要形式为：<#=...#>

举个例子：

<#

for(int i=0;i<4;i++)
   {

#>

<#= i #>,yes

<#

}

#>

以上代码输出为：

五、类特性块（Class Feature Block） 

类功能控制块定义属性、方法或不应包含在主转换中的所有其他代码。类功能块常用于编写帮助器函数。通常，类功能块位于单独的文件中，这样它们可以包含在多个文本模板中。

简单点说类似于方法。可以重复使用，减低代码重复。

主要形式：<#+...#>

举个例子：

<# areyouok("类特性块例子") #>

<#+
 public void areyouok(string xxx){
 this.write(xxx);
 }
 #>

以上代码输出为：

好了，T4模板的基础知识基本就是这一些，看起来眼花缭乱，其实一点一点仔细看就会发现也就那样，顶多看起来花里胡哨，实际上和以前学的代码并没有太多区别，只是添加了一些使用规则而已。