如何使用javascript寫模板引擎程式碼思路和實例詳解

AbsurdJS本身主要是以NodeJS的模組的形式發布的，不過它也會發布客戶端版本。考慮到這些，我就不能直接使用現有的引擎了，因為它們大部分都是在NodeJS上運行的，而不能跑在瀏覽器上。

最初的想法是這樣子的：

var TemplateEngine = function(tpl, data) {
  // magic here ...
}
var template = &#39;<p>Hello, my name is <%name%>. I\&#39;m <%age%> years old.</p>&#39;;
console.log(TemplateEngine(template, {
  name: "Krasimir",
  age: 29
}));

一個簡單的函數，輸入是我們的模板以及資料對象，輸出麼估計你也很容易想到，像下面這樣子：

<p>Hello, my name is Krasimir. I&#39;m 29 years old.</p>

其中第一步要做的是尋找裡面的模板參數，然後替換成傳給引擎的具體資料。我決定使用正規表示式來完成這一步。不過我不是最擅長這個，所以寫的不好的話歡迎隨時來噴。

var re = /<%([^%>]+)?%>/g;

這句正規表示式會捕捉所有以結尾的片段。末尾的參數g（global）表示不只匹配一個，而是匹配所有符合的片段。 Javascript裡面有很多種使用正規表示式的方法，我們需要的是根據正規表示式輸出一個數組，包含所有的字串，這正是exec所做的。

var re = /<%([^%>]+)?%>/g;
var match = re.exec(tpl);

如果我們用console.log把變數match印出來，我們會看見：

##

[
  "<%name%>",
  " name ", 
  index: 21,
  input: 
  "<p>Hello, my name is <%name%>. I\&#39;m <%age%> years old.</p>"
]

不過我們可以看見，傳回的陣列僅包含第一個符合項。我們需要用while循環把上述邏輯包起來，這樣才能得到所有的匹配項。

var re = /<%([^%>]+)?%>/g;
while(match = re.exec(tpl)) {
  console.log(match);
}

如果把上面的程式碼跑一遍，你就會看見 和 都被印出來了。

下面，有意思的部分來了。辨識出模板中的匹配項後，我們要把他們替換成傳遞給函數的實際資料。最簡單的辦法就是使用replace函數。我們可以這樣來寫：

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"]的方式使用了一個簡單物件來傳遞數據，但是實際情況下我們很可能需要更複雜的嵌套物件。所以我們稍微修改了一下data物件：

{
  name: "Krasimir Tsonev",
  profile: { age: 29 }
}

不過直接這樣子寫的話還不能跑，因為在模板中使用的話，程式碼會被替換成data['profile.age']，結果是undefined。這樣我們就不能簡單地用replace函數，而是要用別的方法。如果能夠在之間直接使用Javascript程式碼就最好了，這樣就能對傳入的資料直接求值，像下面這樣：

var template = &#39;<p>Hello, my name is <%this.name%>. I\&#39;m <%this.profile.age%> years old.</p>&#39;;

你可能會好奇，這是怎麼實現的？這裡John使用了new Function的語法，根據字串建立一個函數。我們不妨來看個例子：

var fn = new Function("arg", "console.log(arg + 1);");
fn(2); // outputs 3

fn可是一個貨真價實的函數。它接受一個參數，函數體是console.log(arg + 1);。上述程式碼等價於下面的程式碼：

var fn = function(arg) {
  console.log(arg + 1);
}
fn(2); // outputs 3

透過這個方法，我們可以根據字串建構函數，包括它的參數和函數體。這不正是我們想要的嘛！不過先別急，在建構函數之前，我們先來看看函數體是什麼樣子的。按照之前的想法，這個模板引擎最終回傳的應該是一個編譯好的模板。還是用先前的模板字串作為例子，那麼傳回的內容應該類似於：

return
"<p>Hello, my name is " + 
this.name + 
". I\&#39;m " + 
this.profile.age + 
" years old.</p>";

　　當然啦，實際的模板引擎中，我們會把模板切分為小段的文字和有意義的Javascript程式碼。前面你可能看見我使用簡單的字串拼接來達到想要的效果，不過這並不是100%符合我們要求的做法。由於使用者很可能會傳遞更複雜的Javascript程式碼，所以我們這兒需要再來一個循環，如下：

var template = 
'My skills:' + 
&#39;<%for(var index in this.skills) {%>&#39; + 
&#39;<a href=""><%this.skills[index]%></a>&#39; +
&#39;<%}%>&#39;;

　　如果使用字串拼接的話，程式碼就應該是下面的樣子：

return
'My skills:' + 
for(var index in this.skills) { +
&#39;<a href="">&#39; + 
this.skills[index] +
&#39;</a>&#39; +
}

　　當然，這個程式碼不能直接跑，跑了會出錯。於是我用了John的文章裡寫的邏輯，把所有的字串放在陣列裡，在程式的最後把它們拼接起來。

