Design-Time Code Generation by using T4 Text Templates

 

Pour obtenir la dernière documentation sur Visual Studio 2017, consultez Documentation Visual Studio 2017.

Les modèles de texte T4 au moment de la conception vous permettent de générer du code de programme et d'autres fichiers dans votre projet Visual Studio. En général, vous écrivez les modèles pour qu'ils varient le code qu'ils génèrent en fonction de données d'un modèle. Un modèle est un fichier ou une base de données qui contient des informations clés concernant les spécifications de votre application.

Par exemple, vous pourriez avoir un modèle qui définit un flux de travail sous la forme d'un tableau ou d'un diagramme. À partir du modèle, vous pouvez générer le logiciel qui exécute le flux de travail. Quand les exigences de vos utilisateurs changent, il est facile de discuter du nouveau flux de travail avec eux. La regénération du code à partir du flux de travail est plus fiable que la mise à jour manuelle du code.

System_CAPS_ICON_note.jpg Remarque

Un modèle est une source de données qui décrit un aspect spécifique d'une application. Il peut assumer n'importe quelle forme, dans n'importe quel genre de fichier ou de base de données. Il n'est pas obligatoire qu'il soit dans un format spécifique, tel qu'un modèle UML ou un modèle de langage spécifique à un domaine. Les modèles les plus courants assument la forme de tableaux ou de fichiers XML.

Vous connaissez sans doute déjà le concept de génération de code. Quand vous définissez des ressources dans un fichier .resx dans votre solution Visual Studio, un ensemble de classes et de méthodes est généré automatiquement. Le fichier de ressources simplifie et rend plus fiable la modification des ressources, par rapport à la modification manuelle des classes et des méthodes. Avec les modèles de texte, vous pouvez générer du code de la même façon à partir d'une source que vous avez conçue vous-même.

Un modèle de texte contient une combinaison du texte que vous souhaitez générer et du code de programme qui génère des parties variables du texte. Le code de programme vous permet de répéter ou d'omettre de manière conditionnelle des parties du texte généré. Le texte généré peut lui-même être du code de programme qui constituera une partie de votre application.

Pour créer un modèle T4 au moment de la conception dans Visual Studio

  1. Créez un projet Visual Studio ou ouvrez-en un existant.

    Par exemple, dans le menu Fichier, choisissez Nouveau, Projet.

  2. Ajoutez un fichier de modèle de texte à votre projet et donnez-lui un nom avec l'extension .tt.

    Pour cela, dans l'Explorateur de solutions, dans le menu contextuel de votre projet, choisissez Ajouter, Nouvel élément. Dans la boîte de dialogue Ajouter un nouvel élément, sélectionnez Modèle de texte dans le volet central.

    Notez vous que la propriété Outil personnalisé du fichier est TextTemplatingFileGenerator.

  3. Ouvrez le fichier. Il contient déjà les directives suivantes :

    <#@ template hostspecific="false" language="C#" #>  
    <#@ output extension=".txt" #>  
    
    

    Si vous avez ajouté le modèle à un projet Visual Basic, l'attribut de langage est « VB ».

  4. Ajoutez du texte à la fin du fichier. Par exemple :

    Hello, world!  
    
    
  5. Enregistrez le fichier.

    Une boîte de message Avertissement de sécurité peut s'afficher pour vous inviter à confirmer que vous souhaitez exécuter le modèle. Cliquez sur OK.

  6. Dans l'Explorateur de solutions, développez le nœud de fichiers de modèle. Vous y trouverez un fichier ayant l'extension .txt. Ce fichier contient le texte généré à partir du modèle.

    System_CAPS_ICON_note.jpg Remarque

    Si votre projet est un projet Visual Basic, vous devez cliquer sur Afficher tous les fichiers pour afficher le fichier de sortie.

Regénération du code

Un modèle est exécuté, générant le fichier auxiliaire, dans les cas suivants :

  • Modifiez le modèle, puis faites basculer le focus vers une autre fenêtre Visual Studio.

  • Enregistrez le modèle.

  • Cliquez sur Transformer tous les modèles dans le menu Build. Cette action transforme tous les modèles dans la solution Visual Studio.

  • Dans l'Explorateur de solutions, dans le menu contextuel d'un fichier, choisissez Exécuter un outil personnalisé. Appliquez cette méthode pour transformer un sous-ensemble de modèles sélectionné.

Vous pouvez aussi configurer un projet Visual Studio pour que les modèles soient exécutés quand les fichiers de données qu'ils lisent ont changé. Pour plus d'informations, consultez Regénération automatique du code.

Les modèles de texte vous permettent d'utiliser du code de programme pour varier le contenu du fichier généré.

