T4工具箱 - 引用当前程序集中的类

时间:2010-07-21 10:08:24

标签: .net visual-studio t4 t4-toolbox

我正在编写一个T4脚本,它反映了某些类,并提供基于它们的代码生成。问题是我的脚本错误,说我当前项目中的类无法访问。

脚本本身与我尝试引用的类位于同一个程序集中。我已经尝试引用命名空间,文件并添加对当前程序集的引用(项目本身) - 一切都无济于事。

我错过了什么?

4 个答案:

答案 0 :(得分:10)

我相信这就是Nicko和uos正在寻找的东西。只需使用T4模板将“MyAssembly.CodeGeneration”更改为项目名称。

<#@ assembly name="$(TargetPath)MyAssembly.dll" #>
<#@ import namespace="MyAssembly.CodeGeneration" #>

答案 1 :(得分:2)

要记住的一件事是,您正在编写的T4脚本实际上并不“驻留在同一个程序集中” - 因为它是设计时代码,而不是运行时代码。换句话说 - 它不会被编译到你的程序集

相反,T4模板脚本在您编写代码时运行 - 或者,如果您启用了某些挂钩,则无论何时构建/编译程序。因为它实际上与你的项目分开,但它没有能力直接引用项目的程序集 - 除非你使用像 DTE 这样的东西 - 这使你能够访问Visual Studio环境本身,并探索当前加载的项目等元素。

例如,请考虑以下脚本:

<#@ template language="C#" debug="false" hostspecific="true" #>
<#@ output extension=".js" #>
<#@ assembly name="System" #>
<#@ assembly name="System.Core" #>
<#@ assembly name="System.Data.Entity" #>
<#@ assembly name="EnvDTE" #>
<#@ import namespace="EnvDTE" #>
<#@ include file="T4Toolbox.tt" #>
<#@ import namespace="System" #>
<#@ import namespace="System.Collections" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Reflection" #>

string targetNamespace = "MyNamespace";
var dte = (DTE)TransformationContext.Current.GetService(typeof(DTE));
var project = dte.Solution.FindProjectItem(TransformationContext.Current.Host.TemplateFile).ContainingProject);

var classes = FindClasses(project, targetNamespace, "");

<# foreach (CodeClass c in classes) { #>

    public class <#= c.Name #> {

<#     var properties = c.Members.OfType<EnvDTE.CodeProperty>()
           .Where(p => p.Access.HasFlag(vsCMAccess.vsCMAccessPublic))
           .OrderBy(p => p.Name);
       foreach (var prop in properties) { 
#>

       public <#= prop.Type.AsString #> <#= prop.Name #> { get; set; }

<#     } #>

   }

<# } #>

<#+ List<CodeClass> FindClasses(Project project, string ns, string className) {
        List<CodeClass> result = new List<CodeClass>();
        FindClasses(project.CodeModel.CodeElements, className, ns, result, false);
        return result;
    }
    void FindClasses(CodeElements elements, string className, string searchNamespace, List<CodeClass> result, bool isNamespaceOk) {
        if (elements == null) return;
        foreach (CodeElement element in elements) {
            if (element is CodeNamespace) {
                CodeNamespace ns = element as CodeNamespace;
                if (ns != null) {
                    if (ns.FullName == searchNamespace)
                        FindClasses(ns.Members, className, searchNamespace, result, true);
                    else
                        FindClasses(ns.Members, className, searchNamespace, result, false);
                }
            } else if (element is CodeClass && isNamespaceOk) {
                CodeClass c = element as CodeClass;
                if (c != null) {
                    if (c.FullName.Contains(className))
                        result.Add(c);

                    FindClasses(c.Members, className, searchNamespace, result, true);
                }
            }
        }
    }

本质上,此脚本将运行特定的命名空间(在本例中为"MyNamespace"),遍历其中的所有类,然后输出一个新的代码文件,该文件仅列出其公共属性{{ 1}} / getter - 本质上,生成对象的POCO。在我的一些项目中,我使用此代码的改编版本来生成基于我的POCO的JavaScript对象,以便从序列化的角度来看,我的JS模型始终可以与我的服务器端对象同步。

然而,它的诀窍在于前几行:

setter

本质上,DTE服务要求Visual Studio为其提供当前加载的var dte = (DTE)TransformationContext.Current.GetService(typeof(DTE)); var project = dte.Solution.FindProjectItem(TransformationContext.Current.Host.TemplateFile).ContainingProject); var classes = FindClasses(project, targetNamespace, ""); 及其Solution的抽象模型。然后,我们加载存储当前Projects的{​​{1}},并在Project方法中解析该项目中符合搜索条件的类。

我希望示例代码为您提供一个跳出的起点 - 但如果您需要更多详细信息,请参阅以下几个参考资料,以便您深入了解:

答案 2 :(得分:1)

出于某种原因,我无法让@brian解决方案正常工作。我最终这样做了 就我而言,T4Generators是我在同一解决方案中的独立项目。

<#@ assembly name="$(SolutionDir)\T4Generators\bin\Debug\T4Generators.dll" #>
<#@ import Namespace="T4Generators" #>

答案 3 :(得分:0)

参考它的常用方法。然后检查是否加载了程序集 - 如果没有 - 生成存根代码(使编译成为可能;在编译之后再次运行T4,以生成实际代码)。并且有单元测试可以防止存根代码进入生产。