ジューサーの中国語ドキュメント
現在の最新バージョン: 0.6.14
Juicer は効率的で軽量なフロントエンド (JavaScript) テンプレート エンジンであり、Juicer を使用すると、コード内でデータとビュー モデル (MVC) の分離を実現できます。これに加えて、Node.js 環境でも実行できます。
MIT ライセンスの条件に基づいて、自由に使用および配布できます。Juicer コードは完全にオープン ソースであり、Githubでホストされています。使用中にバグを見つけたり、良い提案がある場合は、お気軽にGithub Issuesに送信してください。
名前の由来
データを新鮮でおいしい果物、テンプレートを水に例えると、Juicer は果物と水を必要な HTML コード スニペットに絞り出すジューサーです。
ジューサーのご紹介
1<script type="text/javascript" src="juicer-min.js></script>
* 説明書
> テンプレートをコンパイルし、指定されたデータに基づいて結果を即座にレンダリングします。
1juicer(tpl, data);
> テンプレートをレンダリングせずにコンパイルするだけで、再利用可能なコンパイル済み関数が返されます。
1var compiled_tpl = juicer(tpl);
> 指定されたデータに基づいて、以前にコンパイルされたテンプレート上でデータ レンダリングを実行します。
1
2var compiled_tpl = juicer(tpl);
var html = compiled_tpl.render(data);
> カスタム関数 (オブジェクト) を登録/登録解除します。以下の ${variables} に例があります。
1
2juicer.register('function_name', function);
juicer.unregister('function_name');
> テンプレート構文の境界文字をカスタマイズする 以下は、Juicer のデフォルトの境界文字です。これを使用して、Juicer テンプレート構文と一部のバックエンド言語テンプレート構文の間の競合を解決できます。
1
2
3
4
5
6
7
8
9
10juicer.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
2juicer.set('strip',false);
juicer.set('cache',false);
パラメータのバッチ変更:
1
2
3
4juicer.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
17var 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 + '" />';
};
ジューサー.register('links_build', links); //カスタム関数を登録する ジューサー(tpl, json);
上記のコードを実行すると、結果は次のようになります。
1
2
3<a href="http://juicer.name" alt="Juicer" <br />
<a href="http://benben.cc" alt="Benben" <br />
<a href="http://ued.taobao.com" alt="Taobao UED" <br />
結果がエスケープされていることが分かりますが、上記の $${item|links} を使用すると期待通りの結果が得られますが、これは後述するエスケープの回避です。
逃げる/逃げるのを避ける
セキュリティ上の理由から、${变量}内容は出力前にエスケープされますが、出力結果をエスケープしたくない場合は、 を使用して$${变量}この状況を回避できます。例えば：
1
2
3
4
5
6
7
8
9var json = {
value: '<strong>juicer</strong>'
};
var escape_tpl='${value}';
var unescape_tpl='$${value}';
juicer(escape_tpl, json); //输出 '<strong>juicer</strong>'
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. 補助ループ {@each i in range(m, n)}
補助ループは、Juicer によって注意深く設定された糖衣構文であり、状況によっては必要になる場合があります。
1
2
3{@each i in range(5, 10)}
${i}; //输出 5;6;7;8;9;
{@/each}
f. サブテンプレートのネスト {@include tpl, 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
19var 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
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;
}
});
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);
});
});
Express 4.x シリーズ リリースの場合:
1
2
3var juicerExpressAdapter = require('juicer-express-adapter');
app.set('view engine', 'html');
app.engine('html', juicerExpressAdapter);
コマンドラインでテンプレートファイルをプリコンパイルします。
1
2
3
4
5npm install -g juicer
juicer example.juicer.tmpl -f example.js
// type `juicer` after install for more help.
// 全局模式安装 `juicer` 后，在命令行下输入 `juicer` 可以获得更多帮助信息。
テンプレート エンジン用の外部キャッシュ ストレージを設定します。
1
2
3
4
5var 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
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);