T4模板和运行时参数

Question

我正在 VS 2010 中构建一个插件，但我陷入了 T4 一代。 现在，我已经实现了（就像 MSDN 建议的那样）一个自定义 T4 主机来生成我的 T4 结果，并且我以这种方式使用它：

        const string content = @"c:\Simple.tt";
        var engine = new Engine();
        var host = new MyTemplateHost();            
        var result = engine.ProcessTemplate(File.ReadAllText(content), host);
        foreach (CompilerError error in host.Errors)
        {
            Console.WriteLine(error.ErrorText);
        }

直到我在模板中传递参数为止，它都有效。一旦我在 .tt 文件中创建参数，主机就会惊慌失措地说它不知道如何解析它。 我看到你可以使用 TemplateSession 来做到这一点，但我不知道如何将它传递给我的主机？ 是否有更好的方法使用 C# 从 .tt 生成代码并在运行时传递参数？也许我走错了路。

Answer 1

在 Visual Studio 2010 中，T4 模板引擎发生了根本性的变化。
现在您可以直接运行模板文件并向其传递您想要的任何参数类型。

        var template = Activator.CreateInstance<SimpleTemplate>();
        var session = new TextTemplatingSession();
        session["namespacename"] = "MyNamespace";
        session["classname"] = "MyClass";
        var properties = new List<CustomProperty>
        {
           new CustomProperty{ Name = "FirstProperty", ValueType = typeof(Int32) }
        };
        session["properties"] = properties;
        template.Session = session;
        template.Initialize();

该语句将处理以下模板：

<#@ template language="C#" debug="true"  #>
<#@ output extension=".cs" #>
<#@ assembly name="System.dll" #>
<#@ import namespace="System" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ import namespace="SampleDomain.Entities" #>
<#@ parameter name="namespacename" type="System.String" #>
<#@ parameter name="classname" type="System.String" #>
<#@ parameter name="properties" type="System.Collections.Generic.List<CustomProperty>" #>

using System;
using System.Collections.Generic;
using SampleDomain.Entities;

namespace <#= this.namespacename #>
{
public class <#= this.classname #>

所以说实话，不再需要主机了......

Answer 2

如果您正在为 VS 构建加载项，您可能不需要自定义主机，而是可以通过其服务接口使用内置 VS 主机。

查看 ITextTemplated 作为核心服务 API，您可以通过将 DTE 对象强制转换为 IServiceProvider，然后调用 GetService(typeof(STextTemplated))

来获取要传递参数，然后可以将 ITextTemplated 对象侧向强制转换为 ITextTemplatedSessionHost 并将 Session 属性设置为 ITextTemplatedSession。会话本质上只是一个可序列化的属性包。有一个简单的会话，以 TextTemplatedSession 的形式提供。

Answer 3

将 ITextTemplateSessionHost 添加并实施到您的自定义主机。仅实现 ITextTemplateEngineHost 不会为您提供会话支持。

 [Serializable()]
    public class CustomCmdLineHost : ITextTemplatingEngineHost,ITextTemplatingSessionHost
    {

        ITextTemplatingSession session = new TextTemplatingSession();

        public ITextTemplatingSession CreateSession()
        {
            return session;
        }

        public ITextTemplatingSession Session
        {
            get
            {
                return session;
            }
            set
            {
                session = value;
            }
        }

Answer 4

使用 T4 模板进行运行时生成

1. 如果您需要在运行时生成代码，请选择此方法。例如，您想使用 Selenium 生成页面对象。

   

2. 在您的解决方案中创建一个文件夹，将其命名为 Templates（适合用于
   T4 模板）。

3. 接下来添加一个类型为 T4 的新项目，然后选择
   运行时文本模板...我们将模板命名为 MyNodeName.tt，如上图所示。

4. 添加您的代码，如下所示，顶部部分由 Visual Studio 插入...

您可以看到我们想要传递命名空间和类名（这些是上面看到的 Model.NameSpaceName 和 Model.ClassName 标记。

棘手的部分是学习如何传递参数...

创建一个名为partial的新CS类在文件名中

。 alt="Partial File Name">

但在类中不要将其命名为 MyNodeNamePartial，将其命名为 MyNodeName，如下所示：

   public partial class MyNodeName
    {
       public MyNodeNameModel Model { get; set; }
    }

这与创建自己的部分类的 TT 文件 (MyNodeName) 同名。请注意，我们有一个名为 MODEL 的此类类型的值。

   public class MyNodeNameModel
    {
        public MyNodeNameModel()
        {
            ClassName = "Test";
        }
        public string ClassName { get; set; }
        public string NameSpaceName { get; set; }
    }

模型类包含 ClassName 和 NameSpaceName 以及您想要“注入”到模板中的任何其他内容。

此工作的关键如图所示，
是使用了运行时文本模板！如果您使用文本模板，无论您做什么，您都会看到类似于“找不到模型”的错误或其他不明确的问题。

调试技巧：
“无法找到模型”是 T4 生成代码，告诉您在带有名为 MODEL 的变量的部分类中，它无法找到它！检查您的部分类型和模型类型，以确保它们与在该文件夹中创建的任何其他普通类命名空间位于同一命名空间中。

Answer 5

请参阅 MSDN 参考（“在构造函数中传递参数”部分）。

总结一下：

创建一个与 TT 文件同名的分部类。

partial class MyWebPage
{
    private MyData m_data;
    public MyWebPage(MyData data) { this.m_data = data; }}
}

然后只需在类的构造函数中传递参数即可

MyWebPage page = new MyWebPage(data);
String pageContent = page.TransformText();

Answer 6

我尝试了这里的所有答案以使其发挥作用，但没有一个适合我的场景。最终我将以下内容添加到我的模板中......

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

然后它就起作用了