テキストテンプレート変換ツールキット（T4）、パート2：テンプレートジェネレーター

こんにちは、Habr！

この記事では、T4-テキストテンプレート変換ツールキットを使用したVisual Studioでの自動コード生成のトピックを継続します。 このブログで少し前に公開されたパート1は、T4構文とその使用の基本原則を説明しています。 同時に、尊敬されているOleg Sychのブログを詳しく調べて、彼の業績の一部をhabraの視聴者にさらに適合させることにしました。 特に、今日は次のトピックについて説明します。

• 再利用可能なパラメーター化可能なテンプレートを作成する
• テンプレートジェネレーターの作成
• ジェネレーターのデバッグ、テスト、拡張（リンク）

私は特別な例を発明しませんでした。 Olegによって記述されたストアドプロシージャの作成を伴うクエリの開発の履歴は、ジェネレータを必要とする可能性のある問題を説明するのに理想的です。 さらに、これは特徴的であり、大げさな問題ではありません。 また、この記事は「言葉を少なくしてコードを増やす」という原則を順守しています。
以下では、Visual Studio 2005/2008/2010、およびT4 Toolboxがインストールされていることを前提としています。

パラメータ化可能なテンプレート

初期段階

データベースがあります。 このデータベースにはテーブルがあります。 そして、表では、Koshchei the Immortalの最高の伝統に、削除したい行があります。 そして、そのように削除するだけでなく、新しく作成したストアドプロシージャを使用して削除します。 簡単にするために、パラメータをプロシージャに渡してください。すべてテーブルの単一のフィールドに渡して、削除する行を識別します。 そのようなプロシージャを手動で作成する要求を入力することは、感謝のない仕事なので、T4を使用して、次のようなコードを作成します。

<#@ template language= “ C#v3.5 ” #>
<#@ output extension= “ SQL ” #>
<#@ assembly name= “ Microsoft.SqlServer.ConnectionInfo ” #>
<#@ assembly name= “ Microsoft.SqlServer.Smo ” #>
<#@ import namespace= “ Microsoft.SqlServer.Management.Smo ” #><#
Server server = new Server();
Database database = new Database(server, “Northwind”);
Table table = new Table(database, “Products”);
table.Refresh();
#>
create procedure <#= table.Name #> _Delete
<#
PushIndent(”\t”);
foreach (Column column in table.Columns)
if (column.InPrimaryKey)
WriteLine(”@” + column.Name + ” ” + column.DataType.Name);
PopIndent();
#>
as
delete from <#= table.Name #>
     where
<#
PushIndent(”\t \ t”);
foreach (Column column in table.Columns)
if (column.InPrimaryKey)
WriteLine(column.Name + ” = @” + column.Name);
PopIndent();
#>     

ここでは、 SQL Server管理オブジェクト （SMO）を使用して、ローカルSQLサーバーのデータベースからテーブルフィールドに関する情報を取得します。 ファイルを出力に保存した後、検索クエリを取得します。 たとえば、次のようになります。

create procedure Products_Delete
@ProductID int
as
delete from Products
where ProductID = @ProductID

パラメータ化

このコードを見た人の頭に最初に出てくる質問は、なぜデータベース名とテーブルがコードにハードコードされているのですか？ 新しいリクエストを作成するために、プログラマーはテンプレートをクロールし、いくつかの場所で手動で変更する必要がありますか？
本当に必要ありません。 別の生成方法を使用すれば十分です。 T4ツールボックスのファイルの代わりにテンプレートオプションを使用して、新しいファイルをプロジェクトに追加します。たとえば、DeleteProcedureTemplate.ttなどの名前を付けます。 ご覧のとおり、環境はパラメーター化されたテンプレートのブランク、つまりファイルを自動的に作成し、一般化された形式で使用するために他のテンプレートに含めます。

<#+
// <copyright file=”DeleteProcedureTemplate.tt” company=”Your Company”>
// Copyright © Your Company. All Rights Reserved.
// </copyright>

public class DeleteProcedureTemplate : Template
{
protected override void RenderCore()
{

}
}
#>

