Impresionante módulo de comunidad

Documentación de exprimidor

Última versión actual: 0.6.14

Juicer es un motor de plantillas front-end (Javascript) eficiente y liviano. El uso de Juicer puede lograr la separación de datos y modelos de vista (MVC) para su código. Además, también puede ejecutarse en un entorno Node.js.

Puede usarlo y distribuirlo libremente sujeto a la Licencia MIT. El código de Juicer es completamente de código abierto y está alojado en Github . Si encuentra algún error o alguna buena sugerencia en el proceso de uso, envíelos en Github Issue .

Origen del nombre

Si comparamos los datos con fruta fresca y deliciosa y la plantilla como agua, Juicer es el exprimidor que exprime la fruta y el agua en el fragmento de código HTML que necesitamos.

La introducción de exprimidor

1
<script type="text/javascript" src="juicer-min.js></script>

* Cómo usar

> Compile la plantilla e inmediatamente represente los resultados en función de los datos proporcionados.

1
juicer(tpl, data);

> Solo la plantilla compilada aún no se procesa, devolverá una función compilada reutilizable.

1
var compiled_tpl = juicer(tpl);

> Según los datos proporcionados, realice el procesamiento de datos en la plantilla compilada previamente.

1 2
var compiled_tpl = juicer(tpl); var html = compiled_tpl.render(data);

> Registrar / cancelar el registro de funciones personalizadas (objetos), habrá instancias en $ {variable} a continuación.

1 2
juicer.register('function_name', function); juicer.unregister('function_name');

> Caracteres de límite de sintaxis de plantilla personalizada. A continuación se muestran los caracteres de límite predeterminados de Juicer. Puede usar esto para resolver situaciones en las que la sintaxis de la plantilla de Juicer entre en conflicto con alguna sintaxis de plantilla de lenguaje de fondo.

1 2 3 4 5 6 7 8 9 10
juicer.set({ 'tag::operationOpen': '{@', 'tag::operationClose': '}', 'tag::interpolateOpen': '${', 'tag::interpolateClose': '}', 'tag::noneencodeOpen': '$${', 'tag::noneencodeClose': '}', 'tag::commentOpen': '{#', 'tag::commentClose': '}' });

Configuración de parámetros por defecto

1 2 3 4 5 6
{ cache: true [false], strip: true [false], errorhandling: true [false], detection: true [false] }

La configuración predeterminada es la forma recomendada de usar Juicer. Si realmente necesita cambiar estos parámetros durante el uso, puede hacer esto:

Cambio de parámetro artículo por artículo:

1 2
juicer.set('strip',false); juicer.set('cache',false);

Cambios masivos de parámetros:

