前端模板的原理與實現

時間 2019-12-09

標籤前端模板原理實現简体版

原文原文鏈接

時下流行什麼react, avalon, angular, vue什麼，其核心都離不開前端模板。理解前端模板，是咱們瞭解MV* 的關鍵。php

前端框架最重要的目的是將頁面渲染出來。「渲染」（render）這個詞最初不是前端的東西的。前端以前叫作切圖，將設計師作的PSD變成一個靜態頁面，而後加上動態交互。可是咱們有許多數據是來自後端，如何將數據加入靜態頁面呢？因而又多了一套工序叫「套頁面」。套頁面的過程實際就是將靜態頁面變成切割成一塊塊，每一塊都是一個php，jsp或vm文件，它們是後端模板引擎的處理對象！html

其實模板是不侷限於後端仍是前端的，模板的本質是用於從數據（變量）到實際的視覺表現（HTML代碼）這項工做的一種實現手段。因爲後端近水樓臺先得月（取數據比較方便），所以先在後端發展出這種技術。這些後端模板文件是活動於服務器的，而後通過複雜的處理，最後由瀏覽器渲染出來。這時的渲染是將服務器拼接好的靜態文本變成一個DOM樹的過程。前端

若是要實現前端實現MVC或MVP，那些工序必須發生改變。靜態文件產出是不變，尤爲是大公司，分工夠細，有專門的切圖組（大多數是妹子）將它們作出來。接着是套頁面，這時就不能使用後端模板引擎，須要引入前端模板引擎。因爲實現一個前端模板引擎太簡單了，通過多年的發展，已經有衆多好用的輪子：vue

https://github.com/janl/musta...
基於JavaScript的Logic-less（無邏輯或輕邏輯）模板。react

https://github.com/twitter/ho...
上面的優化版，twitter出品git

https://github.com/wycats/han...
徹底兼容mustcache的語法github

https://github.com/paularmstr...
擁有更強悍的模板繼承與block 重寫功能django

https://github.com/mozilla/nu...
跟django的模板系統類似，能夠說swig的升級版，是gitbook的御用前端模板編程

其它推薦的還有ejs，易學易用，對有過ASP/PHP/JSP編程經驗的人來講，很是親切天然，缺點就是功能有點簡單。segmentfault

其餘doT, xtempalate， Underscore Templates。

最不推薦是jade，有點華而不實，過分設計，致使套頁面工做量大，性能其差。

虛擬DOM時代流行的jsx就是無邏輯模板。之因此流行無邏輯或輕邏輯模板，其主要緣由是改動成本比較少，像jade這樣自造語法糖太多，從美工手中拿來的html須要大動干戈，進行摧心折骨般的改造才能套數據。對於模板來講，最簡單而言，就是將某個可變數據放到適當的地方（填空），而其次，能夠控制這個區域輸出不輸入（if指令)，或讓其個區域循環輸入屢次（for指令)，更強制，實現模板互相套嵌（layout與block）。爲了實現if與for有兩種方法，一種是單純的區域，插入一個js 語句，裏面有if語句與for語句，另外一種是使用語法糖，好比說 ms-for, ms-repeat, ng-if, ng-repeat。語法糖的用法比直接使用JS語句簡單，可是帶來學習成本與拓展功能。每個模板 if, for指令的語法都不同的，而且你想在循環作一些處理，好比過濾一些數據，或忽然在某處中斷，這又得引用一些新的語句。隨着模板要求先後共用，就有了傳輸成本，直接寫JS語句在模板裏面確定比不過語法糖。所以基於這種種緣由，mustache風格的模板就成爲主流。

如今三種模板風格：

PHP/ASP/JSP風格：

<% if ( list.length ) { %>
  <ol>
    <% for ( n=0; n<list.length; ++n ) { %>
      <li>
        <%= list[n] %>
      </li>
    <% } %>
  </ol>
<% } %>

mustcache風格，高級語法有限，一般難自定義拓展：

