C# T4自动生成代码详解及示例

C#通过T4自动生成代码是一种强大的编程技术，利用Visual Studio中的TextTemplateTransformationToolkit（T4）。T4允许开发人员编写模板文件，这些文件结合了文本和控制逻辑，能够根据特定的输入数据动态生成代码，极大地提高了代码复用性和可维护性。 T4模板有两类：运行时模板和设计时模板。运行时模板在应用程序运行时执行，用于生成文本字符串，例如生成API文档、配置文件等。这类模板通常以已预处理的文本模板文件形式存在，可以通过VS项目添加，并设置“自定义工具”属性为“TextTemplatingFilePreprocessor”。 设计时模板则是在Visual Studio中执行，主要用于定义应用程序的部分源代码和资源。它们可以读取单个输入文件或数据库中的数据，并生成多个目标文件，如.cs或.vb类文件。这类模板在VS项目中添加，设置“自定义工具”属性为“TextTemplatingFileGenerator”。 核心部分的代码片段展示了如何创建一个运行时模板的Host类，该类继承自`ITextTemplating`接口： ```csharp using Microsoft.VisualStudio.TextTemplating; using System; using System.CodeDom.Compiler; using System.Collections.Generic; using System.IO; using System.Linq; using System.Text; using System.Threading.Tasks; namespace CodeGenerate.EngineHost { public class TextTemplatingEngineHost : ITextTemplating { // 实现ITextTemplating接口的方法和属性，这里省略具体实现细节 public string TransformText(string text, TextTransformRequest request) { // 在此处编写处理模板和输入数据的逻辑，使用CodeDOM或其他库解析模板，替换占位符 var template = new TemplateModel(request); using (var writer = new StringWriter()) { var engine = new CSharpTextTemplatingEngine(); engine.ExecuteTemplate(template, writer, request); return writer.ToString(); } } // 其他可能的方法，如：GetDefaultExtension()、GetDefaultNamespace()等 } } ``` 在这个`TextTemplatingEngineHost`中，`TransformText`方法是关键，它接收模板文本`text`和请求对象`request`，然后实例化`TemplateModel`，创建`CSharpTextTemplatingEngine`，执行模板并生成输出。通过这种方式，开发者可以灵活地定制模板，根据输入数据生成不同结构或功能的C#代码。 C#通过T4自动生成代码的优势在于提高了代码质量和一致性，减少了手动编码的工作量，特别是在需要频繁生成相似代码结构的场景中。理解并熟练运用T4模板，能够显著提升开发效率和代码质量。