实现一个简单的 js 模板

要实现的目标

<p>这是<%name%>的第一个<% content %></p>

data = {
  name: 'a',
  content: 'template'
}

变成

<p>这是a的第一个template</p>

这是个比较简单的 html 解析代码,用正则即可完成。思路是将所有的<% %>包裹的东西,与 data 对象的 key 匹配,匹配上替换即可。

let templateDel = function(tpl, data) {
    var result = tpl.replace(/<%\s*([^%>|\s]+)?\s*%>/g, function(s0, s1) {
        return data[s1]
    })
    console.log(result)
}

检验一下这个模板处理函数是否达到我们预期的效果

html

<body>
  <div id="results">

  </div>
  <script type="text/html" id="item_tmpl">
    <p>这是<%name%>的第一个<% age %></p>
    <a href=""><%name%></a>
  </script>
</body>

id="item_tmpl" 标签中包含着我们需要处理的模板语言,处理完后放到id="results"

js

let templateDel = function(id, data, toWhere) {
    let tpl = document.getElementById(id).innerHTML
    var result = tpl.replace(/<%\s*([^%>|\s]+)?\s*%>/g, function(s0, s1) {
        return data[s1]
    })
    console.log(result)
    document.getElementById(toWhere).innerHTML = result
}
let data = {
    name: 'a',
    age: 'template'
}
templateDel('item_tmpl', data, 'results')

审查页面的元素

<div id="results">
    <p>这是a的第一个template</p>
    <a href="">a</a>
</div>

这样似乎满足了我们一开始的需求,但是如果处理的数据比较复杂,这样似乎就不行了

<script type="text/html" id="item_tmpl">
    <p>这是<%name%>的第一个<% age %></p>
    <a href=""><%obj.x%></a>
</script>
let data = {
    name: 'a',
    age: 'template',
    obj: {
        x: 'xxxx'
    }
}
templateDel('item_tmpl', data, 'results')

这时模板里的 obj.x 就被替换成 data[obj.x],也就是 undefined 了
而且模板中一般会有一些循环和条件判断的处理,这样写也没有办法解析

<script type="text/html" id="item_tmpl">
  <% for(var i=0; i< obj.arr.length; i++){ %>
    <p>这是obj.arr的第<%i%>个<% obj.arr[i] %></p>
    <% if(i != 2){ %>
      <a href=""><%i%></a>
    <%}%>
  <%}%>
</script>

这时我们不能简单的用正则匹配替换就可以,而是换一种思路。即,把模板语句 用 function 执行。

所以我们需要做的就是把模板当作字符串 分割开来,然后在对变量和函数来 处理后在拼接起来。

第一步:用正则将代码的分割

let templateDel = function(id, data, toWhere) {
    let tpl = document.getElementById(id).innerHTML
    var reg = /<%\s*([^%>]+)?\s*%>/g
    while ((match = reg.exec(tpl))) {
        console.log(match)
        // 这里match[1]是所有用了模板符号的代码,那没有用模板的标签或其他代码怎么表示呢?
    }
}

第二步:用一个变量 cursor 来标示当前解析到了哪个位置,可以称之为 游标

let templateDel = function(id, data, toWhere) {
    let tpl = document.getElementById(id).innerHTML
    var reg = /<%\s*([^%>]+)?\s*%>/g,
        cursor = 0 // 默认位置为0
    while ((match = reg.exec(tpl))) {
        console.log(match)
        // 这里match[1]是所有用了模板符号的代码

        console.log(match.index)
        // 当前正则解析到的模板的开始位置

        console.log(tpl.slice(cursor, match.index))
        // 当前正则解析到的模板之前的没有用模板的标签或其他代码

        cursor = match.index + match[1].length
        // 重新定位游标位置
    }
}

第三步:将分割完的代码用数组存起来

这里不是简单的定义一个变量类型为数组,然后往里 push,而是应该定义一个 字符串, 该字符串应是我们处理模板的函数体。

定义一个 add 函数,专门处理 分割后的代码往字符串里添加

let templateDel = function(id, data, toWhere) {
    let tpl = document.getElementById(id).innerHTML
    var reg = /<%\s*([^%>]+)?\s*%>/g,
        cursor = 0, // 默认位置为0
        code = 'var r=[]; \n',
        add = function(line) {
            code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n'
        }
    while ((match = reg.exec(tpl))) {
        add(tpl.slice(cursor, match.index))
        add(match[1])
        cursor = match.index + match[1].length
        // 重新定位游标位置
    }
    add(tpl.substr(cursor, tpl.length - cursor)) // 这里不能忘了最后一个正则匹配后的非模板标识符包含的代码块
}

第四步:完善 add 函数

我们处理分割后的字符串,应该区分对待

不在模板标识符中的 以字符串形式,存储在数组中

在模板标识符中的变量 以变量形式存在数组中

在模板标识符中的函数语句,如 for,if 等 不存在数组中,而是直接拼接在函数体中

