Juicer Document-JavaScript cinese su fibra

Juicer Chinese Document

Ultima versione attuale: 0.6.14

Juicer è un motore di template front-end (Javascript) efficiente e leggero. Usare Juicer può essere il tuo codice per ottenere la separazione dei dati e il modello di visualizzazione (MVC). Inoltre, può anche essere eseguito nell'ambiente Node.js.

Puoi usarlo e distribuirlo liberamente sotto la premessa di rispettare la licenza MIT. Il codice di Juicer è completamente open source e ospitato su Github . Se trovi qualche bug o qualche buon suggerimento durante il processo di utilizzo, invialo su Github Issue .

origine del nome

Se confrontiamo i dati con frutta fresca e deliziosa e il modello come acqua, Juicer è uno spremiagrumi che spreme la frutta e l'acqua dai frammenti di codice HTML di cui abbiamo bisogno.

Introduzione di Juicer

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

* Istruzioni

> Compila il modello e visualizza il risultato immediatamente in base ai dati forniti.

1
juicer(tpl, data);

> Solo il modello compilato non verrà visualizzato, restituirà una funzione compilata riutilizzabile.

1
var compiled_tpl = juicer(tpl);

> Eseguire il rendering dei dati sul modello precedentemente compilato in base ai dati forniti.

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

> Registra / cancella la funzione personalizzata (oggetto), ci saranno esempi in $ {variable} di seguito.

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

> Carattere limite della sintassi del modello personalizzato, di seguito è riportato il carattere limite predefinito di Juicer. È possibile utilizzarlo per risolvere il conflitto tra la sintassi del modello Juicer e la sintassi del modello del linguaggio di backend.

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

Configurazione dei parametri di default

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

La configurazione predefinita è il metodo di utilizzo consigliato da Juicer. Se hai davvero bisogno di modificare questi parametri durante l'uso, puoi fare:

Modificare i parametri uno per uno:

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

Modifiche ai parametri in batch:

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

Juicer memorizzerà nella cache il modello compilato per impostazione predefinita per evitare il tempo impiegato dalla compilazione ripetuta quando lo stesso modello viene renderizzato più volte. Se non è necessario un particolare bisogno, si consiglia vivamente di non disattivare la cache nei parametri predefiniti. In questo modo si invaliderà la cache di Juicer. Riducendo così le prestazioni.

* Grammatica

a. $ {variabili}

Utilizza ${} generare valori di variabili, dove _ è un riferimento all'origine dati (ad esempio, ${_} spesso utilizzato quando l'origine dati è un array). Supporta funzioni personalizzate (puoi ottenere molte funzioni interessanti tramite funzioni personalizzate, simili a ${data|links} puoi assemblare direttamente i dati tramite collegamenti a funzioni personalizzate predefinite <a href=".." alt=".." /> ).

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

Cerchiamo di dimostrare il meraviglioso utilizzo delle funzioni personalizzate attraverso un esempio.

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); // Registra la funzione personalizzata juicer (tpl, json);

Dopo che il codice sopra è stato eseguito, troveremo che il risultato è questo:

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

Si può vedere che il risultato è in escape. Se usiamo $$ {item | links} sopra, otterremo il risultato atteso. Questo è il modo per evitare l'escape menzionato di seguito.

Fuggire / Evitare Fuggire

Per motivi di sicurezza, ${变量} uscirà dal suo contenuto prima dell'output. Se non vuoi che il risultato dell'output sia sottoposto a escape, puoi usare $${变量} per evitare questa situazione. Per esempio:

1
2
3
4
5
6
7
8
9var 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. Attraversamento in loop {@each} ... {@ / each}

Se è necessario scorrere l'array, è possibile utilizzare each come questo.

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

È anche molto comodo se si desidera ottenere il valore di indice corrente durante il processo di attraversamento.

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

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

Spesso incontriamo anche giudizi logici sui dati.

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. Commenta {# Comment content}

Per la manutenibilità e leggibilità del codice successivo, possiamo aggiungere commenti al modello.

1
{# 这里是注释内容}

e. Ciclo ausiliario {@ogni i nell'intervallo (m, n)}

Il ciclo ausiliario è uno zucchero sintattico impostato con cura da Juicer per te, forse ne avrai bisogno in una determinata situazione.

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

f. Nidificazione di sotto-modello {@include tpl, data}

L'annidamento dei sub-template ti permette di organizzare il codice del tuo template in modo più flessibile. Oltre a importare sub-template specificati nei dati, ovviamente puoi anche utilizzare il codice del template scritto nel tag dello script specificando la stringa #id .

Codice HTML:

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

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

* Esegui in ambiente Node.js.

1
2
3
4
5
6在命令行中执行:
npm install juicer

在代码中这么引入:
var juicer = require('juicer');
var html = juicer(tpl, data);

Utilizzare nel framework Express.js

Nella versione della serie Express 2.x:

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

Nella versione della serie Express 3.x:

1
2
3
4
5
6
7
8
9
10
11npm 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);
    });
});

Nella versione della serie Express 4.x:

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

Pre-compilare i file modello sulla riga di 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` 可以获得更多帮助信息。

Configurare l'archiviazione cache esterna per il motore dei modelli:

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 esempio 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
43HTML 代码:

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

Guida allo sviluppo

Modulo base

Oggetti incorporati

Modulo comunitario