Pour générer du texte à l'aide de code de programme

  1. Modifiez le contenu du fichier .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 #>  
    <# } #>  
    
    
  2. Enregistrez le fichier .tt et inspectez de nouveau le fichier .txt généré. Il mentionne les carrés des chiffres de 0 à 10.

Notez que les instructions sont placées entre des signes <#...#> et les expressions uniques entre des signes <#=...#>. Pour plus d'informations, consultez Writing a T4 Text Template.

Si vous écrivez le code généré en Visual Basic, la directive template doit contenir language="VB". "C#" est la valeur par défaut.

Pour déboguer un modèle de texte

  • Insérez debug="true" dans la directive template. Exemple :

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

  • Définissez des points d'arrêt dans le modèle comme vous le feriez pour du code ordinaire.

  • Choisissez Déboguer le modèle T4 dans le menu contextuel du fichier de modèle de texte dans l'Explorateur de solutions.

Le modèle s'exécute et s'arrête aux points d'arrêt. Vous pouvez examiner les variables et parcourir le code de manière normale.

System_CAPS_ICON_tip.jpg Astuce

Avec debug="true", le mappage du code généré au modèle de texte est plus précis car davantage de directives de numérotation de lignes sont insérées dans le code généré. Si vous ne le spécifiez pas, les points d'arrêt risquent d'arrêter l'exécution dans l'état incorrect.

Mais vous pouvez laisser la clause dans la directive de modèle même quand vous ne déboguez pas. Cela ne provoque qu'une très faible dégradation des performances.

Vous pouvez générer des fichiers programmes qui varient en fonction d'un modèle. Un modèle est une entrée telle qu'une base de données, un fichier de configuration, un modèle UML, un modèle DSL ou autre source. En général, plusieurs fichiers programmes sont générés à partir du même modèle. Pour cela, vous devez créer un fichier de modèle pour chaque fichier programme généré et faire en sorte que tous les modèles lisent le même modèle.

Pour générer du code de programme ou des ressources

  1. Modifiez la directive de sortie pour générer un fichier du type approprié, tel que .cs, .vb, .resx ou .xml.

  2. Insérez du code qui générera le code de solution nécessaire. Par exemple, si vous souhaitez générer trois déclarations de champ de nombres entiers dans une classe :

    
                      <#@ 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;  
    <# } #>  
    }  
    
    
  3. Enregistrez le fichier est inspectez le fichier généré, qui contient maintenant le code suivant :

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

Génération de code et texte généré

Quand vous générez du code de programme, vous devez éviter toute confusion entre le code de génération qui s'exécute dans votre modèle et le code généré résultant qui devient partie intégrante de votre solution. Il n'est pas obligatoire que les deux langages soient identiques.

L'exemple précédent comporte deux versions. Dans une version, le code de génération est en C#. Dans l'autre version, le code de génération est en Visual Basic. Mais le texte généré par ces deux versions est identique et il s'agit d'une classe C#.

De la même manière, vous pourriez utiliser un modèle Visual C# pour générer du code dans n'importe quel langage. Il n'est pas obligatoire que le texte généré soit dans un langage spécifique et il n'est pas obligatoire que ce soit du code de programme.

Structuration des modèles de texte

