使用 T4 文字範本在設計階段產生程式碼

發行項
04/17/2024

設計階段 T4 文字範本可讓您在 Visual Studio 專案中產生程式碼和其他檔案。通常，您會撰寫具有不同程式碼的範本，而程式碼是範本根據「模型」中的資料所產生。模型是含有您應用程式需求重要資訊的檔案或資料庫。

例如，您的模型可以將工作流程定義為表格或圖表。您可以透過模型產生執行工作流程的軟體。當您使用者的需求變更時，很容易就可以與使用者討論新的工作流程。透過工作流程重新產生程式碼，會比手動更新程式碼更為可靠。

注意

「模型」是一種描述應用程式特定部分的資料來源。它可以是任何形式、任何類型的檔案或資料庫。它不需要是任何特定形式 (如 UML 模型或「特定領域語言」模型)。一般模型的格式是表格或 XML 檔案。

您可能已熟悉如何產生程式碼。當您在 Visual Studio 方案的 .resx 檔案中定義資源時，會自動產生一組類別和方法。編輯資源檔案中的資源，會比編輯類別和方法更為簡單也較可靠。運用文字範本，您可以使用相同的方式透過您專屬設計的原始檔產生程式碼。

文字範本混合了您想要產生的文字以及產生文字變動部分的程式碼。程式碼可讓您重複或有條件地省略所產生文字的某些部分。所產生的文字本身可以是形成您應用程式一部分的程式碼。

建立設計階段 T4 文字範本

建立新的 Visual Studio 專案，或開啟現有專案。
將文字範本檔新增至專案，並提供副檔名為 .tt 的名稱給該檔案。

若要這樣做，請在 [方案總管] 中，於專案的捷徑功能表上依序選擇 [新增]>[新項目]。在 [新增項目] 對話框中，從中間窗格選取 [文字範本]。

請注意，檔案的 [自訂工具] 屬性為 [TextTemplatingFileGenerator]。
開啟檔案。它已包含下列指示詞：
```
<#@ template hostspecific="false" language="C#" #>
<#@ output extension=".txt" #>
```
如果您已將該範本新增至 Visual Basic 專案，則語言屬性會是 "VB"。
在檔案結尾加入一些文字。例如：
```
Hello, world!
```
儲存檔案。

您可能會看到一個 [安全性警告] 訊息方塊，要求您確認是否要執行該範本。按一下 [確定]。
在 [方案總管] 中，展開範本檔案節點，然後就會看到副檔名為 .txt 的檔案。此檔案包含從範本產生的文字。

注意

如果您的專案是 Visual Basic 專案，則必須按一下 [顯示所有檔案] 才能看到輸出檔案。

重新產生程式碼

在下列任何情況下，將會執行範本，並產生附帶檔案：

編輯範本，然後將焦點變更至不同的 Visual Studio 視窗。
儲存範本。
在 [建置] 功能表中，按一下 [轉換所有範本]。這樣會轉換 Visual Studio 方案中的所有範本。
在 [方案總管] 中，於任何檔案的捷徑功能表上選擇 [執行自訂工具]。使用此方法可以轉換所選取的範本子集。

您也可以設定 Visual Studio 專案，以在範本所讀取的資料檔案變更時執行範本。如需詳細資訊，請參閱自動重新產生程式碼。

產生變數文字

文字範本可讓您使用程式碼，讓所產生檔案的內容不同。

變更 .tt 檔案的內容：

<#@ template hostspecific="false" language="C#" #>
<#@ output extension=".txt" #>
<#int top = 10;

