T4模板生成文件要点记录

最新推荐文章于 2023-11-26 10:21:49 发布

ahe82105

最新推荐文章于 2023-11-26 10:21:49 发布

阅读量177

点赞数

原文链接：http://www.cnblogs.com/zhaow/p/9754062.html

版权

可以使用 $(variableName) 语法引用 Visual Studio 或 MSBuild 变量（如 $(SolutionDir)），以及使用 %VariableName% 来引用环境变量。
介绍几个常用的$(variableName) 变量：

$(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\

若要创建运行时模板，请向您的项目中添加“已预处理的文本模板”文件。另外，您还可以添加纯文本文件并将其“自定义工具”属性设置为“TextTemplatingFilePreprocessor”。
若要创建设计时模板，请向您的项目中添加“文本模板”文件。另外，您还可以添加纯文本文件并将其“自定义工具”属性设置为“TextTemplatingFileGenerator”。

T4基本结构：
T4模板可以分为：指令块、文本块、控制块。
    指令块 - 向文本模板化引擎提供关于如何生成转换代码和输出文件的一般指令。
    文本块 - 直接复制到输出的内容。
    控制块 - 向文本插入可变值并控制文本的条件或重复部件的程序代码，不能在控制块中嵌套控制块。

6个指令<#@ template #>、<#@ parameter#>、<#@ assembly #>、<#@ import #>、<#@ include #>、<#@ output #>、
其中， output 和 assembly 只能用在设计时模板。

控制块：
有三种类型的控制块，根据其左括号对它们进行区分：
1.<# 标准控制块 #> 可以包含语句。
2.<#= 表达式控制块 #> 将一个可以计算为字符串的表达式括起来,用于提供要写入“输出”文件的字符串的代码。
3.<#+ 类功能控制块 #> 可以使用类功能控制块向文本模板添加方法、属性、字段甚至是嵌套类。必须作为文件中的最后一个块显示，或者用<#@ include #>引入外部文件。

注意：
1)始终使用 {...}花括号来包含内嵌的嵌套语句，否则会报错。（哪怕花括号中只有一句代码）
2)控制块不能互相嵌套。必须先终止之前的控制块，然后才能打开另一个。

T4文本模板的断点调试
    注册表：设置DbgJITDebugLaunchSetting值为 2。
    (x86系统): HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework
    (x64 系统): HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\.NETFramework

    为template指令添加debug="true"特性：<#@ template debug="true"#>

    命令：
    <# System.Diagnostics.Debugger.Launch();#>在模板执行到特定点启动调试器。如果用Debugger.Break()启动调试器在调试完后会导致 VS 奔溃。
    <#System.Diagnostics.Debugger.Break();#>启动调试器后，使用此命令在后续特定点处再次进入调试模式，相当于断点。(此种方式会让vs崩溃)

使用方法：必须使用“Debugger.Launch()”命令启动调试器（如下图，启动新实例或使用已存在的VS附加。注意，若此处点击取消则将关闭当前IDE），调试完后可以不用中断调试，不影响模板编辑，当再次编译模板时如果存在“Debugger.Break()”命令则自动进入调试模式。

自定义生成的文件存放路径：
String outputPath = Path.Combine(Path.GetDirectoryName(host.TemplateFile),"Model");

调试的时候发现一个问题：在GetCurrentProject()方法里获取当前项目dte.ActiveSolutionProjects，第一次生成正常，但是一编译项目再生成，这里就获取不到项目了，
Array activeSolutionProjects = (Array)dte.ActiveSolutionProjects 里面是个空数组，导致生成失败，提示“正在运行转换: System.IndexOutOfRangeException: 索引超出了数组界限”错误。