Une meilleure pratique consiste à séparer le code de modèle en deux parties :

  • Une partie configuration ou collecte de données, qui définit des valeurs dans des variables mais ne contient pas de blocs de texte. Dans l'exemple précédent, cette partie est l'initialisation de properties.

    On appelle parfois cette section la section « modèle », car elle construit un modèle en magasin et lit généralement un fichier de modèle.

  • La partie génération de texte (foreach(...){...} dans l'exemple), qui utilise les valeurs des variables.

Cette séparation n'est pas obligatoire, mais elle simplifie la lecture du modèle en réduisant la complexité de la partie qui comprend du texte.

Pour accéder à une base de données ou à un fichier de modèle, votre code de modèle peut utiliser des assemblys tels que System.XML. Pour pouvoir accéder à ces assemblys, vous devez insérer des directives telles que celles-ci :

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

La directive assembly rend l'assembly spécifié accessible à votre code de modèle, de la même manière que la section Références d'un projet Visual Studio. Vous n'êtes pas obligé d'inclure une référence à System.dll, car il est référencé automatiquement. La directive import vous permet d'utiliser des types sans utiliser leurs noms qualifiés complets, de la même manière que la directive using dans un fichier programme ordinaire.

Par exemple, après avoir importé System.IO, vous pourriez écrire :

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

Ouverture d'un fichier avec un nom de chemin d'accès relatif

Pour charger un fichier à partir d'un emplacement relatif au modèle de texte, vous pouvez utiliser this.Host.ResolvePath(). Pour utiliser this.Host, vous devez définir hostspecific="true" dans template :

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

Ensuite, vous pouvez par exemple écrire :

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

Vous pouvez aussi utiliser this.Host.TemplateFile, qui identifie le nom du fichier de modèle actuel.

Le type de this.Host (en VB, Me.Host) est Microsoft.VisualStudio.TextTemplating.ITextTemplatingEngineHost.

Obtention de données à partir de Visual Studio

Pour utiliser des services fournis dans Visual Studio, définissez l'attribut hostSpecific et chargez l'assembly EnvDTE. Vous pouvez ensuite utiliser IServiceProvider.GetCOMService() pour accéder à DTE et d'autres services. Par exemple :

<#@ template hostspecific="true" language="C#" #>  
<#@ output extension=".txt" #>  
<#@ assembly name="EnvDTE" #>  
<#  
  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 #>  
  

System_CAPS_ICON_tip.jpg Astuce

Un modèle de texte s'exécute dans son propre domaine d'application et les services sont accessibles par le marshaling. Dans cette circonstance, GetCOMService() est plus fiable que GetService().

En général, plusieurs fichiers d'une solution Visual Studio sont générés avec un seul modèle d'entrée. Chaque fichier est généré à partir de son propre modèle, mais les modèles font tous référence au même modèle.

Si le modèle source change, vous devez réexécuter tous les modèles de la solution. Pour effectuer cette opération manuellement, choisissez Transformer tous les modèles dans le menu Build.

Si vous avez installé le Kit de développement logiciel (SDK) de visualisation et de modélisation de Visual Studio, vous pouvez faire en sorte que tous les modèles soient transformés automatiquement chaque fois que vous effectuez une génération. Pour cela, modifiez votre fichier de projet (.csproj or .vbproj) dans un éditeur de texte et ajoutez les lignes suivantes vers la fin du fichier, après toute autre instruction <import> :

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

Pour plus d'informations, consultez Code Generation in a Build Process.

Pour placer des messages d'erreur et d'avertissement dans la fenêtre d'erreur de Visual Studio, vous pouvez appliquer les méthodes suivantes :

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

L'un des avantages des modèles, c'est que leur apparence se rapproche des fichiers qu'ils génèrent, avec en plus du code de programme inséré. Cela nous suggère une méthode utile pour créer un modèle. Tout d'abord, créez un fichier ordinaire en guise de prototype, tel qu'un fichier Visual C#, puis introduisez graduellement du code de génération qui fait varier le fichier résultant.

Pour convertir un fichier existant en modèle au moment de la conception

  1. Ajoutez à votre projet Visual Studio un fichier du type que vous souhaitez générer, tel qu'un fichier .cs, .vb ou .resx.

  2. Testez le nouveau fichier pour vous assurer qu'il fonctionne.

  3. Dans l'Explorateur de solutions, affectez .tt comme extension de nom de fichier.

  4. Vérifiez les propriétés suivantes du fichier .tt :

    Custom Tool =TextTemplatingFileGenerator
    Build Action =None
  5. Insérez les lignes suivantes au début du fichier :

    <#@ template debug="false" hostspecific="false" language="C#" #>  
    <#@ output extension=".cs" #>  
    
    

    Si vous souhaitez écrire le code génération de votre modèle en Visual Basic, affectez la valeur language au lieu de "VB" à l'attribut "C#".

    Définissez l'attribut extension sur l'extension de nom de fichier correspondant au type de fichier que vous souhaitez générer, par exemple .cs, .resx ou .xml.

  6. Enregistrez le fichier.

    Un fichier auxiliaire est créé, avec l'extension spécifiée. Ses propriétés sont correctes pour le type de fichier. Par exemple, la propriété Action de génération d'un fichier .cs serait Compiler.

    Vérifiez que le contenu du fichier généré est identique à celui du fichier d'origine.

  7. Identifiez une partie du fichier que vous souhaitez faire varier. Par exemple, une partie qui apparaît uniquement dans certaines conditions, qui est répétée ou dont les valeurs spécifiques varient. Insérez le code de génération. Enregistrez le fichier et vérifiez que le fichier auxiliaire est généré correctement. Répétez cette étape.

Consultez Guidelines for Writing T4 Text Templates.

Étape suivanteRubrique
Écrire et déboguer un modèle de texte plus avancé, avec du code qui utilise des fonctions auxiliaires, des fichiers inclus et des données externes.Writing a T4 Text Template
Générer des documents à partir de modèles au moment de l'exécution.Run-Time Text Generation with T4 Text Templates
Exécuter la génération de texte en dehors de Visual Studio.Generating Files with the TextTransform Utility
Transformer vos données sous la forme d’un langage spécifique à un domaine.Génération de code à partir d'un langage spécifique à un domaine
Écrire des processeurs de directive pour transformer vos propres sources de données.Customizing T4 Text Transformation

Guidelines for Writing T4 Text Templates

Afficher: