模板引擎 -- art-template

1 介紹:

art-template 是一個簡約厢破、超快的模板引擎掸哑。
它采用作用域預(yù)聲明的技術(shù)來優(yōu)化模板渲染速度,從而獲得接近 JavaScript 極限的運行性能兰英,并且同時支持 NodeJS 和瀏覽器玷坠。

1.1 模板語法:

art-template 同時支持兩種模板語法蜗搔。標(biāo)準(zhǔn)語法可以讓模板更容易讀寫;原始語法具有強大的邏輯處理能力八堡。

標(biāo)準(zhǔn)語法

{{if user}}
<h2>{{user.name}}</h2>
{{/if}}

原始語法

<% if (user) { %>
<h2><%= user.name %></h2>
<% } %>

1.2 核心方法:

// 基于模板名渲染模板
template(filename, data);

// 將模板源代碼編譯成函數(shù)
template.compile(source, options);

// 將模板源代碼編譯成函數(shù)并立即執(zhí)行
template.render(source, data, options);

2 安裝

2.1 安裝方法:

  • 通過npm安裝: npm install art-template --save
  • 下載安裝

2.2 在瀏覽器中編譯

因為瀏覽器不支持文件系統(tǒng)樟凄,所以 template(filename, data) 不支持傳入文件路徑,它內(nèi)部使用 document.getElementById(filename).innerHTML 來獲取模板兄渺,例如:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
    <!-- 引入template-web.js -->
    <script src="./node_modules/art-template/lib/template-web.js"></script>
</head>
<body>
    <div id="container"></div>
    <!-- 創(chuàng)建 script 標(biāo)簽創(chuàng)建模板,注意下面幾點 -->
    <!-- 1. type="text/該斜杠后可以是 html,template... 不是script即可)" -->
    <!-- 2. 給 script 標(biāo)簽添加 id 缝龄,此 id 即為模板 id -->
    <!-- 3.模板 script 標(biāo)簽必須在 template() 方法調(diào)用的 script 標(biāo)簽之前 -->
    <script type="text/html" id="tpl">
        {{if user}}
        <h2>{{user.name}}</h2>
        {{/if}}
    </script>
    <script>
        var user = {
            name: 'Template username'
        }
        var html = template('tpl', {user: user})
        var container = document.querySelector('#container');
        container.innerHTML = html;
    </script>
</body>
</html>

瀏覽器打開看到的結(jié)果如下:


通過瀏覽器渲染模板.png

3 語法

art-template 支持標(biāo)準(zhǔn)語法與原始語法。標(biāo)準(zhǔn)語法可以讓模板易讀寫,而原始語法擁有強大的邏輯表達能力二拐。

標(biāo)準(zhǔn)語法支持基本模板語法以及基本 JavaScript 表達式;原始語法支持任意 JavaScript 語句凳兵,這和 EJS 一樣百新。

3.1 輸出


標(biāo)準(zhǔn)語法

{{value}}
{{data.key}}
{{data['key']}}
{{a ? b : c}}
{{a || b}}
{{a + b}}

原始語法

<%= value %>
<%= data.key %>
<%= data['key'] %>
<%= a ? b : c %>
<%= a || b %>
<%= a + b %>

3.2 原文輸出


標(biāo)準(zhǔn)語法

{{@ value}}

原始語法

<%- value %>

3.3 條件輸出


標(biāo)準(zhǔn)語法

<!-- 單 if 判斷 -->
{{if value}} 
... 
{{/if}}

<!-- if ... else ... 判斷 -->
{{if v1}} 
... 
{{else if v2}}
 ... 
{{/if}}

原始語法

<!-- 單 if 判斷 -->
<% if (value) { %>
...
<% } %>