万般无奈，只好采用避开调用这里的措施：
在.tt模板里，把定义connectionString、dbProviderName的地方重新写死。如：
var connectionStringName = "Northwind";
var dbContextName = Host.TemplateFile.Split('\\')[Host.TemplateFile.Split('\\').Length - 1].TrimEnd('.', 't');
//var connectionStringSetting = GetConnectionStringSettings(connectionStringName);
//var connectionString = connectionStringSetting.ConnectionString;
//var dbProviderName = connectionStringSetting.ProviderName;

var connectionString = "Data Source=ZHAOWEI-PC\\SQLEXPRESS;Initial Catalog=Northwind;Persist Security Info=True;User ID=sa;Password=123456";
var dbProviderName = "System.Data.SqlClient";
var dbConfiguration = DbConfiguration.Configure(connectionString, dbProviderName);
var databaseSchema = dbConfiguration.Schema;
var manager = Manager.Create(Host, GenerationEnvironment);
var namespace1 = manager.DefaultProjectNamespace+".Model";
manager.StartHeader();
。。。。
这样问题暂时解决了。

-------------------------------------------------------------------------------------------------------------
T4模板调试需注意的地方：
1、.tt模板的属性自定义工具=TextTemplatingFileGenerator，生成操作=无；
      生成的附属文件属性自定义工具=无，生成操作=编译
2、在下列任何一种情况下，将执行模板，同时生成附属文件：
    编辑该模板，然后将焦点更改到其他 Visual Studio 窗口。
    保存模板。
    单击“生成”菜单中的“转换所有模板”。这将转换 Visual Studio 解决方案中的所有模板。
    在“解决方案资源管理器”中，在任何文件的快捷菜单上，选择“运行自定义工具”。使用此方法可以转换选定的模板子集。


<#@ import namespace="EnvDTE" #>

EnvDTE路径：
C:\Program Files (x86)\Common Files\microsoft shared\MSEnv\PublicAssemblies
<#@ Assembly Name="C:\Program Files (x86)\Common Files\microsoft shared\MSEnv\PublicAssemblies\envdte.dll" #>
<#@ Import namespace="EnvDTE80" #>
<#@ Import namespace="EnvDTE90" #>
<#@ Import namespace="EnvDTE90a" #>
<#@ Import namespace="EnvDTE100" #>

private EnvDTE.Project getActiveProject(EnvDTE.DTE dte)
{
    Array projects = dte.ActiveSolutionProjects as Array;
    if (projects == null || projects.Length == 0)
    {
        projects = dte.Solution.SolutionBuild.StartupProjects as Array;
        if (projects == null || projects.Length == 0)
        {
            EnvDTE.Projects pro = dte.Solution.Projects;
            if (pro == null || pro.Count == 0)
                return null;
            return pro.Item(0);
        }
    }
    return projects.GetValue(0) as EnvDTE.Project;
}

public Project getActiveProject()
{
Array projects = (Array)_applicationObject.ActiveSolutionProjects;
if(projects != null && projects.Length > 0)
{
    return projects.GetValue(0) as Project;
}
projects = (Array)_applicationObject.Solution.SolutionBuild.StartupProjects;
if(projects != null && projects.Length >= 1)
{
    return projects.GetValue(0) as Project;
}
projects = (Array)_applicationObject.Solution.Projects;
if(projects != null && projects.Length > 0)
{
    return projects.GetValue(0) as Project;
}
return null;
}

待解决问题：
(Array)dte.ActiveSolutionProjects IndexOutOfRangeException
(Array)dte.ActiveSolutionProjects 索引超出了数组界限

参考：
https://msdn.microsoft.com/zh-cn/library/gg604090
https://msdn.microsoft.com/zh-cn/library/dd820620
http://www.cnblogs.com/guohu/p/4541418.html
http://blog.chenxu.me/post/detail?id=2c393950-acbe-4367-8039-a326449c8d22
https://social.msdn.microsoft.com/Forums/vstudio/en-US/4b746a30-9f6f-446b-9e1e-54b5ba3f29b7/activesolutionprojects-indexoutofrange?forum=vsx