Czy jest coś, co sprawi, że kod T4 będzie bardziej ... czysty?

Question

Mam dość skomplikowaną rzecz wypchaną do szablonu T4. Zasadniczo biorę coś takiego

{= foo =} więcej tekstu ...

i przekształcić go w klasie (Widok) tak:

public class MyView 
{ 
    public string foo{get;set;} 
    public string Write() 
    { 
    return foo+@" more text..."; 
    } 
} 

Kod generowany jest oczywiście znacznie bardziej skomplikowane. W każdym razie szablon T4 zawiera obecnie ponad 600 linii kodu i naprawdę szybko staje się niemożliwy do zarządzania. Uważam, że głównym problemem jest mieszanie kodu i "treści" (tj. Kodu statycznego). Naprawdę nie wiem, jak rozwiązać ten problem (choć oczywiście nie wpływa to na generowany kod). Nie widzę też żadnego możliwego sposobu testowania mojego kodu T4, poza testowaniem go pod kątem błędów wykonania T4. Oczywiście wydaje się, że prawie niemożliwe jest przetestowanie wygenerowanego kodu.

Czy istnieją ramy lub techniki typu "widok modelu", których mogę użyć, aby mój kod szablonu T4 był bardziej czysty?

Answer 1

Po długiej podróży w końcu sprawdziłem pierwsze testy jednostkowe do moich szablonów T4. Zasadniczo, zrobiłem abstrakcję "widoku" (rzeczywisty szablon T4) i "logikę" (co generuje kod, ale tak naprawdę nie wyprowadza go i nie polega na T4).

I następnie zrobił to o krok dalej i użył dużego hack, aby mój plik logiczny był kompilowany poza T4. Miało to dobry wpływ na to, aby działało intellisense i błędy kompilatora. Pozwalają mi również uzyskać dostęp do mojej klasy logicznej z testów jednostkowych, odwołując się do projektu.

Napisałem artykuł z przykładami kodu (przed/po) i przykładowymi testami jednostkowymi on my blog, jeśli chcesz mieć długie szczegóły, jak to zrobić.

Answer 2

IMHO dwa najważniejsze pojęcia pisząc skomplikowanych szablonów jest

1. Oddzielenie modelu i widoku - Ułatwia utrzymywanie logiki szablonu do minimum (często przyczyną problemu technicznego). Osobiście uważam, że nie wymaga to ram, wymaga to tylko tego.
2. Częściowo jest twoim przyjacielem - Używam generalnie T4 do generowania kodu szkieletu z modelu. Konkretne zachowanie może nie być warte wysiłku, aby wprowadzić model, lepiej często pozwalać, aby takie zachowanie pojawiło się poprzez użycie częściowych klas lub metod.

Nie tak ważne, ale ładny

1. uczynić kod przeszukiwać - nie polegać na T4 Addons ponieważ uważam, żaden z nich na tyle dobra, z braku IntelliSense aby nawigować kod, który muszę wprowadzić do przeszukiwania kodu. Może być tak proste, jak zamiast wywoływania właściwości Column Name, nazywam ją ColumnName.
2. Wstawianie "znaczników" na wyjściu - Ułatwia znajdowanie kodu, który wygenerował tę część danych wyjściowych.

Przykład oddzielenie modelu/Wygląd:

<# 
    // Model for Dependency Pooperties 
    Model = new [] 
    { 
     new ClassDefinition ("MyDataGrid") 
      { 
       P ("CultureInfo"   , "CultureInfo"), 
       P ("Pen"     , "CellBorderPen"), 
       P ("IEnumerable<object>" , "Rows"), 
       C ("WColumnDefinition"  , "Columns"), 
      }, 
    }; 
#> 
// Include the view 
<#@ include file="..\T4\DependencyProperties.ttinclude" #> 

Widok następnie przechodzi nad i tworzenia modelu właściwości zależności.

Zachowanie właściwości uzależniających są następnie realizowane jako metody częściowych

partial void Changed_Columns(
     ObservableCollection<WColumnDefinition> oldValue, 
     ObservableCollection<WColumnDefinition> newValue 
     ) 
    { 
     HookUpColumns(oldValue, null); 
     HookUpColumns(newValue, this);    
    } 

Należy zauważyć, że wprowadzenie tego specyficzne zachowanie w modelu znacznie komplikuje modelu.

Wreszcie; Potrzeba czasu, aby kompetentny programista mógł kompetentnie pisać metaprogramy.Zajęło mi kilka prób, zanim dotarłem do stylu, który uważam za możliwy do utrzymania, ale dla mnie było to warte wysiłku, ponieważ jestem w stanie szybciej przesyłać jakość.

Mam nadzieję, że to pomoże ...

PS. Nie sądzę, by ktokolwiek twierdził, że T4 jest zawsze elegancki, ale mimo to jest to przydatne.