编写 T4 文本模板

文本模板由以下部件组成：

1）指令 - 控制模板处理方式的元素。

2）文本块 - 直接复制到输出的内容。

3）控制块 - 向文本插入可变值并控制文本的条件或重复部件的程序代码。

指令：

指令是控制模板处理方式的元素，为模板转换引擎提供说明。

T4文本模板指令包括：    T4模板指令；  T4参数指令；  T4输出指令；  T4程序集指令；  T4导入指令；  T4包含指令；  T4 CleanUpBehavior 指令及其自定义指令。

指令的语法如下所示：

<#@ DirectiveName [AttributeName = "AttributeValue"] ... #>
  • []:表示为可选参数

  • DirectiveName:指令名
  • AttributeName:特性名
  • AttributeValue:特性值(特性值必须放在双引号内,如果值本身包含引号,则必须使用 \ 字符对这些引号进行转义。)
【指令通常是模板文件或包含的文件中的第一个元素。 不应将它们放置在代码块 <#...#> 内，也不应放置在类功能块 <#+...#> 之后。】

T4模板指令：

<#@ template [language="VB"] [hostspecific="true|TrueFromBase"] [debug="true"] [inherits="templateBaseClass"] [culture="code"] [compilerOptions="options"] [visibility="internal"] [linePragmas="false"] #>
  1. 模版指令中所有特性均为可选的。

  2. langeuage:输出语言，有效值C#、VB，默认为C#。
  3. debug:是否启用调试，有效值true、false，默认为false。特别说明下这个调试真的不咋地，很容易让VS崩溃，很鸡肋的功能。
  4. hostspecific:有效值true、false，默认为false。如果将此特性的值设置为 true，则会将名为 Host 的属性添加到由文本模板生成的类中。 该属性是对转换引擎的宿主的引用，并声明为Microsoft.VisualStudio.TextTemplating.ITextTemplatingEngineHost。
  5. inherits：可以指定模板的程序代码可以继承自另一个类，这个类也可以从文本模板生成。目前木有使用过，基本上可以忽略。
  6. compilerOptions:有效值为任何有效的编译器选项。基本上可以忽略 。

T4 参数指令：

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

  1. type：有效值是传递参数的类型名。

  2. name:传递参数的名。

T4 输出指令：

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

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

  1. extension:输出文件扩展名，默认为".cs"。

  2. encoding:文件编码。

T4 程序集指令：

<#@ assembly name="[assembly strong name|assembly file name]" #>
  1. 程序集指令相当于VS里面我们添加程序集引用的功能，该指令只有一个参数name，用以指定程序集名称，如果程序集已经在GAC里面注册，那么只需要写上程序集名称即可，如<#@ assembly name="System.Data.dll" #>，否则需要指定程序集的物理路径。

  2. T4模版的程序集引用是完全独立的，也就是说我们在项目中引用了一些程序集，然后项目中添加了一个T4模版，T4模版所需要的所有程序集引用必须明确的在模版中使用程序集执行引用才可以。
  3. T4模版自动加载以下程序集Microsoft.VisualStudio.TextTemplating.1*.dll、System.dll、WindowsBase.dll，如果用到了其它的程序集需要显示的使用程序集添加引用才可以。
  4. 可以使用 $(variableName) 语法引用 Visual Studio 或 MSBuild 变量（如 $(SolutionDir)），以及使用 %VariableName% 来引用环境变量。介绍几个常用的$(variableName) 变量：

　　　　$(SolutionDir):当前项目所在解决方案目录

$(ProjectDir):当前项目所在目录

　　　　$(TargetPath):当前项目编译输出文件绝对路径

　　　　$(TargetDir):当前项目编译输出目录，即web项目的Bin目录，控制台、类库项目bin目录下的debug或release目录(取决于当前的编译模式)

$(SolutionDir):当前项目所在解决方案目录

　　　　$(ProjectDir):当前项目所在目录

　　　　$(TargetPath):当前项目编译输出文件绝对路径

　　　　$(TargetDir):当前项目编译输出目录，即web项目的Bin目录，控制台、类库项目bin目录下的debug或release目录(取决于当前的编译模式)

　　　　举个例子：比如我们在D盘根目录建立了一个控制台项目TestConsole，解决方案目录为D:\LzrabbitRabbit，项目目录为

　　　　D:\LzrabbitRabbit\TestConsole，那么此时在Debug编译模式下

　　　　$(SolutionDir)的值为D:\LzrabbitRabbit

　　　　$(ProjectDir)的值为D:\LzrabbitRabbit\TestConsole

　　　　$(TargetPath)值为D:\LzrabbitRabbit\TestConsole\bin\Debug\TestConsole.exe

