T4 文本模板引擎使用教程

1. 项目介绍

T4（Text Template Transformation Toolkit）是一个由C#驱动的文本模板引擎，最初作为Visual Studio的一部分开发，后来由Mono项目重新实现并开源。T4允许开发者使用C#代码生成各种文本文件，包括但不限于代码文件、配置文件、文档等。Mono的T4实现不仅支持C# 10和.NET 6，还提供了许多原生Visual Studio T4引擎所不具备的增强功能。

2. 项目快速启动

安装dotnet-t4工具

首先，你需要安装dotnet-t4工具，这是一个用于处理T4模板的命令行工具。你可以通过以下命令全局安装该工具：

dotnet tool install -g dotnet-t4

创建并运行一个简单的T4模板

接下来，你可以创建一个简单的T4模板文件，例如HelloWorld.tt，内容如下：

<#@ template language="C#" #>
<#@ parameter name="Name" type="System.String" #>
Hello <#= Name #>!

然后，你可以使用dotnet-t4工具来处理这个模板文件，并传递参数：

t4 -o HelloWorld.txt -p:Name=World HelloWorld.tt

运行上述命令后，你将得到一个名为HelloWorld.txt的文件，内容为：

Hello World!

3. 应用案例和最佳实践

应用案例

T4模板广泛应用于代码生成、配置文件生成、文档生成等场景。例如，在生成ORM（对象关系映射）代码时，可以使用T4模板自动生成数据库表对应的C#类。

最佳实践

1. 模块化设计：将复杂的模板分解为多个小的、可重用的部分，便于维护和扩展。
2. 参数化：使用模板参数来提高模板的灵活性和复用性。
3. 错误处理：在模板中添加错误处理逻辑，确保生成的文件在任何情况下都是有效的。

4. 典型生态项目

Mono.TextTemplating

Mono.TextTemplating是T4模板引擎的核心库，可以嵌入到你的应用程序中，提供对T4模板的完整支持。你可以通过NuGet包管理器安装它：

dotnet add package Mono.TextTemplating

dotnet-t4

dotnet-t4是一个命令行工具，用于在命令行环境下处理T4模板。它支持模板预处理、运行时模板处理等功能，非常适合在CI/CD管道中使用。

通过以上步骤，你应该能够快速上手并开始使用T4模板引擎来生成各种文本文件。