实现一个 JavaScript 模板引擎

模板引擎(这里特指用于 Web 开发的模板引擎)是为了使用户界面与业务数据(内容)分离而产生的,它可以生成特定格式的文档,用于网站的模板引擎就会生成一个标准的 HTML 文档。

模板引擎以一种相当简单的方式工作:您创建一个模板,并使用适当的语法将变量传递给它。

例如:ES6 的模块字符串或 Underscore _.template 方法,它们都以类似的方式工作。有一些开发者将它们封装成更加健壮、优雅、功能更丰富的模板引擎。

常用的模板引擎有:

这些模版语言大多是相似的,都提供了用于展示数据的内容替换和过滤器的功能,且大部分模版引擎都支持自定义过滤器,以展示自定义格式的内容。

下面我们来研究一个相对简单的模板引擎示例。

JavaScript 实现

以下实现的代码来自 absurd/lib/processors/html/helpers/TemplateEngine.js

const TemplateEngine = function (html, options) {
  // re 用于捕获所有以 <% 开头并以 %> 结尾的部分
  let re = /<%(.+?)%>/g,
    // reExp 用于捕获模板语法内的以 if、for... 开头的代码
    reExp = /(^( )?(var|if|for|else|switch|case|break|{|}|;))(.*)?/g,
    // 最终函数体为拼接完的 code,代码在 with 内运行。注意,严格模式下无法使用 with
    code = 'with(obj) { var r=[];\n',
    cursor = 0,
    result,
    match
  // add 函数的作用是,将所有没有被模板语法包裹的内容推入 r 数组中,而 JS 语法则不需要。
  const add = function (line, js) {
    js
      ? (code += line.match(reExp) ? line + '\n' : 'r.push(' + line + ');\n')
      : (code +=
          line != '' ? 'r.push("' + line.replace(/"/g, '\\"') + '");\n' : '')
    return add
  }
  // 使用 exec() 方法在一个指定字符串中执行一个搜索匹配。返回一个结果数组或 null。
  // 循环调用 add 函数分离文本内容和模板语法
  while ((match = re.exec(html))) {
    // html.slice(cursor, match.index) 用于截取没有被 <% %> 包裹的元素
    // match[1] 获取被 <% %> 包裹内的 JS 代码
    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(""); 将最终的内容转为字符串并返回
  // 使用 replace 将拼接的代码中包含的回车、制表符、换行符替换为空
  // 转义字符 — \r 回车、\t tab 制表符、\n 换行符,g 标志全局匹配,replace 替换匹配的元素
  code = (code + 'return r.join(""); }').replace(/[\r\t\n]/g, '')
  console.log(code) // <- 这里打印一下,一目了然
  try {
    // 调用 apply 方法改变函数 this 指向,并传递 options 数组
    result = new Function('obj', code).apply(options, [options])
  } catch (err) {
    console.error(`'${err.message}'`, ' in \n\nCode:\n', code, '\n')
  }
  return result
}

示例:

const template =
  'My skills:' +
  '<% if(this.showSkills) { %>' +
  '<% for(let value of this.skills) { %>' +
  '<a href="#"><% value %></a>' +
  '<% } %>' +
  '<% } else { %>' +
  '<p>none</p>' +
  '<% } %>'

TemplateEngine(template, {
  skills: ['js', 'html', 'css'],
  showSkills: true
}) // My skills:<a href="#">js</a><a href="#">html</a><a href="#">css</a>

它还配有一篇文章,详细解读了如何使用 20 行代码实现 JavaScript 模板引擎:JavaScript template engine in just 20 lines

您可以在此基础上添加其他的逻辑,以丰富它的功能。

更多资料


本文首发 blog,如果喜欢或者有所启发,欢迎 Star,对作者也是一种鼓励。

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

推荐阅读更多精彩内容