let templateDel = function(id, data, toWhere) {
    let tpl = document.getElementById(id).innerHTML
    var reg = /<%\s*([^%>]+)?\s*%>/g,
        cursor = 0, // 默认位置为0
        reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g, // 该正则是用来检测是否是for,if等函数语句
        code = 'var r=[]; \n',
        add = function(line, js) {
            // js为判断是否是在模板标识符中包含的代码块
            js
                ? (code += line.match(reExp) ? line + '\n' : 'r.push(' + line + ');\n')
                : (code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n')
        }
    while ((match = reg.exec(tpl))) {
        add(tpl.slice(cursor, match.index))
        add(match[1], true)
        cursor = match.index + match[1].length
        // 重新定位游标位置
    }
    add(tpl.substr(cursor, tpl.length - cursor))
}

第五步:完善 code 函数体,并生成一个函数

code 除了包含我们分割的代码,还应该有个 return, return 回的就是我们在数组 r 拼接后的字符串

let templateDel = function(id, data, toWhere) {
    let tpl = document.getElementById(id).innerHTML
    var reg = /<%\s*([^%>]+)?\s*%>/g,
        cursor = 0, // 默认位置为0
        reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g, // 该正则是用来检测是否是for,if等函数语句
        code = 'var r=[]; \n',
        add = function(line, js) {
            // js为判断是否是在模板标识符中包含的代码块
            js
                ? (code += line.match(reExp) ? line + '\n' : 'r.push(' + line + ');\n')
                : (code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n')
        }
    while ((match = reg.exec(tpl))) {
        add(tpl.slice(cursor, match.index))
        add(match[1], true)
        cursor = match.index + match[1].length
        // 重新定位游标位置
    }
    add(tpl.substr(cursor, tpl.length - cursor))
    code += 'return r.join("")'
    let fn = new Function('obj', code.replace(/[\r\t\n]/g, ''))
    console.log(fn)
    document.getElementById(toWhere).innerHTML = fn(data.obj)
}

第六步:检测代码

    let data = {
        obj: {
            arr: ['a', 'b', 'c', 'd']
        }
    }
    templateDel('item_tmpl', data, 'results')

  // 结果为:
  <div id="results">
    <p>这是obj.arr的第0个a</p>
    <a href="">0</a>
    <p>这是obj.arr的第1个b</p>
    <a href="">1</a>
    <p>这是obj.arr的第2个c</p>
    <p>这是obj.arr的第3个d</p>
    <a href="">3</a>
  </div>

第七步: 进一步完善

这里定义fn时,传入的形参为obj,限制了使用。有很大的局限性

let templateDel = function(id, data, toWhere) {
    let tpl = document.getElementById(id).innerHTML
    var reg = /<%\s*([^%>]+)?\s*%>/g,
        cursor = 0, // 默认位置为0
        reExp = /(^( )?(if|for|else|switch|case|break|{|}))(.*)?/g, // 该正则是用来检测是否是for,if等函数语句
        code = 'var r=[]; \n',
        add = function(line, js) {
            // js为判断是否是在模板标识符中包含的代码块
            js
                ? (code += line.match(reExp) ? line + '\n' : 'r.push(' + line + ');\n')
                : (code += 'r.push("' + line.replace(/"/g, '\\"') + '");\n')
        }
    while ((match = reg.exec(tpl))) {
        add(tpl.slice(cursor, match.index))
        add(match[1], true)
        cursor = match.index + match[1].length
        // 重新定位游标位置
    }
    add(tpl.substr(cursor, tpl.length - cursor))
    code += 'return r.join("")'
    let fn = new Function(code.replace(/[\r\t\n]/g, '')).call(this, data)
    console.log(fn)
    document.getElementById(toWhere).innerHTML = fn.apply(data)
}

改动一下模板用法

<script type="text/html" id="item_tmpl">
  <% for(var i=0; i< this.obj.arr.length; i++){ %>
    <p>这是obj.arr的第<%i%>个<% this.obj.arr[i] %></p>
    <% if(i != 2){ %>
      <a href=""><%i%></a>
    <%}%>
  <%}%>
</script>

可能遇到的问题

模板片段分割时,记得将"转译成\",不然会报错
不要忘了最后一段分割的代码,即add(tpl.substr(cursor, tpl.length - cursor))

大神的实现方式

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,602评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,442评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,878评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,306评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,330评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,071评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,382评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,006评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,512评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,965评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,094评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,732评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,283评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,286评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,512评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,536评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,828评论 2 345

推荐阅读更多精彩内容

  • 第2章 基本语法 2.1 概述 基本句法和变量 语句 JavaScript程序的执行单位为行(line),也就是一...
    悟名先生阅读 4,118评论 0 13
  • 一、Python简介和环境搭建以及pip的安装 4课时实验课主要内容 【Python简介】: Python 是一个...
    _小老虎_阅读 5,720评论 0 10
  • 这周难得的一天休息,晚上还要上晚自习.早上本打算把女儿送去练舞蹈然后抽出这两小时的时间去逛逛添置些换季的衣...
    特殊的今天阅读 204评论 0 1
  • 香香不知何许人也,亦不详其缪字,公司有女主播,因以为号焉 。闲静少言,不慕荣利。好做号,不求扫雷;每有广告,便欣然...
    绽放的黑玫瑰阅读 184评论 0 1