Microsoft Visual Studio inclui um mecanismo de geração de código conhecido como T4 (que é a abreviação de texto modelo transformação Toolkit). Você provavelmente já usou T4 modelos no Visual Studio sem mesmo saber que estavam trabalhando nos bastidores. Este artigo vou para lhe fornecer uma introdução básica ao T4 modelos e mostrar como o ASP.NET MVC usa essa tecnologia. Também mostrarei como personalizar modelos T4 para aprimorar seu trabalho diário com a estrutura MVC.
A idéia básica por trás do modelo de Kit de ferramentas é analisar um arquivo de entrada e transformá-lo em um arquivo de saída. O arquivo de entrada é um modelo — um arquivo de texto com uma extensão de arquivo .tt. O arquivo de saída também conterá o texto e o texto pode ser translation from VPE for Csharp código, Visual Basic código, Web Forms código, marcação ou qualquer outra coisa que você precisa gerar.
A maneira mais fácil de ver T4 em ação é criar um novo projeto no Visual Studio. Eu vai ser Gerando código translation from VPE for Csharp neste artigo, para que você possa usar qualquer tipo de projeto que compila código translation from VPE for Csharp. Quando o projeto é aberto, clique com o botão direito do mouse no projeto e selecione Add | New Item. Selecione o arquivo de texto da caixa de diálogo Add New Item (não há nenhum modelo de item dedicado T4 no Visual Studio 2008, mas haverá em 2010) e nomeie o arquivo Simple.tt (Certifique-se de que você usa a extensão .tt). Assim que o arquivo é carregado para o projeto você imediatamente verá um arquivo Simple.cs aparecem atrás Simple.tt na janela Solution Explorer (consulte 1 Figura ).
Figura 1 translation from VPE for Csharp arquivo atrás de um modelo T4
Simple.tt e Simple.cs será iniciado como arquivos vazios. Se você clique com o botão direito do mouse no arquivo Simple.tt e selecione Propriedades, você verá que o Visual Studio atribuído TextTemplatingFileGenerator como a ferramenta personalizada para o arquivo (consulte do Figura 2). Esse gerador é o mecanismo de T4 transformará o arquivo de modelo em um arquivo de código translation from VPE for Csharp.
Figura 2 Propriedades do modelo T4
Para tornar o modelo de fazer algo interessante, adicione o seguinte código:
<#@ template language="c#v3.5" #>
<#@ assembly name="System.Web.Mvc.DLL" #>
<#@ import namespace="System.Web.Mvc" #>
public class Test
{
<# for(int i = 0; i < 5; i++) { #>
public int Prop<#= i #> { get; set; }
<# } #>
}
O código começa com algumas diretivas. As diretivas permitem que você especificar a linguagem de programação para o modelo e incluir namespaces e assemblies necessários pelo código no modelo. Quero enfatizar que estou falando de configurações necessárias para executar código no modelo e não o código no projeto propriamente dito. Você também pode usar uma diretiva para especificar a extensão do arquivo de saída. O padrão é translation from VPE for Csharp, mas como mencionei anteriormente, você pode gerar código de Visual Basic, XML, HTML ou qualquer artefato textual.
As diretivas que estou usando informar ao mecanismo do modelo para usar o compilador translation from VPE for Csharp que vem com o Microsoft .NET Framework 3.5. Ela também informa o mecanismo de modelo para fazer referência ao assembly de ASP.NET MVC e para trazer o namespace System.Web.Mvc para o escopo. O MVC assembly e namespace não são realmente exigidos pelo código simples do modelo, mas eu os colocar no modelo como exemplo.
Após as diretivas, o texto que você vê que não é entre < # e # > delimitadores é colocado textual no arquivo de saída. O texto entre < # e # > é translation from VPE for Csharp código. O mecanismo de modelo irá analisar o código e adicioná-lo a uma classe para execução (uma classe, por fim, derivada da classe TextTransformation no conjunto de módulos (assembly) Microsoft.VisualStudio.TextTemplating). Esse processo é semelhante ao processo de mecanismo do modo de exibição do ASP.NET onde o código e marcação em um arquivo .aspx são adicionados a uma classe, por fim, derivada do System.Web.UI.Page. Se você já foi escrevendo suas exibições do MVC usando o mecanismo de exibição de Web Forms, você se sentirá à vontade criando modelos. Em arquivos .aspx, você pode usar código translation from VPE for Csharp para gerar HTML. No meu arquivo .tt, estou usando código translation from VPE for Csharp para gerar código translation from VPE for Csharp.
O código que tenho em Simple.tt produzirá a seguinte saída translation from VPE for Csharp Simple.tt.cs:
public class Test
{
public int Prop0 { get; set; }
public int Prop1 { get; set; }
public int Prop2 { get; set; }
public int Prop3 { get; set; }
public int Prop4 { get; set; }
}
Claro, a classe de teste é totalmente inútil e wholly desinteressantes, mas espero que ele lhe dá uma idéia das possibilidades existentes com modelos T4. Porque você estiver escrevendo um código translation from VPE for Csharp no modelo, você pode se conectar a bancos de dados, ler dados do sistema de arquivos, analisar XML ou usar qualquer classe do .NET para conectar-se e ler os metadados que existe em algum lugar no seu ambiente. Esses metadados, como um esquema de banco de dados ou os tipos de outro assembly, são informações que você pode usar para gerar classes. As classes se tornará parte do projeto atual, portanto, eles serão compilados no assembly atual e você pode usá-los em seu aplicativo.
Edição T4
Quando você está editando T4 modelos no Visual Studio, você não terá nenhuma ajuda dos serviços de linguagem no IDE, como o IntelliSense e realce de sintaxe. Há duas soluções para esse problema. Um é o editor Visual T4 disponibilizou Clarius Consulting (de
visualt4.com ). Outra solução é o Editor T4 tangíveis da tangíveis Engineering (de
t4 editor.tangible-engineering.com ).
Com um entendimento básico de como os modelos T4 funcionam, let’s Observe como o MVC framework usa modelos T4.
T4 no ASP.NET MVC
Você estava usando modelos T4 toda vez que você utilizou o Adicionar modo de exibição ou o controlador adicionar recursos em um projeto ASP.NET MVC. Esses modelos estão localizados na instalação do Visual Studio dentro da pasta de 2\CodeTemplates Common7\IDE\ItemTemplates\CSharp\Web\MVC. Também existem versões do Visual Basic do modelo, mas deixarei isso como um exercício para o leitor para deduzir o nome da pasta.
Os modelos em si fornecem uma excelente educação sobre o valor e os recursos do T4. Por exemplo, aqui está um trecho da List.tt na subpasta AddView da CodeTemplates:
if(!String.IsNullOrEmpty(mvcViewDataTypeGenericString)) {
Dictionary<string, string> properties =
new Dictionary<string, string>();
FilterProperties(mvcHost.ViewDataType, properties);
#>
<table>
<tr>
<th></th>
<#
foreach(KeyValuePair<string, string> property in properties) {
#>
<th>
<#= property.Key #>
</th>
<#
}
#>
O trabalho de List.tt é produzir um arquivo .aspx que exibirá uma coleção de objetos do modelo em formato tabular. No modelo você pode ver a tabela, tr e th marcas que estão sendo gravadas. Para produzir o arquivo .aspx o modelo precisa de algumas informações contextuais, como o nome da página mestra deve usar e o tipo de modelo. O modelo pode recuperar essas informações de seu objeto de host. O objeto host fica entre um modelo e o mecanismo T4 e pode dar um modelo de acesso a recursos (como arquivos locais) e das configurações do ambiente. Normalmente, o host é o Visual Studio, mas a equipe de MVC criou um host personalizado do tipo MvcTextTemplateHost no conjunto de módulos (assembly) Microsoft.VisualStudio.Web.Extensions. É esse objeto de host personalizado que carrega consigo informações digitadas nas caixas de diálogo Adicionar controladora e adicionar modo de exibição, que são as coisas mais próximos que você encontrará a assistentes em um projeto do MVC.
List.TT irá executar um loop através da exibição Propriedades do objeto com rigidez de tipos de modelo e criar uma tabela com uma coluna para cada propriedade. O modelo usa a reflexão para descobrir as propriedades disponíveis do modelo em um método FilterProperties. FilterProperties é um método auxiliar posteriormente definido no arquivo de modelo. O modelo também configura os links para navegar até as ações de edição e detalhes e configura as diretivas apropriadas @ Page ou @ Control para .aspx, dependendo se você estiver criando um modo de exibição ou um modo de exibição parcial.
Quando terminar o modelo em execução, você terá um novo .aspx exiba com tudo o que é necessário para exibir uma coleção de objetos do modelo. Provavelmente você ir para o arquivo .aspx e realizar alguns ajustes para o modo de exibição consistente com a aparência dos modos de exibição no restante do seu aplicativo.
Se você achar que está sempre fazendo as mesmas alterações para esses modos de exibição gerados (ou o código de controlador gerado pelo Controller.tt), você pode economizar tempo, modificando os modelos em si. Por exemplo, você poderia modificar os modelos internos para adicionar atributos de classe para regras de estilo que você usar no seu projeto, ou talvez algo ainda mais drásticas. Tenha em mente que modificar os arquivos de modelo no diretório de instalação do Visual Studio irão alterar o código gerado em todos os projetos que você trabalha com em seu computador. Se você desejar alterar o código gerado para um único projeto, você pode fazer isso, muito.
Personalização de T4-projeto
Se você desejar versões personalizadas dos modelos de geração de código em uma base per project, sua primeira etapa é copiar a pasta CodeTemplates da instalação do Visual Studio e colá-lo na raiz do seu projeto ASP.NET MVC. Você Don precisa copiar todos os modelos em seu projeto, no entanto. Você pode copiar apenas os modelos que você deseja modificar. Há um total de seis modelos de geração de código MVC, um para adicionar um controlador (Controller.tt) e cinco para adicionando modos de exibição (List.tt Create.tt, Empty.tt Details.tt, Edit.tt,). Se existir um modelo no seu projeto, ele substituirá o modelo no diretório de instalação do Visual Studio.
Quando você adiciona um arquivo .tt a uma solução do Visual Studio, o IDE atribuirá automaticamente o arquivo .tt uma configuração de ferramenta personalizada de TextTemplatingFileGenerator. Você já viu esse comportamento se você criou o modelo Simple.tt discutido anteriormente. No entanto, isso não é a configuração correta para os modelos de T4 MVC. As ferramentas MVC para o Visual Studio irão chamar esses modelos em momentos apropriados e criar o objeto MvcTextTemplateHost especial durante o processamento do modelo. Assim, após copiar os modelos em seu projeto, a segunda etapa é abrir a janela de propriedades para cada arquivo de modelo e remover a configuração da ferramenta personalizada (deixe em branco configuração). Neste ponto, você estará pronto para personalizar seus modelos.
Propriedades MvcTextTemplateHost
Observe que nem todas as propriedades no objeto MvcTextTemplateHost estão disponíveis para cada contexto. Os modelos executar ao chamar Adicionar modo de exibição e Controller adicionar itens de menu de contexto. A propriedade Namespace está disponível para os dois essas operações e será definida como o valor apropriado. A propriedade de página mestre, no entanto, só é definida como um valor válido durante uma operação Adicionar modo de exibição e irá conter o valor inserido para o nome da página mestre na caixa de diálogo Adicionar modo de exibição pelo usuário.
Como exemplo, let’s que você não quiser que os controladores de uma ação de índice. Você preferir usar uma ação padrão denominada lista. Você pode abrir o modelo Controller.tt na pasta CodeTemplates\AddController e alterar a área adequada do código para a seguinte aparência:
public class <#= mvcHost.ControllerName #> : Controller
{
// GET: /<#= mvcHost.ControllerRootName #>/
public ActionResult List()
{
return View();
}
...
Esta é uma alteração simples para fazer, mas ele pode salvar você e sua equipe um pouco de tempo durante a vida útil de um projeto grande.
Um passo adiante — T4MVC
No segundo semestre de 2009, David Ebbo da equipe do ASP.NET criado T4MVC, um modelo T4 projetado para gerar auxiliares com rigidez de tipos em um aplicativo ASP.NET MVC. Ebbo tem refinado o modelo ao longo do tempo e você agora pode baixá-la de aspnet.codeplex.com/wikipage?title=T4mvc.
O modelo T4MVC é um modelo T4 tradicional. Adicione T4MVC.tt e seu arquivo de configurações associadas (T4MVC.settings.t4) a seu projeto e ele usará a ferramenta personalizada TextTemplatingFileGenerator para gerar código translation from VPE for Csharp. T4MVC ajudará você a eliminar muitos dos literais da cadeia de caracteres magic do seu aplicativo MVC. Por exemplo, um dos trabalhos que fará o modelo é verificar as pastas de conteúdo e scripts em seu projeto e gerar classes com propriedades estáticas para representar cada script e parte do conteúdo.
O código gerado significa que você pode processar a exibição de parcial LogOnUserControl fornecida pelo projeto do MVC padrão com este código:
<% Html.RenderPartial(MVC.Shared.Views.LogOnUserControl); %>
Anteriormente você seria tiver usado um literal de cadeia de caracteres:
<% Html.RenderPartial("LogOnUserControl"); %>
Se alguém renomeia, move ou exclui o LogonUserControl, o código com rigidez de tipos produzirá um erro de compilação quando compila o modo de exibição. Juntamente com rigidez acesso a modos de exibição e modos de exibição parciais, o modelo T4MVC também oferece com rigidez de tipos de acesso a todos os arquivos dentro de suas pastas de conteúdo e scripts e com rigidez de tipos acesso a controladores e ações do controlador.
Você pode usar as classes geradas T4MVC durante a criação de links de ação, retornando resultados de modo de exibição e mesmo quando a tabela de roteamento para um aplicativo de criação. Observe que, quando você adiciona pela primeira vez T4MVC para seu projeto, você verá alguns avisos gerados na janela de lista de erros do IDE. Esses avisos são apenas T4MVC informando você sobre alguns altera está sendo aplicada ao seu código. A maioria dessas alterações são nada que altere o comportamento do seu aplicativo; os modelos T4MVC basta adicionar algumas palavras-chave parcial a definições de classes do controlador e também fará com que os métodos de ação não-virtuais virtual.
Mais fácil de manter
T4 é um tesouro maravilhoso dentro do Visual Studio mas ainda não falha. Este artigo fornece tudo o que você precisa para começar a usar modelos personalizados para seu projeto ASP.NET MVC. Felizmente, você pode encontrar alguns usos para modelos T4 outside of seu projeto de aplicativo da Web, muito. Você deve também testar modelos T4MVC em seu projeto, como eles tornam o seu código mais fácil de manter e refatorar. T4 tecnologia no futuro, é ainda melhor no Visual Studio 2010 com a adição de modelos de item dedicado e pre-compiled modelos.
