Шаблоны Т4 - генерация любого текста (кода) в Visual Studio

На днях возникла потребность автоматизировать одну рутинную, регулярную задачу в рабочем проекте, суть которой сводится к генерации новых классов по уже имеющимся и написании методов-оберток для имеющихся методов по одному и тому же шаблону. Первый подход, который пришел в голову - это генерация кода посредством Т4-шаблонов в Visual Studio.  Пригодность подхода оценивалась по следующему тестовому заданию:

Имеется пространство имен (без вложенных подпространств), в котором находится ряд классов (и, возможно, других типов). На основе набора публичных свойств каждого класса, необходимо сгенерировать соответствующие классы-DTO. Типы свойств могут быть как встроенными типами CLR, так и классами из этого же пространства имен.

Грубо говоря, генерируем DTO по каждому заданному классу. С помощью Reflection с последующим выводом на консоль, задача решается за чашку чая. Перенести готовый код в *.tt файл тоже нетрудно - в данном случае, достаточно заменить вызовы Console на соответствующие вызовы класса GeneratedTextTransformation (о нем чуть ниже), а также прописать в *.tt файле все используемые сборки и пространства имен.


Получаем независимый от остальной части нашего приложения шаблон, выполняющий наше задание:

<#@ template debug="True" #>
<#@ output extension="cs" #>

<#@ Assembly Name="System.Core.dll" #>
<#@ Assembly Name="$(TargetDir)T4.Model.dll" #>

<#@ import namespace="System" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Reflection" #>
<#@ import namespace="System.Collections.Generic" #>

using System;

namespace T4.Tests
{
  <# 
  var list = AssemblyHelper.GetClassTypesByNamespace("T4.Model");

  TypeHelper.PrintDtos(this, list);
  #>
}

 <#+ 
static class TypeHelper
{  
 public static void PrintDtos(
  GeneratedTextTransformation text, List list)
 {
  foreach (var type in list)
  {
   string newTypeName = GetTransformedTypeName(type);

   text.WriteLine("public class " + newTypeName);
   text.WriteLine("{");

   foreach (var property in type.GetProperties())
   {
    Type propertyType = property.PropertyType;

    string propertyTypeName = TypeInList(propertyType, list)
     ? GetTransformedTypeName(propertyType)
     : propertyType.Name;

    text.WriteLine(GetPropertyCode(propertyTypeName, property.Name));
   }

   text.WriteLine("}" + Environment.NewLine);
  }
 }

 public static string GetPropertyCode(string typeName, string propertyName)
 {
  return "public " + typeName + " " + propertyName + " { get; set; }";
 }

 public static string GetTransformedTypeName(Type type)
 {
  return type.Name + "Dto";
 }

 public static bool TypeInList(Type typeToCheck, List list)
 {
  return list.Any(type => type.FullName == typeToCheck.FullName);
 }
}

public class AssemblyHelper
{
 public static Assembly[] GetAssemblies()
 {
  return AppDomain.CurrentDomain.GetAssemblies();
 }

 public static List GetClassTypesByNamespace(string nspace)
 {
  var list = GetAssemblies()
   .SelectMany(t => t.GetTypes())
   .Where(t => t.IsClass && t.Namespace == nspace)
   .ToList();

  return list;
 }
}
 #>

При выполнении Т4-шаблона, код будет сгенерирован не напрямую, как можно было подумать. Шаблон используется Студией для неявного создания класса GeneratedTextTransformation, который и займется делом:

namespace Microsoft.VisualStudio.TextTemplating
{
 using System;
 using System.Linq;
 using System.Reflection;
 using System.Collections.Generic;

 /// 

 /// Class to produce the template output
 /// 
 public class GeneratedTextTransformation 
  : Microsoft.VisualStudio.TextTemplating.TextTransformation
 {
  /// 

  /// Create the template output
  /// 
  public override string TransformText()
  {
   try
   {
    this.Write("using System; \r\n namespace T4.Tests{ \r\n ");

    var list = AssemblyHelper.GetClassTypesByNamespace("T4.Model");

    TypeHelper.PrintDtos(this, list);
   }
   catch (System.Exception e)
   {
    e.Data["TextTemplatingProgress"] = this.GenerationEnvironment.ToString();
    throw new System.Exception("Template runtime error", e);
   }
   return this.GenerationEnvironment.ToString();
  }
 }
}

Пусть этот пример очень простой, но сделать несколько выводов удалось:

1. Не стреляйте из пушки по воробьям. Если задача разовая, либо редко выполняемая и шаблону суждено остаться где-то глубоко в недрах вашего корпоративного ПО - использование Т4 не несет никакой дополнительной выгоды. Код, содержащийся в шаблоне, будет прекрасно работать и без Т4 - в тестовом методе, отдельной утилите и т.п.

2. Простое развертывание. Код в шаблоне выполняется независимо от кода остального приложения. Поэтому для добавления шаблона в новый проект достаточно простого копирования. Возможно развертывание с помощью NuGet-пакетов, при этом во всех случаях сохраняется возможность редактирования исходного кода и отладки. Это несомненный плюс.

3. Сложность нарастает. Минусы также очевидны - усложняются чтение, отладка и поддержка, не говоря уже о дополнительных усилиях по переносу логики в шаблон.

4. Слабый инструментарий. Внутри шаблона не работает привычная поддержка IntelliSence и ReSharper. В составе VS "из коробки" нет даже подсветки синтаксиса для *.tt файлов, приходится ставить дополнительные расширения. Кстати, я потестил несколько и остановился на Tangible. Бесплатной версии хватает с головой, но пришлось подкорректировать палитру под темную тему Студии.

На текущем проекте точечно используется Т4, при этом задача повторного развертывания в принципе не стоит. Логика по-максимуму вынесена из *.tt файла в вспомогательные классы. В целом, писать и поддерживать код шаблонов - то еще удовольствие, и я бы рекомендовал использовать эту технологию только в случае железобетонной необходимости.

Полезные ссылки, куда без них:

Text Template Transformation Toolkit (T4): генератор кода в Visual Studio -  вводная статья на Хабре;
Oleg Sych Blog - кладезь информации по T4;
T4 (Text Template Transformation Toolkit) Code Generation - Best Kept Visual Studio Secret - подборка материалов от Scott Hanselman.