Awesome 社區模塊

Juicer 中文文檔

當前最新版本: 0.6.14

Juicer 是一個高效、輕量的前端(Javascript) 模板引擎,使用Juicer 可以是你的代碼實現數據和視圖模型的分離(MVC)。除此之外,它還可以在Node.js 環境中運行。

你可以在遵守MIT Licence 的前提下隨意使用並分發它。Juicer 代碼完全開源並託管在

名字的由來

倘若我們把數據比作新鮮可口的水果,把模板看做是水,Juicer 就是把水果和水榨出我們需要的HTML代碼片段的榨汁機。

Juicer 的引入

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

> 註冊/註銷自定義函數(對象),在下邊${變量} 中會有實例.

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 2
juicer.set('strip',false); juicer.set('cache',false);

批量參數更改:

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

Juicer 默認會對編譯後的模板進行緩存,從而避免同一模板多次數據渲染時候重複編譯所耗的時間,如無特殊需要,強烈不建議關閉默認參數中的cache,這麼做將會令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 + '" />'; };

juicer.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. 輔助循環{@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}

子模板嵌套可以讓你更靈活的組織你的模板代碼,除了可以引入在數據中指定的子模板外,當然你也可以通過指定字符串#idscript

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

為模板引擎設置外部Cache存儲:

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