Microsoft.VisualStudio.TextTemplating名前空間でTemplateクラスを見つけようとしないでください。 これはT4Toolboxで定義された抽象クラスであり、T4Toolbox.ttファイルをパラメーター化されたテンプレート自体に直接接続することは意味がありません。 したがって、DeleteProcedureTemplate.ttを保存するたびに、Studioはそれを処理し、出力ファイルを生成し、クラッシュしてこのエラーを通知しようとします。 この不快な動作は、編集可能なファイルの[プロパティ]ウィンドウを見て、カスタムツールプロパティを空の行に設定することで簡単に削除できます。 現在、暗黙的な生成の試行は行われません。
TemplateクラスのRenderCore（）メソッドは、パラメーター化されたテンプレートの主要な操作ポイントです。 ジェネレータ内のテンプレートが最終的に責任を負うのは、テキストの一部が生成されることです。 したがって、それ以上苦労することなく、既製のコードをそこに転送するだけです。

<#@ assembly name= “ Microsoft.SqlServer.ConnectionInfo ” #>
<#@ assembly name= “ Microsoft.SqlServer.Smo ” #>
<#@ import namespace= “ Microsoft.SqlServer.Management.Smo ” #>
<#+
public class DeleteProcedureTemplate : Template
{
public string DatabaseName;
public string TableName;

protected override void RenderCore()
{
Server server = new Server();
Database database = new Database(server, DatabaseName);
Table table = new Table(database, TableName);
table.Refresh();
#>
create procedure <#= table.Name #> _Delete
<#+
PushIndent(”\t”);
foreach (Column column in table.Columns)
{
if (column.InPrimaryKey)
WriteLine(”@” + column.Name + ” ” + column.DataType.Name);
}
PopIndent();
#>
as
delete from <#= table.Name #>
     where
<#+
PushIndent(”\t \ t”);
foreach (Column column in table.Columns)
{
if (column.InPrimaryKey)
WriteLine(column.Name + ” = @” + column.Name);
}
PopIndent();
}
}
#>

テンプレートに加えられた主な変更は、開いているフィールドDatabaseNameとTableNameの追加です。これらは実際、パラメーター化の機能を実行します。 これで、データファイルとロジックファイルが分離されました。 残っているのは、includeディレクティブを使用して、異なるデータベースとテーブルで同じテンプレートを交互に開始することです。次に例を示します。

<#@ template language =” C#v3.5 ” hostspecific =” True ” #>
<#@ output extension =” sql ” #>
<#@ include file =” T4Toolbox.tt ” #>
<#@ include file =” DeleteProcedureTemplate.tt ” #>
<#
DeleteProcedureTemplate template = new DeleteProcedureTemplate();
template.DatabaseName = “Northwind” ;
template.TableName = “Products” ;
template.Render();
#>

必要に応じて、同じ方法を使用して、パラメーターに応じて、DELETEだけでなくSELECT、INSERT、およびUPDATEに基づくストアドプロシージャを作成するユニバーサルテンプレートを作成できます。 誰もが自分でテンプレートコードを作成できるようになりました。

脇へのわずかな後退。 一見したところ、説明されているすべての資料は初歩的なものに見えます。 はい、実際、彼はT4全体と同じように存在しています。 質問は異なります。これらの機能は標準パッケージに含まれています。この単純な記事のコンパイルでは、読者（および経験の異なるHabrの読者）を自分の自転車が積み重なる危険から保護したいと思います。 以下に説明するテンプレートジェネレータは、このような別の落とし穴です。

テンプレートジェネレーター

パラメータ化されたテンプレートには、まだ説明されていない欠陥が1つあります。 はい、個別のファイルに特定のデータベース名とテーブル名を持つテンプレートを起動するロジックを取りましたが、いくつかの可能なデータベースとテーブルで作業する場合、そのようなソリューションはソープソープの代わりになります。 プログラマは、特定のテーブルごとに個別のテンプレートファイルを作成することを余儀なくされています。 これらのファイルのサイズは目立って小さくなりますが、コピーと貼り付けの問題をキャンセルした人はいません。 理想的には、この特定のデータベースの各テーブルに対して個別のクエリを一度に作成したいと思います。 可能ですか？ はい