　　　　$(TargetDir)值为D:\LzrabbitRabbit\TestConsole\bin\Debug\

　　　　举个例子：比如我们在D盘根目录建立了一个控制台项目TestConsole，解决方案目录为D:\LzrabbitRabbit，项目目录为

　　　　D:\LzrabbitRabbit\TestConsole，那么此时在Debug编译模式下

　　　　$(SolutionDir)的值为D:\LzrabbitRabbit

　　　　$(ProjectDir)的值为D:\LzrabbitRabbit\TestConsole

　　　　$(TargetPath)值为D:\LzrabbitRabbit\TestConsole\bin\Debug\TestConsole.exe

　　　　$(TargetDir)值为D:\LzrabbitRabbit\TestConsole\bin\Debug\

T4 导入指令：

<#@ import namespace="namespace" #>

在 Visual Studio T4 文本模板的代码块中，import 指令允许您在不提供完全限定名称的情况下引用另一个命名空间中的元素。 它等效于 C# 中的 using 或 Visual Basic 中的 imports。默认已经导入了System命名空间的引用。

T4 包含指令：

<#@ include file="filePath" #>
  1. filePath 可以是绝对的，或相对于当前模板文件。

  2. filePath 可以包括用“%”分隔的环境变量。 例如：<#@ include file="%HOMEPATH%\MyIncludeFile.t4" #>
  3. 所包含的文件的名称不必使用扩展名“.tt”。可能需要针对包含的文件使用其他扩展名，例如，“.t4”。 这是因为，在您将 .tt 文件添加到项目中时，Visual Studio 会自动将其“自定义工具”属性设置为 TextTemplatingFileGenerator。 您通常不希望单独转换包含的文件。
  4. 在处理时，被包含内容就像是包含文本模板的组成部分一样。 不过，即使 include 指令后为普通文本块和标准控制块，也可以包括含有类功能块 <#+...#> 的文件。
  5. 包含指令可以提高代码复用率，比如我们可以将一些常用的程序集、命名空间引用放到一个文件里，使用时仅需要引用下即可，省去了每次都要重新引用一遍的烦恼，如我们建立Reference.ttinclude文件，里面包含了我们平时常用的程序集引用。
<#@ assembly name="System.Core.dll" #>
<#@ assembly name="System.Data.dll" #>

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

<#@ assembly name="System.Xml.dll" #>

<#@ import namespace="System" #>

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

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

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

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

<#@ import namespace="System.Collections.Generic" #>

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

使用时只需要使用包含指令引用下即可：

<#@ include file="$(ProjectDir)Reference.ttinclude"  #>

T4 CleanUpBehavior 指令：

<#@ CleanupBehavior processor="T4VSHost" CleanupAfterProcessingtemplate="true" #>

T4 自定义指令:

请参见创建自定义 T4 文本模板指令处理器。

文本块:

文本块是直接复制到输出的内容。 文本块没有特殊格式。 例如，下面的文本模板将生成一个包含单词“Hello World!”的文本文件：

<#@output extension=".txt" #>
Hello World!

控制块：

控制块是用于转换模板的程序代码节。 默认语言是 C#，但若要使用 Visual Basic，可以在文件开头编写以下指令：

<#@ template language="VB" #>

用于编写控制块代码的语言与生成的文本的语言无关。

标准控制块：

标准控制块是生成输出文件部件的程序代码节。

在模板文件中，可以混合使用任意数量的文本块和标准控制块。 但是，不能在控制块中嵌套控制块。 每个标准控制块都以 <# ... #> 符号分隔。

例如，如果使用下面的控制块和文本块，则输出文件包含行“0, 1, 2, 3, 4 Hello!”：

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

    {

        Write(i + ", ");

    }

    Write("4");

#> Hello!

您可以交错文本和代码，而不必使用显式 Write() 语句。 以下示例输出“Hello!”四次：

<#

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

    {

#>

Hello!

<#

    } 

#>

在代码中，可以使用 Write(); 语句的位置都可以插入文本块。

表达式控制块：

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

表达式控制块以 <#= ... #> 符号分隔。

例如，如果使用下面的控制块，则输出文件包含“5”：

<#= 2 + 3 #>

请注意，开始符号有三个字符“<#=”。

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

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

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

    {

#>

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

<#

    } 

#>

类功能控制块：

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

类功能控制块以 <#+ ... #> 符号分隔。

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

<#@ 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 #>.

<#   

}

#>

将文本生成方法放置在可供多个模板包含的单独文件中，是非常有用的。


T4文本模板编写是T4模板运用的基础，掌握了这些简单的编写规则，再结合上节T4文本模板转换过程中的示例，我们就可以动手编写基于T4模板的代码生成器了。