1 2 3 4
juicer.set({ 'strip': false, 'cache': false };

Juicer almacena en caché las plantillas compiladas de forma predeterminada, para evitar el tiempo dedicado a la compilación repetida cuando la misma plantilla se procesa varias veces. Si no hay una necesidad especial, se recomienda encarecidamente no desactivar la memoria caché en los parámetros predeterminados. Esto invalidará la memoria caché de Juicer Esto reduce el rendimiento.

* Sintaxis

a. $ {variable}

Use ${} generar valores variables, donde _ es una referencia a la fuente de datos (como ${_} , que a menudo se usa cuando la fuente de datos es una matriz). Soporte para funciones personalizadas (puede implementar muchas funciones interesantes a través de funciones personalizadas. Similar a ${data|links} puede ensamblar datos directamente mediante enlaces de funciones personalizadas predefinidos <a href=".." alt=".." /> ).

1 2 3
${name} ${name|function} ${name|function, arg1, arg2}

Usemos un ejemplo para demostrar el maravilloso uso de funciones personalizadas.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
var json = { links: [ {href: 'http://juicer.name', alt: 'Juicer'}, {href: 'http://benben.cc', alt: 'Benben'}, {href: 'http://ued.taobao.com', alt: 'Taobao UED'} ] }; var tpl = [ '{@each links as item}', '${item|links_build} <br />', '{@/each}' ].join(''); var links = function(data) { return '<a href="' + data.href + '" alt="' + data.alt + '" />'; };

juicer.register ('links_build', links); // Registre una función personalizada exprimidor (tpl, json);

Después de ejecutar el código anterior, encontraremos el resultado:

1 2 3
&lt;a href=&quot;http://juicer.name&quot; alt=&quot;Juicer&quot; <br /> &lt;a href=&quot;http://benben.cc&quot; alt=&quot;Benben&quot; <br /> &lt;a href=&quot;http://ued.taobao.com&quot; alt=&quot;Taobao UED&quot; <br />

Puede ver que el resultado se ha escapado. Si usamos $$ {item | links} arriba, obtendremos el resultado que esperábamos. Esta es la evasión que se menciona a continuación.

Escapar / evitar escapar

Por razones de seguridad, ${变量} escapará de su contenido antes de la salida. Si no desea que se escape la salida, puede usar $${变量} para evitar esto. Por ejemplo:

1 2 3 4 5 6 7 8 9
var json = { value: '&lt;strong&gt;juicer&lt;/strong&gt;' }; var escape_tpl='${value}'; var unescape_tpl='$${value}'; juicer(escape_tpl, json); //输出 '&lt;strong&gt;juicer&lt;/strong&gt;' juicer(unescape_tpl, json); //输出 '<strong>juicer</strong>'

b. Recorra {@each} ... {@ / each}

Si necesita recorrer la matriz, puede usar each esta manera.

1 2 3
{@each list as item} ${item.prop} {@/each}

También es conveniente si desea obtener el valor del índice actual durante el recorrido.

1 2 3 4
{@each list as item, index} ${item.prop} ${index} //当前索引 {@/each}

c. Juzgar {@if} ... {@else if} ... {@else} ... {@ / if}

También a menudo nos encontramos con juicios lógicos de datos.

1 2 3 4 5 6 7 8 9
{@each list as item,index} {@if index===3} the index is 3, the value is ${item.prop} {@else if index === 4} the index is 4, the value is ${item.prop} {@else} the index is not 3, the value is ${item.prop} {@/if} {@/each}

d. Comentarios {# Notas Contenido}

Para la mantenibilidad y legibilidad del código subsiguiente, podemos agregar comentarios a la plantilla.

1
{# 这里是注释内容}

e. Bucle auxiliar {@ cada i en el rango (m, n)}

El bucle auxiliar es un azúcar sintáctico cuidadosamente establecido por Juicer. Tal vez lo necesite en algunas situaciones.

1 2 3
{@each i in range(5, 10)} ${i}; //输出 5;6;7;8;9; {@/each}

f. Anidación de sub-plantilla {@include tpl, data}

La anidación de sub-plantillas le permite organizar su código de plantilla de manera más flexible. Además de introducir sub-plantillas especificadas en los datos, también puede usar el código de plantilla escrito en la etiqueta del script especificando la cadena #id .

Código HTML:

1 2 3
<script type="text/juicer" id="subTpl"> I'm sub content, ${name} </script>

Código Javascript:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
var tpl = 'Hi, {@include "#subTpl", subData}, End.'; juicer(tpl, { subData: { name: 'juicer' } }); //输出 Hi, I'm sub content, juicer, End. //或者通过数据引入子模板,下述代码也将会有相同的渲染结果: var tpl = 'Hi, {@include subTpl, subData}, End.'; juicer(tpl, { subTpl: "I'm sub content, ${name}", subData: { name: 'juicer' } });

* Ejecutar en entorno Node.js

1 2 3 4 5 6
在命令行中执行: npm install juicer 在代码中这么引入: var juicer = require('juicer'); var html = juicer(tpl, data);

Usar en el framework Express.js

En la serie Express 2.x:

1 2 3 4 5 6 7 8
npm install juicer var juicer = require('juicer'); app.set('view engine', 'html'); app.register('.html', { compile: function(str, options) { return juicer.compile(str, options).render; } });

En la serie Express 3.x:

1 2 3 4 5 6 7 8 9 10 11
npm install juicer var juicer = require('juicer'); var fs = require('fs'); app.set('view engine', 'html'); app.engine('html', function(path, options, fn){ fs.readFile(path, 'utf8', function(err, str){ if (err) return fn(err); str = juicer(str, options); fn(null, str); }); });

En la serie Express 4.x:

1 2 3
var juicerExpressAdapter = require('juicer-express-adapter'); app.set('view engine', 'html'); app.engine('html', juicerExpressAdapter);

Precompile archivos de plantilla en la línea de comando:

1 2 3 4 5
npm install -g juicer juicer example.juicer.tmpl -f example.js // type `juicer` after install for more help. // 全局模式安装 `juicer` 后,在命令行下输入 `juicer` 可以获得更多帮助信息。

Configure el almacenamiento en caché externo para el motor de plantillas:

1 2 3 4 5
var juicer = require('juicer'); var LRUCache = require('lru-native'); var cache = new LRUCache({ maxElements: 1000 }); juicer.set('cachestore', cache);

* Un ejemplo completo

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
HTML 代码: <script id="tpl" type="text/template"> <ul> {@each list as it,index} <li>${it.name} (index: ${index})</li> {@/each} {@each blah as it} <li> num: ${it.num} <br /> {@if it.num==3} {@each it.inner as it2} ${it2.time} <br /> {@/each} {@/if} </li> {@/each} </ul> </script> Javascript 代码: var data = { list: [ {name:' guokai', show: true}, {name:' benben', show: false}, {name:' dierbaby', show: true} ], blah: [ {num: 1}, {num: 2}, {num: 3, inner:[ {'time': '15:00'}, {'time': '16:00'}, {'time': '17:00'}, {'time': '18:00'} ]}, {num: 4} ] }; var tpl = document.getElementById('tpl').innerHTML; var html = juicer(tpl, data);