教你使用javascript簡(jiǎn)單寫一個(gè)頁(yè)面模板引擎
于是我又想著能不能寫一些簡(jiǎn)單的代碼來(lái)完善這個(gè)模板引擎,又能與其它現(xiàn)有的邏輯協(xié)同工作。AbsurdJS本身主要是以NodeJS的模塊的形式發(fā)布的,不過(guò)它也會(huì)發(fā)布客戶端版本。考慮到這些,我就不能直接使用現(xiàn)有的引擎了,因?yàn)樗鼈兇蟛糠侄际窃贜odeJS上運(yùn)行的,而不能跑在瀏覽器上。我需要的是一個(gè)小巧的,純粹以Javascript編寫的東西,能夠直接運(yùn)行在瀏覽器上。當(dāng)我某天偶然發(fā)現(xiàn)John Resig的這篇博客,我驚喜地發(fā)現(xiàn),這不正是我苦苦尋找的東西嘛!我稍稍做了一些修改,代碼行數(shù)差不多20行左右。其中的邏輯非常有意思。在這篇文章中我會(huì)一步一步重現(xiàn)編寫這個(gè)引擎的過(guò)程,如果你能一路看下去的話,你就會(huì)明白John的這個(gè)想法是多么犀利!
最初我的想法是這樣子的:
var TemplateEngine = function(tpl, data) { // magic here ... } var template = '<p>Hello, my name is <%name%>. I\'m <%age%> years old.</p>'; console.log(TemplateEngine(template, { name: "Krasimir", age: 29 }));
一個(gè)簡(jiǎn)單的函數(shù),輸入是我們的模板以及數(shù)據(jù)對(duì)象,輸出么估計(jì)你也很容易想到,像下面這樣子:
<p>Hello, my name is Krasimir. I'm 29 years old.</p>
其中第一步要做的是尋找里面的模板參數(shù),然后替換成傳給引擎的具體數(shù)據(jù)。我決定使用正則表達(dá)式來(lái)完成這一步。不過(guò)我不是最擅長(zhǎng)這個(gè),所以寫的不好的話歡迎隨時(shí)來(lái)噴。
var re = /<%([^%>]+)?%>/g;
這句正則表達(dá)式會(huì)捕獲所有以<%開(kāi)頭,以%>結(jié)尾的片段。末尾的參數(shù)g(global)表示不只匹配一個(gè),而是匹配所有符合的片段。Javascript里面有很多種使用正則表達(dá)式的方法,我們需要的是根據(jù)正則表達(dá)式輸出一個(gè)數(shù)組,包含所有的字符串,這正是exec所做的。
var re = /<%([^%>]+)?%>/g; var match = re.exec(tpl);
如果我們用console.log把變量match打印出來(lái),我們會(huì)看見(jiàn):
[ "<%name%>", " name ", index: 21, input: "<p>Hello, my name is <%name%>. I\'m <%age%> years old.</p>" ]
不過(guò)我們可以看見(jiàn),返回的數(shù)組僅僅包含第一個(gè)匹配項(xiàng)。我們需要用while循環(huán)把上述邏輯包起來(lái),這樣才能得到所有的匹配項(xiàng)。
var re = /<%([^%>]+)?%>/g; while(match = re.exec(tpl)) { console.log(match); }
如果把上面的代碼跑一遍,你就會(huì)看見(jiàn)<%name%> 和 <%age%>都被打印出來(lái)了。
下面,有意思的部分來(lái)了。識(shí)別出模板中的匹配項(xiàng)后,我們要把他們替換成傳遞給函數(shù)的實(shí)際數(shù)據(jù)。最簡(jiǎn)單的辦法就是使用replace函數(shù)。我們可以像這樣來(lái)寫:
var TemplateEngine = function(tpl, data) { var re = /<%([^%>]+)?%>/g; while(match = re.exec(tpl)) { tpl = tpl.replace(match[0], data[match[1]]) } return tpl; }
好了,這樣就能跑了,但是還不夠好。這里我們以data["property"]的方式使用了一個(gè)簡(jiǎn)單對(duì)象來(lái)傳遞數(shù)據(jù),但是實(shí)際情況下我們很可能需要更復(fù)雜的嵌套對(duì)象。所以我們稍微修改了一下data對(duì)象:
{ name: "Krasimir Tsonev", profile: { age: 29 } }
不過(guò)直接這樣子寫的話還不能跑,因?yàn)樵谀0逯惺褂?lt;%profile.age%>的話,代碼會(huì)被替換成data[‘profile.age'],結(jié)果是undefined。這樣我們就不能簡(jiǎn)單地用replace函數(shù),而是要用別的方法。如果能夠在<%和%>之間直接使用Javascript代碼就最好了,這樣就能對(duì)傳入的數(shù)據(jù)直接求值,像下面這樣:
var template = '<p>Hello, my name is <%this.name%>. I\'m <%this.profile.age%> years old.</p>';
你可能會(huì)好奇,這是怎么實(shí)現(xiàn)的?這里John使用了new Function的語(yǔ)法,根據(jù)字符串創(chuàng)建一個(gè)函數(shù)。我們不妨來(lái)看個(gè)例子:
var fn = new Function("arg", "console.log(arg + 1);"); fn(2); // outputs 3
fn可是一個(gè)貨真價(jià)實(shí)的函數(shù)。它接受一個(gè)參數(shù),函數(shù)體是console.log(arg + 1);。上述代碼等價(jià)于下面的代碼:
var fn = function(arg) { console.log(arg + 1); } fn(2); // outputs 3
通過(guò)這種方法,我們可以根據(jù)字符串構(gòu)造函數(shù),包括它的參數(shù)和函數(shù)體。這不正是我們想要的嘛!不過(guò)先別急,在構(gòu)造函數(shù)之前,我們先來(lái)看看函數(shù)體是什么樣子的。按照之前的想法,這個(gè)模板引擎最終返回的應(yīng)該是一個(gè)編譯好的模板。還是用之前的模板字符串作為例子,那么返回的內(nèi)容應(yīng)該類似于:
return "<p>Hello, my name is " + this.name + ". I\'m " + this.profile.age + " years old.</p>";
當(dāng)然啦,實(shí)際的模板引擎中,我們會(huì)把模板切分為小段的文本和有意義的Javascript代碼。前面你可能看見(jiàn)我使用簡(jiǎn)單的字符串拼接來(lái)達(dá)到想要的效果,不過(guò)這并不是100%符合我們要求的做法。由于使用者很可能會(huì)傳遞更加復(fù)雜的Javascript代碼,所以我們這兒需要再來(lái)一個(gè)循環(huán),如下:
var template = 'My skills:' + '<%for(var index in this.skills) {%>' + '<a href=""><%this.skills[index]%></a>' + '<%}%>';
如果使用字符串拼接的話,代碼就應(yīng)該是下面的樣子:
return 'My skills:' + for(var index in this.skills) { + '<a href="">' + this.skills[index] + '</a>' + }
當(dāng)然,這個(gè)代碼不能直接跑,跑了會(huì)出錯(cuò)。于是我用了John的文章里寫的邏輯,把所有的字符串放在一個(gè)數(shù)組里,在程序的最后把它們拼接起來(lái)。
var r = []; r.push('My skills:'); for(var index in this.skills) { r.push('<a href="">'); r.push(this.skills[index]); r.push('</a>'); } return r.join('');
下一步就是收集模板里面不同的代碼行,用于生成函數(shù)。通過(guò)前面介紹的方法,我們可以知道模板中有哪些占位符(譯者注:或者說(shuō)正則表達(dá)式的匹配項(xiàng))以及它們的位置。所以,依靠一個(gè)輔助變量(cursor,游標(biāo)),我們就能得到想要的結(jié)果。
var TemplateEngine = function(tpl, data) { var re = /<%([^%>]+)?%>/g, code = 'var r=[];\n', cursor = 0; var add = function(line) { code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n'; } while(match = re.exec(tpl)) { add(tpl.slice(cursor, match.index)); add(match[1]); cursor = match.index + match[0].length; } add(tpl.substr(cursor, tpl.length - cursor)); code += 'return r.join("");'; // <-- return the result console.log(code); return tpl; } var template = '<p>Hello, my name is <%this.name%>. I\'m <%this.profile.age%> years old.</p>'; console.log(TemplateEngine(template, { name: "Krasimir Tsonev", profile: { age: 29 } }));
上述代碼中的變量code保存了函數(shù)體。開(kāi)頭的部分定義了一個(gè)數(shù)組。游標(biāo)cursor告訴我們當(dāng)前解析到了模板中的哪個(gè)位置。我們需要依靠它來(lái)遍歷整個(gè)模板字符串。此外還有個(gè)函數(shù)add,它負(fù)責(zé)把解析出來(lái)的代碼行添加到變量code中去。有一個(gè)地方需要特別注意,那就是需要把code包含的雙引號(hào)字符進(jìn)行轉(zhuǎn)義(escape)。否則生成的函數(shù)代碼會(huì)出錯(cuò)。如果我們運(yùn)行上面的代碼,我們會(huì)在控制臺(tái)里面看見(jiàn)如下的內(nèi)容:
var r=[]; r.push("<p>Hello, my name is "); r.push("this.name"); r.push(". I'm "); r.push("this.profile.age"); return r.join("");
等等,貌似不太對(duì)啊,this.name和this.profile.age不應(yīng)該有引號(hào)啊,再來(lái)改改。
var add = function(line, js) { js? code += 'r.push(' + line + ');\n' : code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n'; } while(match = re.exec(tpl)) { add(tpl.slice(cursor, match.index)); add(match[1], true); // <-- say that this is actually valid js cursor = match.index + match[0].length; }
占位符的內(nèi)容和一個(gè)布爾值一起作為參數(shù)傳給add函數(shù),用作區(qū)分。這樣就能生成我們想要的函數(shù)體了。
var r=[]; r.push("<p>Hello, my name is "); r.push(this.name); r.push(". I'm "); r.push(this.profile.age); return r.join("");
剩下來(lái)要做的就是創(chuàng)建函數(shù)并且執(zhí)行它。因此,在模板引擎的最后,把原本返回模板字符串的語(yǔ)句替換成如下的內(nèi)容:
我們甚至不需要顯式地傳參數(shù)給這個(gè)函數(shù)。我們使用apply方法來(lái)調(diào)用它。它會(huì)自動(dòng)設(shè)定函數(shù)執(zhí)行的上下文。這就是為什么我們能在函數(shù)里面使用this.name。這里this指向data對(duì)象。
模板引擎接近完成了,不過(guò)還有一點(diǎn),我們需要支持更多復(fù)雜的語(yǔ)句,比如條件判斷和循環(huán)。我們接著上面的例子繼續(xù)寫。
var template = 'My skills:' + '<%for(var index in this.skills) {%>' + '<a href="#"><%this.skills[index]%></a>' + '<%}%>'; console.log(TemplateEngine(template, { skills: ["js", "html", "css"] }));
這里會(huì)產(chǎn)生一個(gè)異常,Uncaught SyntaxError: Unexpected token for。如果我們調(diào)試一下,把code變量打印出來(lái),我們就能發(fā)現(xiàn)問(wèn)題所在。
var r=[]; r.push("My skills:"); r.push(for(var index in this.skills) {); r.push("<a href=\"\">"); r.push(this.skills[index]); r.push("</a>"); r.push(}); r.push(""); return r.join("");
帶有for循環(huán)的那一行不應(yīng)該被直接放到數(shù)組里面,而是應(yīng)該作為腳本的一部分直接運(yùn)行。所以我們?cè)诎褍?nèi)容添加到code變量之前還要多做一個(gè)判斷。
var re = /<%([^%>]+)?%>/g, reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g, code = 'var r=[];\n', cursor = 0; var add = function(line, js) { js? code += line.match(reExp) ? line + '\n' : 'r.push(' + line + ');\n' : code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n'; }
這里我們新增加了一個(gè)正則表達(dá)式。它會(huì)判斷代碼中是否包含if、for、else等等關(guān)鍵字。如果有的話就直接添加到腳本代碼中去,否則就添加到數(shù)組中去。運(yùn)行結(jié)果如下:
var r=[]; r.push("My skills:"); for(var index in this.skills) { r.push("<a href=\"#\">"); r.push(this.skills[index]); r.push("</a>"); } r.push(""); return r.join("");
當(dāng)然,編譯出來(lái)的結(jié)果也是對(duì)的。
My skills:<a href="#">js</a><a href="#">html</a><a href="#">css</a>
最后一個(gè)改進(jìn)可以使我們的模板引擎更為強(qiáng)大。我們可以直接在模板中使用復(fù)雜邏輯,例如:
var template = 'My skills:' + '<%if(this.showSkills) {%>' + '<%for(var index in this.skills) {%>' + '<a href="#"><%this.skills[index]%></a>' + '<%}%>' + '<%} else {%>' + '<p>none</p>' + '<%}%>'; console.log(TemplateEngine(template, { skills: ["js", "html", "css"], showSkills: true }));
除了上面說(shuō)的改進(jìn),我還對(duì)代碼本身做了些優(yōu)化,最終版本如下:
var TemplateEngine = function(html, options) { var re = /<%([^%>]+)?%>/g, reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g, code = 'var r=[];\n', cursor = 0; var add = function(line, js) { js? (code += line.match(reExp) ? line + '\n' : 'r.push(' + line + ');\n') : (code += line != '' ? 'r.push("' + line.replace(/"/g, '\\"') + '");\n' : ''); return add; } while(match = re.exec(html)) { add(html.slice(cursor, match.index))(match[1], true); cursor = match.index + match[0].length; } add(html.substr(cursor, html.length - cursor)); code += 'return r.join("");'; return new Function(code.replace(/[\r\t\n]/g, '')).apply(options); }
代碼比我預(yù)想的還要少,只有區(qū)區(qū)15行!
相關(guān)文章
利用javascript如何隨機(jī)生成一定位數(shù)的密碼
這篇文章主要給大家介紹了關(guān)于利用javascript如何隨機(jī)生成一定位數(shù)的密碼的相關(guān)資料,文中給出了詳細(xì)的示例代碼,對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧。2017-09-09使用Promise解決多層異步調(diào)用的簡(jiǎn)單學(xué)習(xí)心得
下面小編就為大家?guī)?lái)一篇使用Promise解決多層異步調(diào)用的簡(jiǎn)單學(xué)習(xí)心得。小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2016-05-05javascript Array對(duì)象基礎(chǔ)知識(shí)小結(jié)
感覺(jué)自己對(duì)Array對(duì)象總是有種朦朧的感覺(jué),今天自己手寫總結(jié),加深一下印象。2010-11-11JavaScript中實(shí)現(xiàn)跨標(biāo)簽頁(yè)通信的方法詳解
跨標(biāo)簽頁(yè)通信是指在瀏覽器中的不同標(biāo)簽頁(yè)之間進(jìn)行數(shù)據(jù)傳遞和通信的過(guò)程,這篇文章為大家介紹了一下常見(jiàn)的跨標(biāo)簽頁(yè)通信方式,感興趣的小伙伴可以了解下2023-11-11微信小程序?qū)崿F(xiàn)登錄注冊(cè)tab切換效果
這篇文章主要為大家詳細(xì)介紹了微信小程序?qū)崿F(xiàn)登錄注冊(cè)切換效果,簡(jiǎn)易版tab切換效果,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-11-11js 打開(kāi)新頁(yè)面在屏幕中間的實(shí)現(xiàn)方法
下面小編就為大家?guī)?lái)一篇js 打開(kāi)新頁(yè)面在屏幕中間的實(shí)現(xiàn)方法。小編覺(jué)得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2016-11-11JS實(shí)現(xiàn)網(wǎng)頁(yè)右側(cè)帶動(dòng)畫效果的伸縮窗口代碼
這篇文章主要介紹了JS實(shí)現(xiàn)網(wǎng)頁(yè)右側(cè)帶動(dòng)畫效果的伸縮窗口代碼,通過(guò)JavaScript基于時(shí)間函數(shù)實(shí)現(xiàn)頁(yè)面元素樣式漸變效果,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-10-10