Módulo comunitario incrible

Exprimidor documento chinés

Última versión actual: 0.6.14

Juicer é un motor de plantilla frontal (Javascript) eficiente e lixeiro. Usar Juicer pode ser o seu código para lograr a separación de datos e modelo de visualización (MVC). Ademais, tamén pode executarse no entorno Node.js.

Podes usalo e distribuílo libremente baixo a premisa de observar a licenza MIT. O código Juicer é totalmente de código aberto e aloxado en Github . Se atopas algún erro ou algunha boa suxestión no proceso de usalo, benvido a envialo no número de Github .

orixe do nome

Se comparamos datos con froitas frescas e deliciosas e vemos modelos como auga, Juicer é un exprimidor que espreme a froita e a auga dos fragmentos de código HTML que necesitamos.

Introdución de Juicer

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

* Instrucións

> Compila o modelo e rende inmediatamente o resultado en función dos datos dados.

1
juicer(tpl, data);

> Só o modelo compilado non se renderizará, devolverá unha función compilada reutilizable.

1
var compiled_tpl = juicer(tpl);

> Realice a representación de datos no modelo compilado previamente segundo os datos dados.

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

> Rexistrar / dar de baixa funcións personalizadas (obxectos), haberá exemplos en $ {variables} a continuación.

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

> Carácter límite de sintaxe de modelo personalizado, a continuación móstrase o carácter límite predeterminado de Juicer. Podes usalo para resolver o conflito entre a sintaxe do modelo de Juicer e algunha sintaxe do modelo de idioma 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 predeterminada

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

A configuración predeterminada é o método de uso recomendado por Juicer. Se realmente precisa cambiar estes parámetros durante o uso, pode facelo:

Cambia os parámetros un por un:

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

Cambios de parámetros por lotes:

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

De xeito predeterminado, Juicer gardará en caché o modelo compilado para evitar o tempo que consume a compilación repetida cando o mesmo modelo se representa varias veces. Se non hai necesidade especial, recoméndase encarecidamente que non apague a caché nos parámetros predeterminados. invalidará a caché de Juicer. Deste xeito reducirá o rendemento.

* gramática

a. $ {variables}

Usando o ${}valor da variable de saída, que _é unha referencia a unha fonte de datos (por exemplo ${_}, como se usa habitualmente no caso de que a matriz de orixe de datos). Soporte para funcións personalizadas (función personalizada pode conseguir moitas funcións interesantes, de xeito similar ${data|links}pode dirixir a datos ensamblados mediante ligazóns de función personalizadas definidas previamente <a href=".." alt=".." />).

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

Demostremos o marabilloso uso de funcións personalizadas a través dun exemplo.

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); // Rexistrar unha función personalizada juicer (tpl, json);

Despois de executar o código anterior, descubriremos que o resultado é así:

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 />

Pódese ver que o resultado se escapou. Se usamos $$ {item | links} arriba, obteremos o resultado esperado, que é a evitación de escapar que se menciona a continuación.

Escapar / evitar escapar

Para o ángulo de seguridade, ${变量}escapará do seu contido antes da saída, se non quere que a saída se escape, pode usala $${变量}para evitar esta situación. Por exemplo:

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. Travesía do bucle {@each} ... {@ / cada}

Se precisa percorrer a matriz, pode usalo así each.

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

Tamén é moi cómodo se desexa obter o valor do índice actual durante o proceso de percorrido.

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

c. Xuízo {@if} ... {@else if} ... {@else} ... {@ / if}

Moitas veces atopámonos ao facer xuízos lóxicos sobre os 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. Comentario {# Contido do comentario}

Para a mantibilidade e lexibilidade do código posterior, podemos engadir comentarios ao modelo.

1
{# 这里是注释内容}

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

O bucle auxiliar é un azucre sintáctico que Juicer establece coidadosamente para vostede, quizais o necesite nunha determinada situación.

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

f. Anidación de submodelo {@include tpl, data}

A anidación de sub-modelos permítelle organizar o seu código de modelo de xeito máis flexible. Ademais de importar sub-modelos especificados nos datos, tamén pode #idusar scripto código de modelo escrito en etiquetas especificando cadeas .

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' } });

* Executa no entorno Node.js

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

Uso no marco Express.js

Na versión Express 2.x da serie:

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; } });

Na versión da 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); }); });

Na versión Express 4.x da serie:

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

Compile previamente ficheiros de modelos na liña de comandos:

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` 可以获得更多帮助信息。

Configurar almacenamento de caché externo para o motor de modelos:

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 exemplo 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);