将对象传递给T4模板

本文关键字：T4 模板 对象 | 更新日期: 2023-09-27 17:58:09

我有一个User类类型的对象u1。用户具有属性name。如何将u1传递给T4模板？我正在尝试做一些非常简单的事情：

User u1 = new User("John");


模板脚本：

Hello <# u1.Name #>

将对象传递给T4模板

我们做了类似的事情。我们的解决方案包含以下元素：

  • 自定义主机
  • 自定义模板基类（template指令的"继承"属性）
  • 主机特定的模板（template指令的"主机特定"属性）

自定义主机由模板本身想要调用方法的对象聚合。

interface ICallbackInterface
{
    void CallbackFxn();
}
[Serializable]
public class MyCustomHost : ITextTemplatingEngineHost, ITextTemplatingSessionHost, IStencilFileRecordManagement
{
    private ICallbackInterface callback = null;
    public MyCustomHost(ICallbackInterface cb)
    {
        callback = cb;
    }
    public void CallbackFxn()
    {
        callback.CallbackFxn();
    }
}
public abstract class MyTemplateBase : TextTransformation
{
    public virtual MyCustomHost CustomHost
    {
        get
        {
            dynamic metame = this;
            MyCustomHost rval = null;
            try
            {
                /// <summary>
                /// The "Host" property will be added to the generated class by the T4 environment whenever a 
                /// "hostspecific" template is processed. 
                /// </summary>
                rval = metame.Host as MyCustomHost;
            }
            catch (RuntimeBinderException e)
            {
                logger.ErrorException(
                    "Received the following exception while processing a stencil template", e);
            }
            return rval;
        }
    }
}

现在，在我们的任何模板中，我们都可以调用对象上的方法，这些方法实际上是使用自定义主机属性启动处理的，例如：

<# CustomHost.CallbackFxn(); #>

此外，我们不在VS中使用T4，也不使用单独的可执行文件——我们链接到Microsoft.VisualStudio.TextTemplateing.10.0和Microsoft.VisualStudio.TxtTemplateing.Interfaces.10.0程序集。

编辑

我们使用T4模板，允许用户定义自己的插件，以便在我们的产品工作流程中的特定步骤中使用。因此，用户模板被上传到我们的系统，并像这样处理：

using Microsoft.VisualStudio.TextTemplating;
class UserPluginWorkflowComponent : ICallbackInterface
{
    public void CallbackFxn()
    {
        // invoked by user plugin
    }
    public void ExecuteUserPlugin()
    {
        MyCustomHost host = new MyCustomHost(this);
        host.TemplateFileValue = "UserPluginTemplateFilename";
        Engine engine = new Engine();
        string pluginResult = engine.ProcessTemplate(
            userPluginTemplateFileContents, 
            host);            
        if (!host.Errors.HasErrors)
        {
            // use pluginResult in some meaningful way
        }
    }
}

您想在模板中使用它吗？然后，您需要添加对包含该类型的程序集的引用。你不能简单地将现有的引用传递给T4引擎，除非你自己以某种高度非正统的方式托管它（我从未见过有人会这样做）。即使你走得那么远，你会怎么跑？这个参考应该从哪里来？

在T4模板中使用类型就像在类存根<#+ /*stuff goes here*/ #>中添加引用或复制/粘贴它一样简单。

T4模板在一个步骤中进行处理，因此模板在运行过程中需要获得所需的一切，因为您并没有真正"传递"任何东西。由于模板是文本，我通常只会在文件顶部设置一些参数。如果你需要用户输入，你可以有一个弹出窗口，但在生成代码时听起来很烦人。

另一个解决方案是使用自定义模板，该模板在t4模板中使用模板替换，类似于许多已安装模板的工作方式。

假设您希望在某个应用程序或工具中包含最终运行模板的代码，则使用运行时（预处理）模板，该模板具有在<#+#>中定义的自定义属性类功能块或<#@parameter#>指令应该提供您想要的内容。

请查看此处的文档：http://msdn.microsoft.com/en-us/library/gg586944.aspx

Hey-您需要在T4脚本中设置值等，因此User初始化必须在<# #>标记中进行，这将使您的示例类似于

     <# User u1 = new User() { .Name = "John" } #>
     Hello <# u1.Name #>

如上所述，您可能还需要导入名称空间。我在TT文件的开头使用了以下语句来访问System.Data:

     <#@ import namespace="System.Data" #>
     <#@ import namespace="System.Data.SqlClient" #>
     <#@ assembly name="System.Data" #>
相关文章：