javascript_javascript スキルを使用してページテンプレートエンジンを簡単に作成する方法を説明します-jsチュートリアル-php.cn

そこで、このテンプレートエンジンを改善し、他の既存のロジックと連携するための簡単なコードを作成できないか考えました。 AbsurdJS自体は主にNodeJS用のモジュールとしてリリースされていますが、クライアント版もリリースされています。これを念頭に置くと、既存のエンジンのほとんどは NodeJS 上で実行され、ブラウザ上では実行できないため、既存のエンジンを直接使用することはできません。私が必要としているのは、純粋に Javascript で書かれた、ブラウザーで直接実行できる小さなものです。ある日、John Resig によるこのブログを偶然見つけたとき、これがまさに私が探していたものであることに気づき、嬉しい驚きを感じました。若干の修正を加えましたが、コード行数は約 20 行です。ロジックは非常に興味深いです。この記事では、このエンジンを作成するプロセスをステップごとに再現します。読み進めていただければ、John のアイデアがいかに鋭いかが理解できるでしょう。

私の最初の考えは次のとおりです:

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

ログイン後にコピー

単純な関数です。入力はテンプレートとデータオブジェクトです。出力は次のように考えるのが簡単でしょう:

こんにちは、私の名前はクラシミールです。

最初のステップは、内部のテンプレートパラメーターを見つけて、エンジンに渡される特定のデータで置き換えることです。このステップを実行するには正規表現を使用することにしました。ただし、私はこれが得意ではないので、文章が良くない場合は遠慮なくコメントしてください。

var re = /<%([^%>]+)&#63;%>/g;

ログイン後にコピー

この正規表現は、<% で始まり %> で終わるすべてのフラグメントをキャプチャします。最後のパラメータ g (global) は、1 つだけが一致するのではなく、一致するすべてのフラグメントが一致することを意味します。 Javascript では正規表現を使用する方法がたくさんあります。必要なのは、正規表現に基づいてすべての文字列を含む配列を出力することです。これがまさに exec の機能です。

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

ログイン後にコピー

console.log を使用して変数の一致を出力すると、次のように表示されます:

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

ログイン後にコピー

しかし、返された配列には最初に一致したものだけが含まれていることがわかります。すべての一致を取得できるように、上記のロジックを while ループでラップする必要があります。

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

ログイン後にコピー

上記のコードを実行すると、<%name%> と <%age%> の両方が出力されることがわかります。

ここからが興味深い部分です。テンプレート内の一致を特定したら、それらを関数に渡される実際のデータに置き換える必要があります。最も簡単な方法は、replace 関数を使用することです。次のように書くことができます:

var TemplateEngine = function(tpl, data) {
  var re = /<%([^%>]+)&#63;%>/g;
  while(match = re.exec(tpl)) {
    tpl = tpl.replace(match[0], data[match[1]])
  }
  return tpl;
}

ログイン後にコピー

はい、走れますが、十分ではありません。ここでは単純なオブジェクトを使用して data["property"] の形式でデータを渡しますが、実際の状況では、より複雑なネストされたオブジェクトが必要になる可能性があります。そこで、データオブジェクトを少し変更しました。

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

ログイン後にコピー

ただし、このように直接書いても実行されません。テンプレート内で <%profile.age%> を使用すると、コードが data['profile.age'] に置き換えられるためです。結果は未定義になります。このように、単純に replace 関数を使用することはできず、他の方法を使用する必要があります。次のように、JavaScript コードを <% と %> の間で直接使用して、受信データを直接評価できるようにするのが最善です:

コードをコピーしますコードは次のとおりです:

var template = '

こんにちは、私の名前は<%this.name%>です。<%this.profile.age%>';

気になるかもしれませんが、これはどのようにして実現されるのでしょうか?ここで、John は新しい Function 構文を使用して、文字列に基づいた関数を作成します。例を見てみましょう:

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

ログイン後にコピー

fnは純正の関数です。パラメータを 1 つ受け取り、関数本体は 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\'m " + 
this.profile.age + 
" years old.</p>";

ログイン後にコピー

もちろん、実際のテンプレートエンジンでは、テンプレートを小さなテキストと意味のある Javascript コードに分割します。これまでに、目的の効果を達成するために単純な文字列の連結を使用しているのを見たかもしれませんが、これは要件を 100% 満たしているわけではありません。ユーザーはより複雑な Javascript コードを渡す可能性が高いため、ここでは次のように別のループが必要です:

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

ログイン後にコピー

　　如果使用字符串拼接的话，代码就应该是下面的样子：

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

ログイン後にコピー

　　当然，这个代码不能直接跑，跑了会出错。于是我用了John的文章里写的逻辑，把所有的字符串放在一个数组里，在程序的最后把它们拼接起来。

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

ログイン後にコピー

　　下一步就是收集模板里面不同的代码行，用于生成函数。通过前面介绍的方法，我们可以知道模板中有哪些占位符（译者注：或者说正则表达式的匹配项）以及它们的位置。所以，依靠一个辅助变量（cursor，游标），我们就能得到想要的结果。

var TemplateEngine = function(tpl, data) {
  var re = /<%([^%>]+)&#63;%>/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保存了函数体。开头的部分定义了一个数组。游标cursor告诉我们当前解析到了模板中的哪个位置。我们需要依靠它来遍历整个模板字符串。此外还有个函数add，它负责把解析出来的代码行添加到变量code中去。有一个地方需要特别注意，那就是需要把code包含的双引号字符进行转义（escape）。否则生成的函数代码会出错。如果我们运行上面的代码，我们会在控制台里面看见如下的内容：

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

ログイン後にコピー

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

var add = function(line, js) {
  js&#63; 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'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:' + 
'<%for(var index in this.skills) {%>' + 
'<a href="#"><%this.skills[index]%></a>' +
'<%}%>';
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 = /<%([^%>]+)&#63;%>/g,
  reExp = /(^( )&#63;(if|for|else|switch|case|break|{|}))(.*)&#63;/g,
  code = 'var r=[];\n',
  cursor = 0;
var add = function(line, js) {
  js&#63; code += line.match(reExp) &#63; line + '\n' : 'r.push(' + line + ');\n' :
    code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n';
}

ログイン後にコピー

　　这里我们新增加了一个正则表达式。它会判断代码中是否包含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:js html css

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

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

ログイン後にコピー

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

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

ログイン後にコピー

　　代码比我预想的还要少，只有区区15行！