CompiledHandlebars

Manillar compilado para c#

Compilar el manillar-semplata en el código C# nativo para la representación HTML de Serverside de rendimiento y tipo Safe.

Acerca de

Este compilador es el resultado de la tesis de solteros de Jakob Demler que cubre el enfoque, las decisiones de diseño, los detalles de implementación y su evaluación y se puede encontrar aquí

Estado del proyecto

Este proyecto se encuentra actualmente en una fase beta.

Características

• Obtenga sus errores de tipo en el tiempo de diseño
• Resolver llamadas parciales y a ayuda de diseño en el tiempo de diseño
• Invocación trivial: TEMPLATENAME.Render (ViewModel);
• Dependencias mínimas: el código resultante solo depende del sistema, el sistema. Net y system.text

Actuación

Se realizó una comparación de rendimiento con los microbistres desde el repositorio de manebars.js: https://github.com/wycats/handlebars.js/tree/master/bench

Microbistique	manebars.js	CompiledHandleBars	Aceleración
arrayeach	391 OPS/MS	3039 OPS/MS	7.77
complejo	120 OPS/MS	1180 OPS/MS	9.83
datos	295 OPS/MS	1333 OPS/MS	4.51
profundidad1	228 OPS/MS	3693 OPS/MS	16.20
profundidad2	63 OPS/MS	1515 OPS/MS	24.04
recursión parcial	125 OPS/MS	1895 OPS/MS	15.16
parcial	211 OPS/MS	905 OPS/MS	4.29
caminos	2060 OPS/MS	4646 OPS/MS	2.25
cadena	5563 OPS/MS	13964 OPS/MS	2.51
variables	1991 OPS/MS	4027 OPS/MS	2.02

Uso

Integración de Visual Studio

Simplemente instale el paquete VSIX en el proyecto CustomTool y reinicie Visual Studio. Agregue una nueva plantilla de manillares a su solución (finalice en .hbs) y luego agregue "manillarscompiler" a la propiedad CustomTool del archivo. El compilador se invocará cada vez que se guarde la plantilla del manillar y creará un archivo {TemplateName} .hbs.cs que contiene el código generado.

Uso básico

Cada plantilla de manillares necesita un tipo que haga. Como ejemplo, una clase llamada "Personmodel" servirá:

 namespace ViewModels
{
  public class PersonModel
  {
    public string FirstName { get ; set ; }
    public string LastName { get ; set ; }
    public int Age { get ; set ; }
    public List < string > EMailAddresses { get ; set ; }
  }
}

Ahora, debemos comunicar el tipo al ManeyBarsCompiler. Al comienzo de cada plantilla de manillares, debe haber un modeltoken condenado:

 {{ model NamespacePath.ClassName }}

Para nuestro ejemplo, eso sería:

 {{ model ViewModels.PersonModel }}

Tenga en cuenta que el tipo dentro del Modeltoken también puede ser una clase base o interfaz del Modelo de View Real que se pasa a la plantilla.

El resto de los manillares-templados sigue sintaxis y semántica de manillares estándar. Aquí está el ejemplo completo:

 {{ model ViewModels.PersonModel }}
< h1 >Hello {{ FirstName }} {{ LastName }} </ h1 >
< p >You are {{ Age }} years old and you have
{{ #if EMailAddresses }}
  following email addresses:
  < ul >
  {{ #each EMailAddresses }}
    < li > {{ this }} </ li >
  {{ /each }}
  </ ul >
{{ else }}
  no email addresses.
{{ /if }} </ p >

Parcialidad

No es necesario registrar los parciales. Solo asegúrese de compilar lo parcial antes de la plantilla de manillares que usa esa parcial. Para todo lo demás se aplica la lógica estándar HANTANBARS.JS.

Funciones auxiliares

CompiledHandleBars permite el uso de funciones auxiliares. Estos deben ser estáticos, devolver una cadena y ser anotado por un atributo. Los parámetros se marcan si coinciden en el tiempo de compilación, por lo que es posible sobrecargar. Aparte de eso, no tienen restricciones y se pueden colocar en cualquier lugar de su base de código.

 [ CompiledHandlebarsHelperMethod ]
pulic static string FullName ( PersonModel model )
{
  return string . Concat ( model . FirstName , " " , model . LastName ) ;
} 

Funcionalidad de diseño

CompiledHandleBars ofrece una funcionalidad diferente con respecto a los diseños: cualquier placa manual se puede renderizar dentro de un manillarslaut. HanyebarsLayouts difieren de las placas de manejo normales debido a un token especial {{cuerpo}}}:

 {{ model ViewModels.IPageModel }}
<! DOCTYPE html>
< head >
  < title > {{ Title }} </ title >
  {{ #if Keywords }} < meta name = " keywords " content = " {{ Keywords }} " > {{ /if }}
</ head >
< body >
  {{ body }}
</ body >
</ html >

Para renderizar una plantilla de manillares en ese diseño, use el token {{diseño}} justo después del token {{modelo}}:

 {{ model ViewModels.TitlePageModel }}
{{ layout MainLayout }}
< h1 > {{ Headline }} </ h1 >
< p > {{ Content }} </ p >

El resultado de esa plantilla es igual a la siguiente plantilla:

 {{ model ViewModels.TitlePageModel }}
<! DOCTYPE html>
< head >
< title > {{ Title }} </ title >
  {{ #if Keywords }} < meta name = " keywords " content = " {{ Keywords }} " > {{ /if }}
</ head >
< body >
  < h1 > {{ Headline }} </ h1 >
  < p > {{ Content }} </ p >
</ body >
</ html >

Compatibilidad con el manillar.js

Sintaxis especial

Debido a la diferente enfoque de la versión HandleBars.js (por ejemplo, estática, las plantillas de manillares escrita estática), el compilador debe saber qué tipo se entiende su plantilla de manillares. Esta información es comunicada al compilador por un Modeltoken especial. Su sintaxis es sencilla:

 {{ model NamespacePath.ClassName }}

Por ejemplo:

 {{ model HandlebarsTest.TestViewModel }}

Esta ficha debe estar al comienzo de cada plantilla de manillares.

Subconjunto implementado

• HTML Codificación/escapada
• Ayudantes de bloques construidos
• Parcialidad
• Funciones auxiliares
• Control de espacios en blanco

No implementado:

• Bloques de bigote
• Ayudantes de bloqueo
• Subexpresiones

Edificio

Se necesitan los siguientes requisitos previos para poder construir la solución:

• Visual Studio 2015
• Herramientas de extensibilidad de Visual Studio 2015