详见下节：一个简单的代码生成器（T4文本模板运用）

编写 T4 文本模板

时间： 2024-08-27 01:17:11

编写 T4 文本模板的相关文章

T4文本模板转换过程

T4文本模板转换过程将文本模板文件作为输入,生成一个新的文本文件作为输出. 例如,可以使用文本模板生成 Visual Basic 或 C# 代码,还可以生成 HTML 报告. 有三个组件参与这一过程:引擎.宿主和指令处理器. 引擎对该过程进行控制(引擎与宿主和指令处理器交互),以生成输出文件:宿主提供与环境的所有交互(如定位文件和程序集); 指令处理器为文本模板添加功能(如从 XML 文件或数据库读取数据等). 组件: 组件 说明 可自定义(是/否) 引擎 引擎组件控制文本模板转换过程. 否 主

一个简单的代码生成器（T4文本模板运用）

说要写这篇文章有一段时间了,但因为最近各方面的压力导致心情十二分的不好,下班后往往都洗洗睡了.今天痛定思痛,终于把这件拖了很久的事做了.好,不废话了,现在看看"一个简单的代码生成器" . 先看看界面吧! 简约到如此,说是代码生成器,估计是要被吐槽的.好吧,借用园子里博友的说法,这只是一粒粟子,如果你愿意,你能看到代码生成器的"种子". 这样运行的! 画了个简图已描述这个简单的代码生成器的工作过程.下面的介绍将以此图展开: 1)读取数据表的信息:从数据库中读取数据表的

T4文本模板

<#...#> 可以包含语句 <#=...#>  用于表达式,提供“输出”操作 <#+ ...> 使用类功能控制块向文本模板添加方法.属性.字段,必须作为文件中最后一个块显示 assembly 指令使指定的程序集可供模板代码使用,方式与 Visual Studio 项目中的“引用”部分相同. 您无需包括对 System.dll 的引用,它是自动引用的. import 指令允许您使用类型而不使用其完全限定名,方式与普通程序文件中的 using 指令相同 若要从相对于文本模

C#代码生成工具:文本模板初体验 使用T4批量修改实体框架(Entity Framework)的类名

转自:http://www.cnblogs.com/huangcong/archive/2011/07/20/1931107.html 在之前的文本模板(T4)初体验中我们已经知道了T4的用处,下面就看看如何用它来实现批量修改实体框架(Entity Framework)中的类名.我们都知道ADO.NET 实体数据模型中有一种方式是以数据库模型来生成数据模型的,这是个很简便的实体数据模型生成的方式,但是因为微软提供的自定义接口不足,我们无法实现对生成的数据模型实体类批量进行修改(至少我上网找了很久

T4模板之文本模板

网址:https://docs.microsoft.com/en-us/visualstudio/modeling/design-time-code-generation-by-using-t4-text-templates?view=vs-2017 T4模板在平时我们其实都会或多或少的遇到.最多的用在实体与数据库的映射上面. 这里只记录一下他的语法. 需要的插件:vs2017 T4代码高亮插件:Devart T4 Editor T4生成多文件:T4 Toolbox  (使用这个可以很好的生成我

django之创建第3个项目:编写第一个模板文件

1.django结构 2.在站点blog下创建templates文件夹,专门用于存放模板文件 3.在templates文件夹下创建index.html文件 #index.html <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>第一个模板文件</title> </head> <body&

编写数组删除模板

对于javascript中的一些小的知识点很零碎,所以自己根据理解编写小的方法,以至于快速应用. 此次代码的作用是删除数组中的第n个元素: 1 <!doctype html> 2 <html> 3 <head> 4 <meta charset="utf-8"> 5 <title>自定义数组删除</title> 6 7 <script> 8 9 Array.prototype.remove=functio

javascript编写自己的模板解析器

编写自己的模板解析器 因为最近在研究artTemplate,ejs,baaiduTemplate等模板,所以,一时兴起,自己也写了个简单的模板解析器. 一个最基本的模板解析器,需要有什么功能呢? 读取变量值 解析模板语句 按照这个思路,我们编写一个简单的解析器,需求如下: 读值: <%= 变量名 %> 语句支持: <% if( type == 1 ){ %> good! <%}%> 总体来说,就是如果模板如下: 我叫:<%= name %> <br/&

关于C#中文本模板(.tt)的简单应用

转自http://www.it165.net/pro/html/201409/21789.html 这两天做项目突遇 .tt文件,之前没有接触过,so查询学习做笔记,帮助记忆和后来者. 在项目添加中点击选择文本模板 下面贴出代码,做了简单的注释 01.<#@ template debug="false" hostspecific="false" language="C#" #> 02.<#@ assembly name=&quo