T4 模板编写教程

模板编写教程

模板的大体分为5块内容：模板指令声明，代码语句块，表达式块，类功能控制块，文本块输出。下面我们分别来介绍一下这5块内容的语法和使用说明。

1.模板指令声明块 <#@ #>和ASP.NET页面的指令一样，它们出现在文件头，通过<#@…#>表示。

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

(1) 模板指令

<#@ template [language="VB"] [hostspecific="true"] [debug="true"] [inherits="templateBaseClass"] [culture="code"] [compilerOptions="options"] #>

例如:

<#@ template language="C#v3.5" hostSpecific="true" debug="true" #>

Language 这里可以指定模板使用的语言。

hostSpecific="true" 表示是否使用特定的host，host里面包含了模板使用的各种对象。

注意：

所有属性值必须用双引号都括起来。如果值本身包含引号，则必须使用 \ 字符对这些引号进行转义。指令通常是模板文件或包含的文件中的第一个元素。

(2) 参数指令

<#@ parameter type="Full.TypeName" name="ParameterName" #>

(3) 输出指令

<#@ output extension=".fileNameExtension" encoding="encoding" #>

· output extension=".cs" 指定生成文件的扩展名。

encoding="encoding" 指定生成文件的编码。

(4) 程序集指令

<#@ assembly name="System.Data" #>

用于添加程序集引用，如果要使用第三方程序集，那么最好在项目中添加引用。

注：您应使用绝对路径的名称，或者路径名称中使用标准的宏的名称。

例如： <#@ assembly name="$(SolutionDir)library\MyAssembly.dll" #>

(5) 导入指令

<#@ import namespace="System.Data" #>

导入要使用的命名空间，注意：这里的命名空间必须要在前面指定的程序集里面找得到的，比如我指定命名空间"System.Data"，"System.Data.Common"，这些在程序集System.Data中都有的

(6) 包含指令

<#@ include file="test.tt" #> 导入模板，类似Html的include用法

include 指令插入其他模板文件的文本。

例如，下面的指令插入 test.txt 的内容。 <#@ include file="c:\test.txt" #>

在处理时，被包含内容就像是包含文本模板的组成部分一样。不过，即使 include 指令后跟普通文本块和标准控制块，也可以包含编写有类功能块 <#+...#> 的文件

2 代码语句块: <# #>

在模板文件中，可以混合使用任意数量的文本块和标准控制块。中间是一段通过相应编程语言编写的程序调用，我们可以通过代码语句快控制文本转化的流程。

注意：不能在控制块中嵌套控制块。

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

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

{

Hello!

}

3 表达式块：<#= #>

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

例如： <#= 2 + 3 #>

表达式可以包含作用域中的任何变量。例如，下面的块输出数字行：

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

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

{

This is hello number <#= i+1 #>: Hello!

}

4 类功能控制块：<#+ #>

如果文本转化需要一些比较复杂的逻辑，我们需要写在一个单独的辅助方法中，甚至是定义一些单独的类，我们就是将它们定义在类特性块中。类功能控制块定义属性、方法或不应包含在主转换中的所有其他代码。类功能块常用于编写帮助器函数。通常，类功能块位于单独的文件中，这样它们可以包含在多个文本模板中。类功能控制块以 <#+ ... #> 符号分隔。

例如，下面的模板文件声明并使用一个方法：

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

Squares:

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

{

The square of <#= i #> is <#= Square(i+1) #>.

}

That is the end of the list.

<#+ // Start of class feature block

private int Square(int i)

{

return i*i;

}

类功能必须编写在文件末尾。不过，即使 include指令后跟标准块和文本，也可以 <#@include #> 包含类功能的文件。例如下面代码则会报错：

List of Squares:

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

{ WriteSquareLine(i); }

End of list.

<#+ // Class feature block

private void WriteSquareLine(int i)

{

The square of <#= i #> is <#= i*i #>.

}

5 文本块输出

可以使用 Write() 和 WriteLine() 方法在标准代码块内追加文本，而不必使用表达式代码块。它们可帮助缩进输出和报告错误。

下面两个代码块在功能上是等效的。

包含表达式块的代码块

int i = 10;

while (i-- > 0)

{ #>

<#= i #>

<# }

使用 WriteLine() 的代码块

int i = 10;

while (i-- > 0)

{

WriteLine((i.ToString()));

}

Write() 和 WriteLine() 方法有两个重载，其中一个重载接受单个字符串参数，另一个重载接受一个复合格式字符串以及将包含在字符串中的对象数组（与 Console.WriteLine() 方法类似）。

下面两种 WriteLine() 用法在功能上是等效的：

string msg = "Say: {0}, {1}, {2}";

string s1 = "hello";

string s2 = "goodbye";

string s3 = "farewell";

WriteLine(msg, s1, s2, s3);

WriteLine("Say: hello, goodbye, farewell");

设置文本模板输出缩进的格式。

CurrentIndent 字符串属性显示文本模板中的当前缩进，该类还具有一个 indentLengths 字段，该字段是已添加的缩进的列表。

PushIndent() 方法增加缩进，

PopIndent() 方法减少缩进。

ClearIndent() 方法，删除所有缩进。

下面的代码块演示这些方法的用法：