一个简易版的T4代码生成"框架"

对于企业开发来说，代码生成在某种意义上可以极大地提高开发效率和质量。在众多代码生成方案来说，T4是一个不错的选择，今天花了点时间写了一个简易版本的T4代码生成的“框架”，该框架仅仅是定义了一些基本的基类以及其他与VS集成相关功能的类型而已。[源代码从这里下载]

目录
一、T4模版的定义和代码文件的生成
二、TransformationContext与TransformationContextScope
三、Template
四、Generator
五、扩展方法RunCodeGenerator

一、T4模版的定义和代码文件的生成

我们先来看看最终的代码生成需要定义那些东西，以及T4模版应该如何定义。对于这个框架来说，代码结构的生成是通过继承自我们自定义基类Template的自定义类型实现的。作为演示，我们定义了如下一个DemoTemplate。从代码可以看出，DemoTemplate仅仅用于生成一个空类，类型名称在构造函数中指定。

public class DemoTemplate: Template
{
    public string ClassName { get; private set; }
    public DemoTemplate(string className)
    {
        this.ClassName = className;
    }
    public override string TransformText()
    {
        this.WriteLine("public class {0}",this.ClassName);
        this.WriteLine("{");
        this.WriteLine("}");
        return this.GenerationEnvironment.ToString();
    }
}

代码的生成最终通过执行相应的Generator来实现，为此我们定义了如下一个DemoGenerator。DemoGenerator最终会生成三个.cs文件，而每个文件的代码最终由上面定义的DemoTemplate来生成。如下代码片段所示，继承自Generator的DemoGenerator重写了CreateTemplates方法，返回一个字典对象。字典的Key代表生成的文件名，而Value则表示相应的Template对象。

public class DemoGenerator : Generator
{
    protected override IDictionary<string, Template> CreateTemplates()
    {
        Dictionary<string, Template> templates = new Dictionary<string, Template>();
        templates.Add("Foo.cs", new DemoTemplate("Foo"));
        templates.Add("Bar.cs", new DemoTemplate("Bar"));
        templates.Add("Baz.cs", new DemoTemplate("Baz"));
        return templates;
    }
}

最后我们在T4文件中以如下的方式执行DemoGenerator来生成我们需要的三个.cs文件。

<#@ template hostspecific="true" language="C#" #>
<#@ assembly name="$(TargetDir)Artech.CodeGeneration.dll" #>
<#@ import namespace="Artech.CodeGeneration" #>
<#@ output extension=".empty" #>
<#
this.RunCodeGenerator(this.Host, new DemoGenerator());
#>

三个.cs文件（Foo.cs、Bar.cs和Baz.cs）最终会以如下的方式生成出来。

二、TransformationContext与TransformationContextScope

接下来我们来简单看看Generator最终是如何利用Template生成相应的文本文件的，不过在这之前我们先来了解一下TransformationContext与TransformationContextScope这两个类型。顾名思义，TransformationContext用于存储T4文本转换的上下文信息，而TransformationContextScope用于限制TransformationContext的作用范围，这与Transaction/TransactionScope的关系一样。

TransformationContext定义如下，静态属性Current表示当前的TransformationContext，通过它可以得到当前的TextTransformation （即T4文件本身对应的那个TextTransformation 对象），当前的TextTemplatingEngineHost，以及针对T4文件的DTE和ProjectItem。

public class TransformContext
{
    public static TransformContext Current { get; internal set; }
    public TextTransformation Transformation{get; private set;}
    public ITextTemplatingEngineHost Host {get; private set;}
    public DTE Dte { get; private set; }
    public ProjectItem TemplateProjectItem { get; private set; }

    internal TransformContext(TextTransformation transformation, ITextTemplatingEngineHost host)
    {
        this.Transformation = transformation;
        this.Host = host;
        this.Dte = (DTE)((IServiceProvider)host).GetService(typeof(DTE));
        this.TemplateProjectItem = this.Dte.Solution.FindProjectItem(host.TemplateFile);
    }

    public static void EnsureContextInitialized()
    {
        if (null == Current)
        {
            throw new TransformationException("TransformContext is not initialized.");
        }
    }
}

TransformationContext的构造函数是Internal的，所以不能在外部直接构建，我们通过具有如下定义的TransformationContextScope来创建它并将其作为当前的TransformationContext。TransformationContextScope实现了IDisposable接口，在实现的Dispose方法中当前的TransformationContext被设置为Null。

public class TransformContextScope: IDisposable
{
    public TransformContextScope(TextTransformation transformation, ITextTemplatingEngineHost host)
    {
        TransformContext.Current = new TransformContext(transformation, host);
    }

    public void Dispose()
    {
        TransformContext.Current = null;
    }
}

 

三、Template

代码生成的逻辑实现在继承自具有如下定义的Template类型中，而它是TextTransformation的子类。Template的核心是Render和RenderToFile方法，前者指将生成的代码写入T4文件对应的生成文件中，后者则将内容写入某个指定的文件之中。Template生成的代码内容都是通过调用TransformText获取，在Render方法中直接通过当前TransformContext获取T4文件本身代表的TextTransformation对象，并调用其Wirte方法进行内容的写入。

而RenderToFile方法由于涉及到生成新的文件，逻辑就相对复杂一些。它先通过当前TransformContext得到TextTemplatingEngineHost并计算出T4所在的目录，并最终解析出生成文件最终的路径。文件的创建和内容的写入通过调用CreateFile方法实现，如果涉及到Source Control,还需要执行Check Out操作。新创建的文件最终通过代表T4文件的ProjectItem对象添加到Project之中。