var r = [];
r.push('My skills:'); 
for(var index in this.skills) {
r.push(&#39;<a href="">&#39;);
r.push(this.skills[index]);
r.push(&#39;</a>&#39;);
}
return r.join(&#39;&#39;);

　　下一步就是收集模板裡面不同的程式碼行，用來產生函數。透過前面介紹的方法，我們可以知道模板中有哪些佔位符（譯者註：或者說正規表示式的匹配項）以及它們的位置。所以，依靠一個輔助變數（cursor，遊標），我們就能得到想要的結果。

#

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 = &#39;<p>Hello, my name is <%this.name%>. I\&#39;m <%this.profile.age%> years old.</p>&#39;;
console.log(TemplateEngine(template, {
  name: "Krasimir Tsonev",
  profile: { age: 29 }
}));

　　上述代码中的变量code保存了函数体。开头的部分定义了一个数组。游标cursor告诉我们当前解析到了模板中的哪个位置。我们需要依靠它来遍历整个模板字符串。此外还有个函数add，它负责把解析出来的代码行添加到变量code中去。有一个地方需要特别注意，那就是需要把code包含的双引号字符进行转义（escape）。否则生成的函数代码会出错。如果我们运行上面的代码，我们会在控制台里面看见如下的内容：

var r=[];
r.push("<p>Hello, my name is ");
r.push("this.name");
r.push(". I&#39;m ");
r.push("this.profile.age");
return r.join("");

　　等等，貌似不太对啊，this.name和this.profile.age不应该有引号啊，再来改改。

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

　　占位符的内容和一个布尔值一起作为参数传给add函数，用作区分。这样就能生成我们想要的函数体了。

var r=[];
r.push("<p>Hello, my name is ");
r.push(this.name);
r.push(". I&#39;m ");
r.push(this.profile.age);
return r.join("");

　　剩下来要做的就是创建函数并且执行它。因此，在模板引擎的最后，把原本返回模板字符串的语句替换成如下的内容：

return new Function(code.replace(/[\r\t\n]/g, '')).apply(data);

　　我们甚至不需要显式地传参数给这个函数。我们使用apply方法来调用它。它会自动设定函数执行的上下文。这就是为什么我们能在函数里面使用this.name。这里this指向data对象。

　　模板引擎接近完成了，不过还有一点，我们需要支持更多复杂的语句，比如条件判断和循环。我们接着上面的例子继续写。

var template = 
'My skills:' + 
&#39;<%for(var index in this.skills) {%>&#39; + 
&#39;<a href="#"><%this.skills[index]%></a>&#39; +
&#39;<%}%>&#39;;
console.log(TemplateEngine(template, {
  skills: ["js", "html", "css"]
}));

　　这里会产生一个异常，Uncaught SyntaxError: Unexpected token for。如果我们调试一下，把code变量打印出来，我们就能发现问题所在。

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循环的那一行不应该被直接放到数组里面，而是应该作为脚本的一部分直接运行。所以我们在把内容添加到code变量之前还要多做一个判断。

var re = /<%([^%>]+)?%>/g,
  reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g,
  code = &#39;var r=[];\n&#39;,
  cursor = 0;
var add = function(line, js) {
  js? code += line.match(reExp) ? line + &#39;\n&#39; : &#39;r.push(&#39; + line + &#39;);\n&#39; :
    code += &#39;r.push("&#39; + line.replace(/"/g, &#39;\\"&#39;) + &#39;");\n&#39;;
}

　　这里我们新增加了一个正则表达式。它会判断代码中是否包含if、for、else等等关键字。如果有的话就直接添加到脚本代码中去，否则就添加到数组中去。运行结果如下：

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

　　当然，编译出来的结果也是对的。

My skills:<a href="#">js</a><a href="#">html</a><a href="#">css</a>

　　最后一个改进可以使我们的模板引擎更为强大。我们可以直接在模板中使用复杂逻辑，例如：

var template = 
'My skills:' + 
&#39;<%if(this.showSkills) {%>&#39; +
  &#39;<%for(var index in this.skills) {%>&#39; + 
  &#39;<a href="#"><%this.skills[index]%></a>&#39; +
  &#39;<%}%>&#39; +
&#39;<%} else {%>&#39; +
  &#39;<p>none</p>&#39; +
&#39;<%}%>&#39;;
console.log(TemplateEngine(template, {
  skills: ["js", "html", "css"],
  showSkills: true
}));

　　除了上面说的改进，我还对代码本身做了些优化，最终版本如下：

var TemplateEngine = function(html, options) {
  var re = /<%([^%>]+)?%>/g, reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g, code = &#39;var r=[];\n&#39;, cursor = 0;
  var add = function(line, js) {
    js? (code += line.match(reExp) ? line + &#39;\n&#39; : &#39;r.push(&#39; + line + &#39;);\n&#39;) :
      (code += line != &#39;&#39; ? &#39;r.push("&#39; + line.replace(/"/g, &#39;\\"&#39;) + &#39;");\n&#39; : &#39;&#39;);
    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 += &#39;return r.join("");&#39;;
  return new Function(code.replace(/[\r\t\n]/g, &#39;&#39;)).apply(options);
}

以上是如何使用javascript寫模板引擎程式碼思路和實例詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章！