{{#if list.length}}
  <ol>
    {{#each list item}}
      <li>
        {{ item }}
      </li>
    {{/each}}
  </ol>
{{/if}}

屬性綁定風格：

<ol ms-if="list.length">
  <li ms-for="item in list">
      {{item}}
  </li>
</ol>

前二者只能出現於script, textarea等容器元素內部。所以<分隔符與標籤的<容器形成衝突，而且也不利於IDE的格式化處理。屬性綁定風格則是MVVM時期最流行的模板定義風格，某頁面某個區域就是一個模板，不須要進行入append等操做。

咱們再來看如何實現前端模板。前端模板的本質就是一個能夠轉換函數（渲染函數）的字符串。渲染函數放進一個充滿數據的對象後，還原爲一個全新的字符串。所以重點是如何構建一個渲染函數。最簡單的方式是正則，還記得第二章的format方法嗎，這就是一個輕型的填充數據的方法。

function format(str, object) {
    var array = Array.prototype.slice.call(arguments, 1);
    return str.replace(/\\?\#{([^{}]+)\}/gm, function(match, name) {
        if (match.charAt(0) == '\\')
            return match.slice(1);
        var index = Number(name)
        if (index >= 0)
            return array[index];
        if (object && object[name] !== void 0)
            return  object[name];
        return  '';
    });
}

format方法是經過#{ }來劃分靜態內容與動態內容的，通常來講它們稱之爲定界符（delimiter）。#{爲前定界符，}爲後界符，這個#{}實際上是ruby風格的定界符。一般的定界符是<%與%>，{{與}} 。一般在前定界符中還有一些修飾符號，好比=號，表示這個會輸出到頁面，-號，表示會去掉兩旁的空白。
將下例，要編譯成一個渲染函數

var tpl = '你好,個人名字啊<%name%>, 今年已經 <%info.age%>歲了'
 var data = {
     name: "司徒正美",
     age: 20
 }

大抵是這樣

var body = '你好,個人名字叫'+ data.name+ ', 今年已經 '+data.info.age+ '歲了'
var render = new Function('data', 'return '+ body)

或者聰明一點，使用數組來join:

var array = ['return ']
array.push('你好,個人名字叫'）
array.push(data.name)
array.push(', 今年已經')
array.push(data.info.age)
array.push( '歲了')
var render = new Function('data', array.join('+'))

這就得區分靜態內容與爲變量前加data.前綴。這一步能夠用正則來作，也能夠用純字符串。咱們試一下純字符串方式。假令前定界符爲openTag，後定界符爲closeTag，經過indexOf 與slice方法，就能夠將它切成一塊塊。

function tokenize(str) {
    var openTag = '<%'
    var closeTag = '%>'
    var ret = []
    do {
        var index = str.indexOf(openTag)
        index = index === -1 ? str.length : index
        var value = str.slice(0, index)
        //抽取{{前面的靜態內容
        ret.push({
            expr: value,
            type: 'text'
        })
        //改變str字符串自身
        str = str.slice(index + openTag.length)
        if (str) {
            index = str.indexOf(closeTag)
            var value = str.slice(0, index)
            //抽取{{與}}的動態內容
            ret.push({
                expr: value.trim(),//JS邏輯兩旁的空白能夠省去
                type: 'js'
            })
            //改變str字符串自身
            str = str.slice(index + closeTag.length)
        }
    } while (str.length)
    return ret
}
console.log(tokenize(tpl))

而後經過render方法將它們拼接起來。

function render(str) {
     var tokens = tokenize(str)
     var ret = []
     for (var i = 0, token; token = tokens[i++]; ) {
         if (token.type === 'text') {
             ret.push('"' + token.expr + '"')
         } else {
             ret.push(token.expr)
         }
     }
     console.log("return "+ ret.join('+'))
 }

打印出來以下

return "你好,個人名字叫"+name+", 今年已經 "+info.age+"歲了"

這個方法還不完整。首先光是在兩旁加上雙引號是不可靠的，萬一裏面還有雙引號怎麼辦。所以咱們須要引入第二章介紹的quote方法，當類型爲文本時，ret.push(+quote(token.expr)+）。其次須要對動態部分的變量加上.data。怎麼知道它是一個變量呢。咱們回想一下變量的定義，就是以_,$或字母開頭的字符組合。爲了簡潔起見，咱們暫時不用裏會中文的狀況。不過，info.age這個字符串裏面，其實有兩個符合變量的子串，而我只須要在info前面加data.。這時，咱們須要設法在匹配變量前，將對象的子級屬性替換掉，替換成不符合變量的字符，而後再替換爲去。爲此，我搞了一個dig與fill方法，將子級屬性變成??12這樣的字符串:

 var quote = JSON.stringify//本身到第二章找完整函數
 var rident = /[$a-zA-Z_][$a-zA-Z0-9_]*/g
 var rproperty = /\.\s*[\w\.\$]+/g
 var number = 1
 var rfill = /\?\?\d+/g
 var stringPool = {}
 function dig(a) {
     var key = '??' + number++
     stringPool[key] = a
     return key
 }
 function fill(a) {
     return stringPool[a]
 }
 function render(str) {
     stringPool = {}
     var tokens = tokenize(str)
     var ret = []
     for (var i = 0, token; token = tokens[i++]; ) {
         if (token.type === 'text') {
             ret.push(quote(token.expr))
         } else {
             // 先去掉對象的子級屬性,減小干擾因素
             var js = token.expr.replace(rproperty, dig)
             js = js.replace(rident, function (a) {
                 return 'data.' + a
             })
             js = js.replace(rfill, fill)
             ret.push(js)
         }
     }
     console.log("return " + ret.join('+'))
 }
render(tpl)

輸出爲

return "你好,個人名字叫"+data.name+", 今年已經 "+data.info.age+"歲了"

最後，咱們修改一下後面兩行，獲得咱們夢魅以求的渲染函數，它的實現過程比format方法複雜多了，但倒是全部擴展性極強的前端模板的通常實現過程。

  function render(str){
  //略。。。
     return new Function("data", "return " + ret.join('+'))
  }
  var fn = render(tpl)
  console.log(fn+"")
  console.log(fn(data))

咱們再看一下如何引入循環語句，好比將上面的模板與數據改爲這樣

var tpl = '你好,個人名字叫<%name%>, 今年已經 <%info.age%>歲了,喜歡<% for(var i = 0, el; el = list[i++];){%><% el %> <% } %>'
 var data = {
     name: "司徒正美",
     info: {
         age: 20
     },
     list: ["蘋果","香蕉","雪梨"]
 }

這時咱們就添加一種新的類型，不輸出到頁面的動態內容。這在token方法中作一些修改

value = value.trim()
if (/^(if|for|})/.test(value)) {
    ret.push({
        expr: value,
        type: 'logic'
    })
} else {
    ret.push({
        expr: value,
        type: 'js'
    })
}

但render方法怎麼修改好呢，顯示這時繼續用＋已經不行了，不然下場是這樣

return "你好,個人名字叫"+data.name+", 今年已經 "+data.info.age+"歲了,喜歡"+for(var i = 0, el; el = list[i++];){+""+data.el+" "+}

這時，咱們須要借用數組，將要輸入的數據（text, js類型）放進去，logic類型不放進去。

function addPrefix(str) {
   // 先去掉對象的子級屬性,減小干擾因素
   var js = str.replace(rproperty, dig)
   js = js.replace(rident, function (a) {
       return 'data.' + a
   })
   return js.replace(rfill, fill)
}
function addView(s) {
   return '__data__.push(' + s + ')'
}
function render(str) {
    stringPool = {}
    var tokens = tokenize(str)
    var ret = ['var __data__ = []']
    tokens.forEach(function(token){
       if (token.type === 'text') {
           ret.push(addView(quote(token.expr)))
       } else if (token.type === 'logic') {
           //邏輯部分都通過addPrefix方法處理
           ret.push(addPrefix(token.expr))
       } else {
           ret.push(addView(addPrefix(token.expr)))
       }
    })
    ret.push("return __data__.join('')")
    console.log( ret.join('\n'))
  }
var fn = render(tpl)

獲得的內部結構是這樣的，顯然addPrefix方法出問題，咱們應該過濾掉if, for等關鍵字與保留字。

var __data__ = []
__data__.push("你好,個人名字叫")
__data__.push(data.name)
__data__.push(", 今年已經 ")
__data__.push(data.info.age)
__data__.push("歲了,喜歡")
data.for(data.var data.i = 0, data.el; data.el = data.list[data.i++]){
__data__.push("")
__data__.push(data.el)
__data__.push(" ")
}
return __data__.join('')

但即便咱們處理掉關鍵字與保留字，對於中間生成i, el怎麼區分呢？是區分不了。因而目前有兩種方法，一是使用with，這時咱們就不須要加data.前綴。第二種引入新的語法。好比，前面是@就替換爲data.。

先看第一種：

function render(str) {
     stringPool = {}
     var tokens = tokenize(str)
     var ret = ['var __data__ = [];', 'with(data){']
     for (var i = 0, token; token = tokens[i++]; ) {
         if (token.type === 'text') {
             ret.push(addView(quote(token.expr)))
         } else if (token.type === 'logic') {
             ret.push(token.expr)
         } else {
             ret.push(addView(token.expr))
         }
     }
     ret.push('}')
     ret.push('return __data__.join("")')
     return new Function("data", ret.join('\n'))
 }
 var fn = render(tpl)
 console.log(fn + "")
 console.log(fn(data))

許多迷你模板都是用with減小替換工做。

第二種方法，使用引導符@, avalon2就是這麼玩。這樣addPrefix方法能夠減小許多代碼。相對應，模板也要改動一下

 var tpl = '你好,個人名字叫<%@name%>, 今年已經 <%@info.age%>歲了,喜歡<% for(var i = 0, el; el = @list[i++];){%><% el %> <% } %>'
 var rguide = /(^|[^\w\u00c0-\uFFFF_])(@|##)(?=[$\w])/g
 function addPrefix(str) {
     return str.replace(rguide, '$1data.')
 }
 function render(str) {
     stringPool = {}
     var tokens = tokenize(str)
     var ret = ['var __data__ = [];']
     for (var i = 0, token; token = tokens[i++]; ) {
         if (token.type === 'text') {
             ret.push(addView(quote(token.expr)))
         } else if (token.type === 'logic') {
             //邏輯部分都通過addPrefix方法處理
             ret.push(addPrefix(token.expr))
         } else {
             ret.push(addView(addPrefix(token.expr)))
         }
     }
    
     ret.push('return __data__.join("")')
     return new Function("data", ret.join('\n'))
 }
 var fn = render(tpl)
 console.log(fn + "")
 console.log(fn(data))

第二種比第一種的優點在於，性能更高，而且避開es5嚴格模式的限制。

咱們再認真思考一下，其實循環語句與條件語句，不單是for, if兩個，還有while, do while, else什麼。所以這須要優化。這也有兩種方法，添加更多語法符合，好比上面所說的=就是輸出，沒有則不輸出。這是ASP/JSP/PHP等模板採用的手段：

//tokenize方法
if (value.charAt(0) === '=') {
     ret.push({
         expr: value, 
         type: 'js'
     })
 } else {
     ret.push({
         expr: value, 
         type: 'logic'
     })
 }

另外一種，使用語法糖，如#each (el, index) in @list , '#eachEnd', '#if ','#ifEnd'。仍是改動tokenize方法

 if (value.charAt(0) === '#') {
    if (value === '#eachEnd' || value === '#ifEnd') {
        ret.push({
            expr: '}',
            type: 'logic'
        })
    } else if (value.slice(0, 4) === '#if ') {
        ret.push({
            expr: 'if(' + value.slice(4) + '){',
            type: 'logic'
        })
    } else if (value.slice(0, 6) === '#each ') {
        var arr = value.slice(6).split(' in ')
        var arrayName = arr[1]
        var args = arr[0].match(/[$\w_]+/g)
        var itemName = args.pop()
        var indexName = args.pop() || '$index'
        value = ['for(var ', ' = 0;', '<' + arrayName + '.length;', '++){'].join(indexName) +
                '\nvar ' + itemName + ' = ' + arrayName + '[' + indexName + '];'
        ret.push({
            expr: value,
            type: 'logic'
        })
    
    }
    
} else{
   //...
}

對應的模板改爲

var tpl = '你好,個人名字叫<%@name%>, 今年已經 <%@info.age%>歲了,喜歡<%#each el in @list %><% el %> <% #eachEnd %>'
var fn = render(tpl)
console.log(fn + "")
console.log(fn(data))

可能有人覺#for, #forEnd這樣的語法糖比較醜，無問題，這個能夠改，主要咱們的tokenize方法足夠強大，就能實現mustache這樣的模板引擎。但全部模板引擎也基本上是這麼實現的，有的還支持過濾器，也就是在js 類型的語句再進行處理，將｜後面的字符器再切割出來。

若是虛擬DOM呢？那就須要一個html parser，這個工程巨大，好比reactive這個庫，早期不使用html parser與虛擬DOM，只有3，4千行，加入這些炫酷功能後就達到1W6K行。返回一個字符串與返回一個相似DOM樹的對象樹結構是不同。

原文連接：http://www.javashuo.com/article/p-qawivsrh-dg.html

原文做者：司徒正美