功能强大的T4文本模版
希望您至少能意识到即使有代码自动生成器,但数据库结构变更等因素也会给我们带来不少的麻烦。这种直接放到项目里.tt文件的好处自然不用多说了。有特别的业务需求,在.用partial类来实现,免得模板文件自动更新代码时将手写的代码覆盖掉。
T4文本模版到底有什么用?什么时候用?
看一下下面这个示例你应该就会明白了:
新建一个控制台应用程序,删除里面的所有文件,新建一个Program.tt的文件,并输入如下内容:
- <#@ template language="C#"debug="true"#>
- <#@ output extension=".cs"encoding="utf-8"#>
- <#
- stringClassName = "Program";
- #> stringClassName = "Program";
- #>
- namespaceHelloAngel
- {
- usingSystem;
- class<#=ClassName #>
- {
- staticvoidMain(string[] args)
- {
- Console.WriteLine("Hello Angel");
- }
- }
- }
保存后我们会看到解决方案资源管理器中是这个样式的:
此时的Program.cs文件正是我们的Program.tt文件生成的,其内容如下:
- namespaceHelloAngel
- {
- usingSystem;
- classProgram
- {
- staticvoidMain(string[] args)
- {
- Console.WriteLine("Hello Angel");
- }
- }
- }
看看下面两个指令:
- <#@ template language="C#"debug="true"#>
- <#@ output extension=".cs"encoding="utf-8"#>
<#@ template #>指令中language指定了我们模板运行使用的语言,可以是VB,或C#,debug声明了是否使用调试,如果用不到调试,可以设置为false.
<#@ output #>指令中extension指定了输出文件的扩展名,encoding指定输出文件的编码方案。
也就是说,我们可以使用C#语言来写此模板文件中的逻辑,模板将会输出一个与模板文件名相同,扩展名为.cs编码为utf-8的文件。
这里稍作了解下,接下来看看指令的语法吧:
指令的语法如下所示:
- <#@ DirectiveName [AttributeName = "AttributeValue"] ... #>
必须将所有特性值放在双引号内。如果值本身包含引号,则必须使用 字符对这些引号进行转义。
指令通常是模板文件或包含的文件中的第一个元素。不应将它们放置在代码块 <#...#> 内,也不应放置在类功能块 <#+...#> 之后。
T4 模板指令
<#@ template [language="VB"] [hostspecific="true"] [debug="true"] [inherits="templateBaseClass"] [culture="code"] [compilerOptions="options"] #>
T4 参数指令
<#@ parameter type="Full.TypeName"name="ParameterName"#>
T4 输出指令
<#@ output extension=".fileNameExtension"[encoding="encoding"] #>
T4 程序集指令
<#@ assembly name="[assembly strong name|assembly file name]"#>
T4 导入指令
<#@ import namespace="namespace"#>
T4 包含指令
<#@ include file="filePath"#>
看了上面的指令后,就试着写个模板文件生成一些类来练习一下吧:
- <#@ template language="C#"debug="true"#>
- <#@ output extension=".cs"encoding="utf-8"#>
- <#@ import namespace="System.Collections.Generic"#>
- <#
- List< List<string>classNames =
- new List<string>()
- {
- "Hello",
- "Test"
- };
- List<string>callMethods = new List<string>();
- #>
- namespace HelloAngel
- {
- using System;
- <#
- foreach (string className in classNames)
- {
- callMethods.Add(string.Format("{0}.Show();", className));
- #> foreach (string className in classNames)
- {
- callMethods.Add(string.Format("{0}.Show();", className));
- #>
- class <#=className #>
- {
- /// <summary>
- /// <#=className #>的注释
- /// </summary>
- public static void Show()
- {
- Console.WriteLine("ClassName:<#=className #>");
- }
- }
- <#
- #> }
- #>
- class Program
- {
- /// <summary>
- /// 入口方法的注释
- /// </summary>
- static void Main(string[] args)
- {
- <#
- foreach (string callMethod in callMethods)
- {
- #> foreach (string callMethod in callMethods)
- {
- #>
- // <#=callMethod #>调用
- <#=callMethod #>
- <#
- }
- #> }
- #>
- }
- }
- }
我们一般的项目多是分了简单三层,有了上面的一些经验,你应该会想。要是只写三个类.tt文件,就能自动给我们把整个三层维护好那多令人兴奋啊!确实,我就是这样做了一个项目给大家分享一下:
看看现在整个项目成什么样子了:
这里不止三个项目了。我加了个UnitTest的项目,一个Adapters的项目,看项目名称不难看出来,UnitTest项目就是一个测试项目。而Adapters项目呢,是实体适配器项目。先不管它们了。
就这么点东西,已经完成三层的架设了,只是还是Paramter方式的。没有对存储过程的支持。十一如果没有人陪我过的话,我会将对存储过程的支持添加上去。
建项目的时候建的是.net 4的,这里我把它改为.net2.0的了。不过本人只装有visual stuido 2010,如果您使用的是Visual studio 2008请您自行将项目文件中的版本号更正,此方法网上有许多。我就不多啰嗦了。
原文链接:http://www.cnblogs.com/javennie/archive/2011/09/24/t4.html
【编辑推荐】