<!-- if ... else ... 判斷 -->
<% if (v1) { %>
...
<% else if (v2) { %>
...
<% } %>

3.4 循環(huán)輸出


標(biāo)準(zhǔn)語法

{{each target}}
  {{$index}} {{$value}}
{{/each}}

target是一個數(shù)組,each用于對數(shù)組遍歷庐扫,$index 是數(shù)組的下標(biāo)饭望, $value是數(shù)組的值
原始語法

<% for (var i = 0; i < target.length; i++) { %>
<%= i %> <%= target[i] %>
<% } %>

注意:

  1. target 支持 arrayobject 的迭代,其默認(rèn)值為 $data形庭。
    具體看下面的例子:
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
    <script src="./node_modules/art-template/lib/template-web.js"></script>
</head>
<body>
    <div id="container"></div>
    <script type="text/html" id="tpl">
        <ul>
            {{each user.arr}}
            <li>
                {{$index + 1}} ---- {{$value.type}} ---- {{$value.price}}
                {{$data}}
            </li>
            {{/each}}
        </ul>
    </script>
    <script>
        var user = {
            obj: {
                name: 'Bruce Lee',
                age: 32,
                gender: 'male'
            },
            arr: [
                {type: 1, price: 10},
                {type: 2, price: 12},
                {type: 3, price: 18}
            ] 
        }
        var html = template('tpl', {user: user})
        var container = document.querySelector('#container');
        container.innerHTML = html;
    </script>
</body>
</html>

看輸出結(jié)果:


each遍歷對象target(默認(rèn)為$data).png

圖中可以看出$data其實就是傳入模板的總數(shù)據(jù)對象(原始數(shù)據(jù)對象)

  1. $value$index 可以自定義:{{each target val key}}铅辞。
    具體看下面例子:
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
    <script src="./node_modules/art-template/lib/template-web.js"></script>
</head>
<body>
    <div id="container"></div>
    <script type="text/html" id="tpl">
        <h4>each 遍歷數(shù)組,采用默認(rèn)的索引 $index 和默認(rèn)的值 $value</h4>
        <ul>
            <!-- each 遍歷數(shù)組萨醒,采用默認(rèn)的索引 $index 和默認(rèn)的值 $value -->
            {{each user.arr}}
            <li>
                {{$index}} ---- {{$value}}
            </li>
            {{/each}}
        </ul>

        <h4>each 遍歷數(shù)組, 采用自定義的索引 b 和默認(rèn)的值 a</h4>
        <ul>
            <!-- each 遍歷數(shù)組, 采用自定義的索引 b 和默認(rèn)的值 a -->
            {{each user.arr b a}}
            <li>
                {{a}} ---- {斟珊}
            </li>
            {{/each}}
        </ul>

        <h4>each 遍歷對象, 采用默認(rèn)的鍵 $index 和默認(rèn)的值 $value</h4>
        <ul>
            <!-- each 遍歷對象富纸, 采用默認(rèn)的鍵 $index 和默認(rèn)的值 $value  -->
            {{each user.obj}}
            <li>
                {{$index}} ---- {{$value}}
            </li>
            {{/each}}
        </ul>

        <h4>each 遍歷對象囤踩,采用自定義的鍵 key 和自定義的值 val</h4>
        <ul>
            <!-- each 遍歷對象,采用自定義的鍵 key 和自定義的值 val -->
            {{each user.obj val key}}
            <li>
                {{key}} ---- {{val}}
            </li>
            {{/each}}
        </ul>
    </script>
    <script>
        var user = {
            obj: {
                name: 'Bruce Lee',
                age: 32,
                gender: 'male'
            },
            arr: [
                { type: 1, price: 10 },
                { type: 2, price: 12 },
                { type: 3, price: 18 }
            ]
        }
        var html = template('tpl', { user: user })
        var container = document.querySelector('#container');
        container.innerHTML = html;
    </script>
</body>
</html>

看輸出結(jié)果:


each遍歷數(shù)組和對象以及自定義$data和$index.png

3.5 定義變量

標(biāo)準(zhǔn)語法

{{set temp = data.sub.content}}

原始語法

<% var temp = data.sub.content %>

3.6 模板繼承

標(biāo)準(zhǔn)語法

{{extend './layout.html'}}
{{block 'head'}}
...
{{/block}}

原始語法

<% extend ('./layout.html') %>
<% block('head', function () { %>
...
<% }) %>

模板繼承允許你構(gòu)建一個包含站點共同元素的基本“模板骨架”,實例:

<!--layout.art-->
<!doctype html>
<html>
<head>
    <meta charset="utf-8">
    <title>{{block 'title'}}My Site{{/block}}</title>

    {{block 'head'}}
    <link rel="stylesheet" href="main.css">
    {{/block}}
</head>
<body>
    {{block 'content'}}{{/block}}
</body>
</html>
<!--index.art-->
{{extend './layout.art'}}

{{block 'title'}}{{title}}{{/block}}

{{block 'head'}}
    <link rel="stylesheet" href="custom.css">
{{/block}}

{{block 'content'}}
<p>This is just an awesome page.</p>
{{/block}}

渲染 index.art 后晓褪,將自動應(yīng)用布局骨架堵漱。

3.7 子模板

標(biāo)準(zhǔn)語法

{{include './header.art'}}
{{include './header.art' data}}

原始語法

<% include('./header.art') %>
<% include('./header.art', data) %>

看如下例子:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>art-template-filter</title>
    <!-- 引入 template-web.js -->
    <script src="./node_modules/art-template/lib/template-web.js"></script>
</head>
<body>
    <div class="container"></div>
    <script type="text/html" id="filterTpl">
        <h3>{{date | format 'YYYy-mM-dd' | addQuotationMarks}}</h3>
        <h3><%= $imports.addQuotationMarks($imports.format(date)) %></h3>
    </script>
    <script>
        var data = {
            date: Date.now(),
        }
        // 定義日期格式化過濾器 format 方法:
        template.defaults.imports.format = function (date, format) {
            if (!format || format.toLowerCase() === 'yyyy-mm-dd') {
                var dt = new Date(date);
                var y = dt.getFullYear();
                var m = (dt.getMonth() + 1).toString().padStart(2, '0');
                var d = dt.getDate().toString().padStart(2, '0');
                return `${y}/${m}/$hf11bzr`;
            } else {
                return 'invalid date';
            }
        }
        // 定義給字符串加引號過濾器 addQuotationMarks 方法:
        template.defaults.imports.addQuotationMarks = function (str) {
            return `"${str}"`;
        }
        // 調(diào)用 template 方法,渲染模板和數(shù)據(jù)
        var html = template('filterTpl', data);
        document.querySelector('.container').innerHTML = html;
    </script>
</body>
</html>

注意:

  • {{date | format 'YYYy-mM-dd' | addQuotationMarks}}
    date 默認(rèn)為 format 過濾器(方法)的第一個參數(shù)涣仿, 'YYYy-mM-dd' 才是format 過濾器的第二個參數(shù),date 經(jīng)過 format 過濾器過濾后勤庐,得到的結(jié)果,又作為
    addQuotationMarks 過濾器的默認(rèn)參數(shù)好港,如果有更多的過濾器愉镰,那么就把前一層過濾器過濾的結(jié)果,作為下一個過濾器的參數(shù)一層層過濾下去

4 調(diào)試

template.defaults.debug
art-template 內(nèi)建調(diào)試器媚狰,能夠捕獲到語法與運行錯誤岛杀,并且支持自定義的語法。在 NodeJS 中調(diào)試模式會根據(jù)環(huán)境變量自動開啟:process.env.NODE_ENV !== 'production'
設(shè)置 template.defaults.debug=true 后崭孤,等同于:

{
    "cache": false,
    "minimize": false,
    "compileDebug": true
}

5 模板變量

template.defaults.imports
模板通過 $imports 可以訪問到模板外部的全局變量和導(dǎo)入的變量类嗤。

5.1 導(dǎo)入變量

template.defaults.imports.log = console.log;
<% $imports.log('Hello, template.defaults.imports.log') %>

看下面例子:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>template.defaults.imports</title>
    <script src="./node_modules/art-template/lib/template-web.js"></script>
</head>
<body>
    <div class="container">
    </div>
    <script type="text/html" id="importsTpl">
        <% $imports.log('Hello, template.defaults.imports.log') %>
        <%= $imports.date %>
    </script>
    <script>
        var data = {};
        template.defaults.imports.log = console.log;
        template.defaults.imports.date = new Date();
        template.defaults.debug = true;
        var html = template('importsTpl', data);
        document.querySelector('.container').innerHTML = html;
    </script>
</body>
</html>

注意:

這些語法必須寫在模板中,在模板中才會起作用辨宠;

5.2 內(nèi)置變量清單

  • $data?????傳入模板的數(shù)據(jù);
  • $imports 外部導(dǎo)入的變量以及全局變量遗锣;
  • print ????字符串輸出函數(shù);
  • include ?子模板載入函數(shù)
  • extend ???模板繼承模板導(dǎo)入函數(shù)
  • block ????模板塊生命函數(shù)
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市嗤形,隨后出現(xiàn)的幾起案子精偿,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,036評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件笔咽,死亡現(xiàn)場離奇詭異搔预,居然都是意外死亡,警方通過查閱死者的電腦和手機叶组,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,046評論 3 395
  • 文/潘曉璐 我一進店門拯田,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人甩十,你說我怎么就攤上這事船庇。” “怎么了侣监?”我有些...
    開封第一講書人閱讀 164,411評論 0 354
  • 文/不壞的土叔 我叫張陵鸭轮,是天一觀的道長。 經(jīng)常有香客問我橄霉,道長窃爷,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,622評論 1 293
  • 正文 為了忘掉前任姓蜂,我火速辦了婚禮吞鸭,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘覆糟。我一直安慰自己刻剥,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,661評論 6 392
  • 文/花漫 我一把揭開白布滩字。 她就那樣靜靜地躺著造虏,像睡著了一般。 火紅的嫁衣襯著肌膚如雪麦箍。 梳的紋絲不亂的頭發(fā)上漓藕,一...
    開封第一講書人閱讀 51,521評論 1 304
  • 那天,我揣著相機與錄音挟裂,去河邊找鬼享钞。 笑死,一個胖子當(dāng)著我的面吹牛诀蓉,可吹牛的內(nèi)容都是我干的栗竖。 我是一名探鬼主播,決...
    沈念sama閱讀 40,288評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼渠啤,長吁一口氣:“原來是場噩夢啊……” “哼狐肢!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起沥曹,我...
    開封第一講書人閱讀 39,200評論 0 276
  • 序言:老撾萬榮一對情侶失蹤份名,失蹤者是張志新(化名)和其女友劉穎碟联,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體僵腺,經(jīng)...
    沈念sama閱讀 45,644評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡鲤孵,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,837評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了辰如。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片裤纹。...
    茶點故事閱讀 39,953評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖丧没,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情锡移,我是刑警寧澤呕童,帶...
    沈念sama閱讀 35,673評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站淆珊,受9級特大地震影響夺饲,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜施符,卻給世界環(huán)境...
    茶點故事閱讀 41,281評論 3 329
  • 文/蒙蒙 一往声、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧戳吝,春花似錦浩销、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,889評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至陆盘,卻和暖如春普筹,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背隘马。 一陣腳步聲響...
    開封第一講書人閱讀 33,011評論 1 269
  • 我被黑心中介騙來泰國打工太防, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人酸员。 一個月前我還...
    沈念sama閱讀 48,119評論 3 370
  • 正文 我出身青樓蜒车,卻偏偏與公主長得像,于是被迫代替她去往敵國和親幔嗦。 傳聞我的和親對象是個殘疾皇子醇王,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,901評論 2 355

推薦閱讀更多精彩內(nèi)容