プロジェクトに、T4Toolbox-Generatorの一部として開発された3番目の便利なタイプのテンプレートを追加します。 ジェネレーターは、パラメーター化されたテンプレートを使用して、さまざまなパラメーター値（データベース名とテーブル）をそれに代入し、処理結果をさまざまなファイルに送信します。 後者の目的のために、Templateクラスは素晴らしいRenderToFileメソッドを提供します。

したがって、ジェネレーターファイルの名前はCrudProcedureGenerator.ttであり、そのデフォルトのストックは次のようになります。

<#+
// <copyright file=”CrudProcedureGenerator.tt” company=”Your Company”>
// Copyright © Your Company. All Rights Reserved.
// </copyright>

public class CrudProcedureGenerator : Generator
{
protected override void RunCore()
{

}
}
#>

ジェネレーター自体はT4テキストの処理を行わず、すでに作成されている他の基本テンプレートのみを順番に起動します。 したがって、RenderおよびRenderCoreの代わりに対応するメインメソッドは、それぞれRunおよびRunCoreと呼ばれます。 それらを自分用に調整しましょう：

<#@ assembly name =” Microsoft.SqlServer.ConnectionInfo ” #>
<#@ assembly name =” Microsoft.SqlServer.Smo ” #>
<#@ import namespace =” Microsoft.SqlServer.Management.Smo ” #>
<#@ include file =” DeleteProcedureTemplate.tt ” #>
<#+
public class CrudProcedureGenerator : Generator
{
public string DatabaseName;
public DeleteProcedureTemplate DeleteTemplate = new DeleteProcedureTemplate();

protected override void RunCore()
{
Server server = new Server();
Database database = new Database(server, this .DatabaseName);
database.Refresh();
foreach (Table table in database.Tables)
{
this .DeleteTemplate.DatabaseName = this .DatabaseName;
this .DeleteTemplate.TableName = table.Name;
this .DeleteTemplate.RenderToFile(table.Name + “_Delete.sql” );
}
}
}
#>

ここでは、特定の1つのデータベース内のすべてのテーブルが並べ替えられ、DeleteProcedureTemplateクラスのインスタンスごとに、要求と共に個別の一意の出力ファイルが作成されます。 完全に幸福にするには、データベースを設定して完全な処理サイクルを開始するだけでは十分ではありません。

<#@ template language =” C#v3.5 ” hostspecific =” True ” debug =” True ” #>
<#@ output extension =” txt ” #>
<#@ include file =” T4Toolbox.tt ” #>
<#@ include file =” CrudProcedureGenerator.tt ” #>
<#
CrudProcedureGenerator generator = new CrudProcedureGenerator();
generator.DatabaseName = “Northwind” ;
generator.Run();
#>

画面上の結果：

追記。 ジェネレーターを使用する機能

通常のロジックに従って、ジェネレーターに関する記事は、高度なニーズに合わせてそれらをデバッグ、テスト、および簡単に変更する方法についてのメモとともに完了する必要があります。 残念ながら、この1つのhabrastatyaはそのような量の余分なプログラムコードに耐えられませんが、3番目のパートに入れる気はありません。素材が貧弱でチームから離婚することになります。 したがって、オレグは、オレグサイチのブログからのソースコードと同様に、読者が問題なくジェネレーターを生活の中で使用できるようになることに基づいてアドバイスに限定します。

1. ジェネレーターをテストするために、T4 Toolboxには「Unit Test」という名前の独自の優れたブランクがあります。
2. 生成の中心（テンプレートによって生成されたコード）を変更する必要がある場合、そのクラス（この場合はDeleteProcedureTemplate）でファイルを直接編集する必要はありません。 別のファイルをジェネレーターにインポートすれば、テンプレートの相続人を必要な調整とともに記述できます。
3. Generatorクラスには、コード生成（RunCore）を直接処理する前に、最初にRunメソッドによって呼び出されるValidate関数があります。 ジェネレータの入力パラメータを確認するために使用できます。
4. エラーを報告するには、TextTransformationクラスで説明したものと同様のErrorおよびWarningメソッドを使用できます。

関連リンク：
コードジェネレーターでのエラー処理
単体テストコードジェネレーター
コードジェネレーターを拡張可能にする