素晴らしいコミュニティモジュール

ジューサー中国語文書

現在の最新バージョン:0.6.14

Juicerは、効率的で軽量なフロントエンド(Javascript)テンプレートエンジンです。Juicerを使用すると、データとビューモデル(MVC)を分離するためのコードになります。さらに、Node.js環境でも実行できます。

MITライセンスを遵守することを前提に、自由に使用・配布することができます。Juicerコードは完全にオープンソースであり、Githubでホストされています。使用中にバグや良い提案を見つけた場合は、GithubIssueで送信してください

名前の由来

データを新鮮でおいしい果物と比較し、テンプレートを水と見なすと、ジューサーは必要なHTMLコードフラグメントから果物と水を絞り出すジューサーです。

ジューサーの紹介

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

* 手順

>テンプレートをコンパイルし、指定されたデータに基づいて結果をすぐにレンダリングします。

1
juicer(tpl, data);

>コンパイルされたテンプレートのみがレンダリングされず、再利用可能なコンパイル済み関数が返されます。

1
var compiled_tpl = juicer(tpl);

>指定されたデータに従って、以前にコンパイルされたテンプレートでデータレンダリングを実行します。

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

>カスタム関数(オブジェクト)の登録/登録解除。以下の$ {variables}に例があります。

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

>カスタムテンプレート構文の境界文字。以下はJuicerのデフォルトの境界文字です。これを使用して、Juicerテンプレート構文と一部のバックエンド言語テンプレート構文の間の競合を解決できます。

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

デフォルトのパラメーター構成

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

デフォルト構成は、Juicerが推奨する使用方法です。使用中にこれらのパラメーターを本当に変更する必要がある場合は、次のようにします。

パラメータを1つずつ変更します。

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

バッチパラメータの変更:

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

デフォルトでは、Juicerはコンパイルされたテンプレートをキャッシュして、同じテンプレートが複数回レンダリングされるときに繰り返しコンパイルされる時間を回避します。特別な必要がない場合は、デフォルトのパラメーターでキャッシュをオフにしないことを強くお勧めします。 Juicerキャッシュが無効になり、パフォーマンスが低下します。

* 文法

a。$ {変数}

データソースへの参照${}である出力変数値を使用する_(たとえば${_}、データソース配列の場合に一般的に使用される)。カスタム関数のサポート(カスタム関数は、${data|links}以前に定義されたカスタム関数リンクによってアセンブルされたデータに直接接続できるのと同様に、多くの興味深い機能を実現できます<a href=".." alt=".." />)。

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

例を通して、カスタム関数のすばらしい使用法を示しましょう。

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 + '" />'; };

Juice.register( 'links_build'、links); //カスタム関数juicer(tpl、json);を登録します。

上記のコードを実行すると、結果は次のようになります。

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

結果がエスケープされていることがわかります。上記の$$ {item | Links}を使用すると、期待どおりの結果が得られます。これは、以下で説明するエスケープの回避です。

エスケープ/エスケープの回避

セキュリティの観点から、${变量}出力前に内容をエスケープします。出力をエスケープしたくない場合は、$${变量}この状況を回避するために使用できます例えば:

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。ループトラバーサル{@each} ... {@ / each}

配列をループする必要がある場合は、次のように使用できますeach

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

トラバーサルプロセス中に現在のインデックス値を取得する場合にも非常に便利です。

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

c。判断{@if} {@ else if} ... {@else} ... {@ / if}

また、データを論理的に判断するときにもよく遭遇します。

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。コメント{#コメントの内容}

後続のコードの保守性と可読性のために、テンプレートにコメントを追加できます。

1
{# 这里是注释内容}

e。補助ループ{@eachi in range(m、n)}

補助ループは、Juicerによって慎重に設定されたシンタックスシュガーです。特定の状況で必要になる場合があります。

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

f。サブテンプレートのネスト{@ includetpl、data}

サブテンプレートをネストすると、テンプレートコードをより柔軟に整理できます。データで指定したサブテンプレートをインポートするだけでなく文字列を指定#idしてscriptタグで記述したテンプレートコードを使用することもできます

HTMLコード:

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

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

* Node.js環境で実行します

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

Express.jsフレームワークで使用

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

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

Express 4.xシリーズバージョンの場合:

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

コマンドラインでテンプレートファイルをプリコンパイルします。

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

テンプレートエンジンの外部キャッシュストレージを設定します。

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

*完全な例

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