for (int i = 0; i<=top; i++)
{ #>
   The square of <#= i #> is <#= i*i #>
<# } #>

<#@ template hostspecific="false" language="VB" #>
<#@ output extension=".txt" #>
<#Dim top As Integer = 10

For i As Integer = 0 To top
#>
    The square of <#= i #> is <#= i*i #>
<#
Next
#>

儲存 .tt 檔案，並重新檢查產生的 .txt 檔案。它會列出 0 到 10 之數字的平方。

請注意，陳述式會用 <#...#> 括住，單一運算式則用 <#=...#> 括住。如需詳細資訊，請參閱撰寫 T4 文字範本。

如果您使用 Visual Basic 撰寫產生的程式碼，則 template 指示詞應該包含 language="VB"。 "C#" 是預設值。

偵錯設計階段 T4 文字範本

偵錯文字範本：

將 debug="true" 插入至 template 指示詞。例如：

<#@ template debug="true" hostspecific="false" language="C#" #>
在範本中設定中斷點，方法與您對一般程式碼設定中斷點一樣。
在 [方案總管] 中，從文字範本檔的捷徑功能表中選擇 [偵錯 T4 範本]。

範本會執行並停止於中斷點。您可以檢查變數，並照常逐步執行程式碼。

提示

debug="true" 會將更多行號指示詞插入至產生的程式碼，以讓產生的程式碼更精確地對應至文字範本。如果您遺漏它，則中斷點可能會以錯誤的狀態停止執行作業。

不過，即使不進行偵錯，您也可以在範本指示詞保留這個子句。這樣只會導致效能稍微降低。

產生您方案的程式碼或資源

您可以產生不同的程式檔案 (視模型而定)。模型是一個輸入 (例如資料庫、組態檔、UML 模型、DSL 模型或其他來源)。您通常會產生數個來自相同模型的程式檔案。若要達到這樣的效果，請為每個產生的程式檔案建立範本檔，並且讓所有範本讀取相同的模型。

產生程式碼或資源

變更輸出指示詞，以產生適當類型的檔案 (如 .cs、.vb、.resx 或 .xml)。

插入將產生您所需方案程式碼的程式碼。例如，如果您想要在類別中產生三個整數欄位宣：


<#@ template debug="false" hostspecific="false" language="C#" #>
<#@ output extension=".cs" #>
<# var properties = new string [] {"P1", "P2", "P3"}; #>
// This is generated code:
class MyGeneratedClass {
<# // This code runs in the text template:
  foreach (string propertyName in properties)  { #>
  // Generated code:
  private int <#= propertyName #> = 0;
<# } #>
}

<#@ template debug="false" hostspecific="false" language="VB" #>
<#@ output extension=".cs" #>
<# Dim properties = {"P1", "P2", "P3"} #>
class MyGeneratedClass {
<#
   For Each propertyName As String In properties
#>
  private int <#= propertyName #> = 0;
<#
   Next
#>
}

儲存檔案，並檢查產生的檔案，該檔案現在會包含下列程式碼：

class MyGeneratedClass {
  private int P1 = 0;
  private int P2 = 0;
  private int P3 = 0;
}

產生程式碼和產生的文字

產生程式碼時，最重要的是避免混淆在範本執行的產生程式碼，以及最終的產生的程式碼 (成為方案的一部分)。兩種語言不需要相同。

上述範例有兩個版本。在其中一個版本中，產生程式碼的格式為 C#。在另一個版本中，產生程式碼的格式為 Visual Basic。但是兩者所產生的文字一模一樣，而且屬於 C# 類別。

透過相同的方式，您也可以使用 Visual C# 範本來產生任何語言的程式碼。產生的文字未必要使用任何特定語言，也不必是程式碼。

建構文字範本

我們傾向最好將範本程式碼分成兩個部分：

設定或資料收集部分：設定變數中的值，但不包含文字區塊。在上述範例中，這部分是 properties 的初始化。

這有時稱為「模型」區段，因為它會建構庫存模型，而且通常會讀取模型檔案。
文字產生部分 (在此範例中，是 foreach(...){...})：使用變數的值。

這不是必要的分隔，而是降低含文字部分複雜度，讓範本更容易讀取的樣式。

讀取檔案或其他來源

若要存取模型檔案或資料庫，您的範本程式碼可以使用 System.XML 這類組件。若要存取這些組件，您必須插入下列這類指示詞：

<#@ assembly name="System.Xml.dll" #>
<#@ import namespace="System.Xml" #>
<#@ import namespace="System.IO" #>

assembly 指示詞讓您的範本程式碼可以使用指定的組件，方式與 Visual Studio 專案的 [參考] 區段相同。您不需要包括自動參考之 System.dll 的參考。 import 指示詞可讓您使用未使用其完整名稱的類型，方式與一般程式檔案中的 using 指示詞相同。

例如，匯入 System.IO 之後，您可以撰寫：


<# var properties = File.ReadLines("C:\\propertyList.txt");#>
...
<# foreach (string propertyName in properties) { #>
...

<# For Each propertyName As String In
             File.ReadLines("C:\\propertyList.txt")
#>

使用相對路徑名稱來開啟檔案

若要從與文字範本相對的位置載入檔案，您可以使用 this.Host.ResolvePath()。若要使用 this.Host，您必須在 template 設定 hostspecific="true" ：

<#@ template debug="false" hostspecific="true" language="C#" #>

然後，您可以撰寫，例如：

<# string filename = this.Host.ResolvePath("filename.txt");
  string [] properties = File.ReadLines(filename);
#>
...
<#  foreach (string propertyName in properties { #>
...

<# Dim filename = Me.Host.ResolvePath("propertyList.txt")
   Dim properties = File.ReadLines(filename)
#>
...
<#   For Each propertyName As String In properties
...
#>

您也可以使用 this.Host.TemplateFile，以識別目前範本檔的名稱。

this.Host (在 VB 中，為 Me.Host) 的類型是 Microsoft.VisualStudio.TextTemplating.ITextTemplatingEngineHost。

從 Visual Studio 取得資料

若要使用 Visual Studio 中所提供的服務，請設定 hostspecific 屬性並載入 EnvDTE 組件。匯入 Microsoft.VisualStudio.TextTemplating，其中包含 GetCOMService() 擴充方法。然後，您可以使用 IServiceProvider.GetCOMService() 來存取 DTE 和其他服務。例如：

<#@ template hostspecific="true" language="C#" #>
<#@ output extension=".txt" #>
<#@ assembly name="EnvDTE" #>
<#@ import namespace="Microsoft.VisualStudio.TextTemplating" #>
<#
  IServiceProvider serviceProvider = (IServiceProvider)this.Host;
  EnvDTE.DTE dte = (EnvDTE.DTE) serviceProvider.GetCOMService(typeof(EnvDTE.DTE));
#>

Number of projects in this VS solution:  <#= dte.Solution.Projects.Count #>

提示

文字範本是在其專屬應用程式網域中執行，而服務是透過封送處理進行存取。在此情況下，GetCOMService() 比 GetService() 還要可靠。

自動重新產生程式碼

通常，會使用一個輸入模型來產生 Visual Studio 方案中的數個檔案。每個檔案都是透過其專屬範本所產生，但是範本都參考相同的模型。

如果來源模型變更，則您應該重新執行方案中的所有範本。若要手動進行這項作業，請選擇 [建置] 功能表上的 [轉換所有範本]。

如果您已安裝 Visual Studio Modeling SDK，則可以在執行組建時自動轉換所有範本。若要這麼做，請在文字編輯器編輯您的專案檔 (.csproj 或 .vbproj)，並在接近檔案結尾處，任何其他 <import> 陳述式後面加入下列各行：在 SDK 樣式專案中，它可以移至專案檔中的任何位置。

注意

當您安裝 Visual Studio 的特定功能時，系統會自動安裝文字範本轉換 SDK 和 Visual Studio Modeling SDK。

<Import Project="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v17.0\TextTemplating\Microsoft.TextTemplating.targets" />
<PropertyGroup>
   <TransformOnBuild>true</TransformOnBuild>
   <!-- Other properties can be inserted here -->
</PropertyGroup>

如需詳細資訊，請參閱在建置流程中產生程式碼。

錯誤報告

若要將錯誤和警告訊息放入 Visual Studio 錯誤視窗中，您可以使用這些方法：

Error("An error message");
Warning("A warning message");

將現有檔案轉換為範本

範本的有用功能是它們看起來很像它們所產生的檔案和一些插入的程式碼。這會建議建立範本的有用方法。請先建立一般檔案做為原型 (如 Visual C# 檔案)，然後逐漸引進讓產生的檔案不同的產生程式碼。

將現有檔案轉換為設計階段範本

針對 Visual Studio 專案，新增您要產生之類型的檔案，例如 .cs、.vb 或 .resx 檔案。
測試新的檔案，確定其運作。
在 [方案總管] 中，將副檔名變更為 .tt。
確認 .tt 檔案的下列屬性：

屬性設定

自訂工具 = TextTemplatingFileGenerator

建置動作 = None
在檔案開頭，插入下列各行：
```
<#@ template debug="false" hostspecific="false" language="C#" #>
<#@ output extension=".cs" #>
```
如果您想要使用 Visual Basic 撰寫範本的產生程式碼，請將 language 屬性設定為 "VB"，而非 "C#"。

將 extension 屬性設定為您要產生之檔案類型的副檔名 (例如 .cs、.resx 或 .xml)。
儲存檔案。

即會建立具有所指定副檔名的附帶檔案。其屬性對檔案類型而言正確。例如，.cs 檔案的 [建置動作] 屬性會是 [編譯]。

請確認產生的檔案包含與原始檔案相同的內容。
識別您要使其不同的檔案部分。例如，只在特定狀況下出現的部分、重複的部分，或特定值不同的部分。插入產生程式碼。儲存檔案，並確認已正確地產生附帶檔案。重複此步驟。

屬性	設定
自訂工具 =	TextTemplatingFileGenerator
建置動作 =	None

產生程式碼的指導方針

請參閱撰寫 T4 文字範本的指引。

使用 T4 文字範本在設計階段產生程式碼

建立設計階段 T4 文字範本

重新產生程式碼

產生變數文字

偵錯設計階段 T4 文字範本

產生您方案的程式碼或資源

產生程式碼或資源

產生程式碼和產生的文字

建構文字範本

讀取檔案或其他來源

使用相對路徑名稱來開啟檔案

從 Visual Studio 取得資料

自動重新產生程式碼

錯誤報告

將現有檔案轉換為範本

將現有檔案轉換為設計階段範本

產生程式碼的指導方針

意見反應

意見反應

其他資源

使用 T4 文字範本在設計階段產生程式碼

建立設計階段 T4 文字範本

重新產生程式碼

產生變數文字

偵錯設計階段 T4 文字範本

產生您方案的程式碼或資源

產生程式碼或資源

產生程式碼和產生的文字

建構文字範本

讀取檔案或其他來源

使用相對路徑名稱來開啟檔案

從 Visual Studio 取得資料

自動重新產生程式碼

錯誤報告

將現有檔案轉換為範本

將現有檔案轉換為設計階段範本

產生程式碼的指導方針

相關內容

意見反應

意見反應

其他資源