public abstract class Template: TextTransformation
{
    private bool initialized;
    public override void Initialize()
    {
        base.Initialize();
        initialized = true;
    }
    internal void EnsureInitialized()
    {
        if (!initialized)
        {
            this.Initialize();
        }
    }
    public virtual void Render()
    {
        TransformContext.EnsureContextInitialized();
        string contents = this.TransformText();
        TransformContext.Current.Transformation.Write(contents);
    }
    public virtual void RenderToFile(string fileName)
    {
            TransformContext.EnsureContextInitialized();
            string directory = Path.GetDirectoryName(TransformContext.Current.Host.TemplateFile);
            fileName = Path.Combine(directory, fileName);
            string contents = this.TransformText();
            this.CreateFile(fileName, contents);
            if (TransformContext.Current.TemplateProjectItem.ProjectItems.Cast<ProjectItem>().Any(item => item.get_FileNames(0) != fileName))
            {
                TransformContext.Current.TemplateProjectItem.ProjectItems.AddFromFile(fileName);
            }
    }
    protected void CreateFile(string fileName, string contents)
    {
        if (File.Exists(fileName) && File.ReadAllText(fileName) == contents)
        {
            return;
        }
        SourceControl sourceControl = TransformContext.Current.Dte.SourceControl;
        if (null != sourceControl && sourceControl.IsItemUnderSCC(fileName) && !sourceControl.IsItemCheckedOut(fileName))
        {
            sourceControl.CheckOutItem(fileName);
        }
        File.WriteAllText(fileName, contents);
    }
}

 

四、Generator

T4文件中最终是通过执行Generator对象来生成代码的，如下是这个抽象类型的定义。它定义了两个虚方法，其中CreateTemplates方法一组基于独立文件的Template对象，返回字典的Key代表生成文件名称；CreateTemplate返回直接生成在当前T4文件对应生成文件的Template对象。代码生成通过调用Run方法来完成，而最终的逻辑定义在虚方法RunCore中。

在RunCore方法中，先便利通过CreateTemplates方法返回的Template对象并调用其RenderToFile进行独立文件的代码生成，然后调用CreateTemplate方法返回的Template对象的Render方法将代码生成于默认的代码文件中。最终执行RemoveUnusedFiles用于生成无用的文件。比如T4文件原来生成Foo.cs文件，现在修改T4文件内容使之生成Bar.cs文件，之前的文件应该在T4文件执行之后被删除。

public abstract class Generator
{
    protected virtual IDictionary<string, Template> CreateTemplates()
    {
        return new Dictionary<string, Template>();
    }
    protected virtual Template CreateTemplate()
    {
        return null;
    }
    public void Run()
    {
        this.RunCore();
        this.RemoveUnusedFiles();
    }
    protected virtual void RunCore()
    {
        List<string> files = new List<string>();
        string directory = Path.GetDirectoryName(TransformContext.Current.Host.TemplateFile);
        foreach (var item in this.CreateTemplates())
        {
            files.Add(Path.Combine(directory, item.Key));
            item.Value.EnsureInitialized();
            item.Value.RenderToFile(item.Key);
        }

        Template template = this.CreateTemplate();
        if (null != template)
        {
            template.EnsureInitialized();
            template.Render();
        }
    }
    protected virtual void RemoveUnusedFiles()
    {
        List<string> files = new List<string>();
        string directory = Path.GetDirectoryName(TransformContext.Current.Host.TemplateFile);
        foreach (var item in this.CreateTemplates())
        {
            files.Add(Path.Combine(directory, item.Key));
            item.Value.EnsureInitialized();
            item.Value.RenderToFile(item.Key);
        }

        if (null != this.CreateTemplate())
        {
            string defaultCodeFileName = Directory.GetFiles(directory)
                .Except(new string[] { TransformContext.Current.Host.TemplateFile })
                .FirstOrDefault(path => Path.GetFileNameWithoutExtension(path)
                    == Path.GetFileNameWithoutExtension(TransformContext.Current.Host.TemplateFile));
            if (!string.IsNullOrEmpty(defaultCodeFileName))
            {
                files.Add(defaultCodeFileName);
            }
        }

        var projectItems = TransformContext.Current.TemplateProjectItem.ProjectItems.Cast<ProjectItem>().ToArray();
        foreach (ProjectItem projectItem in projectItems)
        {
            string fileName = projectItem.get_FileNames(0);
            if (!files.Contains(fileName))
            {
                projectItem.Delete();
            }
        }
    }
}

五、扩展方法RunCodeGenerator

在我们的实例演示中，T4文件中执行Generator是通过调用方法RunCodeGenerator来实现的，这是一个针对TextTransformation的扩展方法。如下面的代码片段所示，方法先根据指定的TextTransformation 和TextTemplatingEngineHost 创建当前TransformContext，对Generator 的Run方法的调用是在当前TransformContext中完成的。

public static class TextTransformationExtensions
{
    public static void RunCodeGenerator(this TextTransformation transformation, ITextTemplatingEngineHost host, Generator generator)
    {
        using (TransformContextScope contextScope = new TransformContextScope(transformation, host))
        {
            generator.Run();
        }
    }
}

 

相关阅读：
与VS集成的若干种代码生成解决方案[博文汇总(共8篇)]
通过CodeDOM定义生成代码的结构
通过Visual Studio的Custom Tool定义代码生成器
不同于CodeDOM的代码生成机制——T4
通过T4模板实现单文件的代码生成
通过T4模板实现多文件的代码生成
解决T4模板的程序集引用的五种方案
编写T4模板进行代码生成无法避免的两个话题："Assembly Locking"&"Debug"
通过自定义BuildProvider为ASP.NET提供代码生成