So verwenden Sie Javascript, um Ideen und detaillierte Beispiele für Template-Engine-Code zu schreiben

AbsurdJS selbst wird hauptsächlich als Modul für NodeJS veröffentlicht, es wird jedoch auch eine Client-Version veröffentlichen. Vor diesem Hintergrund kann ich bestehende Engines nicht direkt verwenden, da die meisten davon auf NodeJS laufen und nicht im Browser laufen können.

Die ursprüngliche Idee ist wie folgt:

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

Eine einfache Funktion, die Eingabe ist unsere Vorlage und unser Datenobjekt. Ich denke, Sie können sich die Ausgabe leicht wie folgt vorstellen:

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

Der erste Schritt besteht darin, die darin enthaltenen Vorlagenparameter zu finden und sie dann durch die spezifischen Daten zu ersetzen, die an die Engine übergeben werden. Ich habe beschlossen, reguläre Ausdrücke zu verwenden, um diesen Schritt auszuführen. Aber darin bin ich nicht der Beste, also kommentieren Sie gerne, wenn Ihr Text nicht gut ist.

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

Dieser reguläre Ausdruck erfasst alle Fragmente, die mit <% beginnen und mit %> enden. Der Parameter g (global) am Ende bedeutet, dass nicht nur eines übereinstimmt, sondern alle übereinstimmenden Fragmente übereinstimmen. Es gibt viele Möglichkeiten, reguläre Ausdrücke in Javascript zu verwenden. Wir müssen ein Array ausgeben, das alle auf dem regulären Ausdruck basierenden Zeichenfolgen enthält.

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

Wenn wir console.log verwenden, um die Variablenübereinstimmung auszudrucken, sehen wir:

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

Aber wir können sehen, dass das zurückgegebene Array nur die erste Übereinstimmung enthält. Wir müssen die obige Logik mit einer While-Schleife umschließen, damit wir alle Übereinstimmungen erhalten.

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

Wenn Sie den obigen Code ausführen, werden Sie sehen, dass <%name%> beide ausgedruckt werden.

Jetzt kommt der interessante Teil. Nachdem wir die Übereinstimmungen in der Vorlage identifiziert haben, müssen wir sie durch die tatsächlichen Daten ersetzen, die an die Funktion übergeben wurden. Der einfachste Weg ist die Verwendung der Ersetzungsfunktion. Wir könnten es so schreiben:

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

Okay, es läuft also, aber es ist nicht gut genug. Hier verwenden wir ein einfaches Objekt, um Daten in Form von Daten[„Eigenschaft“] zu übergeben, aber in tatsächlichen Situationen benötigen wir wahrscheinlich komplexere verschachtelte Objekte. Also haben wir das Datenobjekt leicht geändert:

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

Wenn wir es jedoch direkt so schreiben, wird es immer noch nicht ausgeführt, weil <%profile.age% > wird in der Vorlage ; verwendet, der Code wird durch data['profile.age'] ersetzt und das Ergebnis ist undefiniert. Auf diese Weise können wir nicht einfach die Ersetzungsfunktion verwenden, sondern müssen andere Methoden verwenden. Am besten wäre es, wenn Sie Javascript-Code direkt zwischen <% und %> verwenden könnten, damit die eingehenden Daten direkt ausgewertet werden können, wie folgt:

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

Vielleicht sind Sie neugierig, wie es ist das erreicht? Hier verwendet John die neue Funktionssyntax, um eine Funktion basierend auf einer Zeichenfolge zu erstellen. Schauen wir uns ein Beispiel an:

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

fn ist eine echte Funktion. Es akzeptiert einen Parameter und der Funktionskörper ist console.log(arg + 1);. Der obige Code entspricht dem folgenden Code:

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

Mit dieser Methode können wir eine Funktion aus einer Zeichenfolge einschließlich ihrer Parameter und des Funktionskörpers erstellen. Ist das nicht genau das, was wir wollen! Aber keine Sorge, bevor wir die Funktion konstruieren, werfen wir einen Blick darauf, wie der Funktionskörper aussieht. Gemäß der vorherigen Idee sollte die endgültige Rückgabe dieser Vorlagen-Engine eine kompilierte Vorlage sein. Wenn wir immer noch die vorherige Vorlagenzeichenfolge als Beispiel verwenden, sollte der zurückgegebene Inhalt etwa so aussehen:

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

Natürlich werden wir in der eigentlichen Vorlagen-Engine die Vorlage ausschneiden Aufgeteilt in kleine Textstücke und aussagekräftigen Javascript-Code. Sie haben vielleicht schon gesehen, dass ich eine einfache String-Verkettung verwendet habe, um den gewünschten Effekt zu erzielen, aber das entspricht nicht zu 100 % unseren Anforderungen. Da der Benutzer wahrscheinlich komplexeren Javascript-Code übergibt, benötigen wir hier eine weitere Schleife wie folgt:

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

Wenn String-Verkettung verwendet wird, der Code sollte wie folgt aussehen:

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

Natürlich kann dieser Code nicht direkt ausgeführt werden, da sonst ein Fehler auftritt. Also habe ich die in Johns Artikel geschriebene Logik verwendet, alle Zeichenfolgen in ein Array eingefügt und sie am Ende des Programms zusammengefügt.

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

Der nächste Schritt besteht darin, verschiedene Codezeilen in der Vorlage zu sammeln, um Funktionen zu generieren. Durch die zuvor vorgestellte Methode können wir erkennen, welche Platzhalter (Anmerkung des Übersetzers: oder Übereinstimmungen mit regulären Ausdrücken) in der Vorlage vorhanden sind und welche Positionen sie haben. Wenn wir uns daher auf eine Hilfsvariable (Cursor, Cursor) verlassen, können wir die gewünschten Ergebnisse erzielen.

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

Das obige ist der detaillierte Inhalt vonSo verwenden Sie Javascript, um Ideen und detaillierte Beispiele für Template-Engine-Code zu schreiben. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!