Javascript 字符串模板的简单实现


Posted in Javascript onFebruary 13, 2016

这是源于两年前,当我在做人生中第一个真正意义上的网站时遇到的一个问题

该网站采用前后端分离的方式,由后端的 REST 接口返回 JSON 数据,再由前端渲染到页面上。

同许多初学 Javascript 的菜鸟一样,起初,我也是采用拼接字符串的形式,将 JSON 数据嵌入 HTML 中。开始时代码量较少,暂时还可以接受。但当页面结构复杂起来后,其弱点开始变得无法忍受起来:

  1. 书写不连贯。每写一个变量就要断一下,插入一个 + 和 "。十分容易出错。
  2. 无法重用。HTML 片段都是离散化的数据,难以对其中重复的部分进行提取。
  3. 无法很好地利用 <template> 标签。这是 HTML5 中新增的一个标签,标准极力推荐将 HTML 模板放入 <template> 标签中,使代码更简洁。
  4. 当时我的心情就是这样的:

这TMD是在逗我吗

为了解决这个问题,我暂时放下了手上的项目,花了半个小时实现一个极简易的字符串模板。

需求描述

实现一个 render(template, context) 方法,将 template 中的占位符用 context 填充。要求:

不需要有控制流成分(如 循环、条件 等等),只要有变量替换功能即可
级联的变量也可以展开
被转义的的分隔符 { 和 } 不应该被渲染,分隔符与变量之间允许有空白字符
例子:

render('My name is {name}', {
  name: 'hsfzxjy'
}); // My name is hsfzxjy

render('I am in {profile.location}', {
  name: 'hsfzxjy',
  profile: {
    location: 'Guangzhou'
  }
}); // I am in Guangzhou

render('{ greeting }. \\{ This block will not be rendered }', {
  greeting: 'Hi'
}); // Hi. { This block will not be rendered }

实现

先写下函数的框架:

function render(template, context) {

}

显然,要做的第一件事便是 匹配模板中的占位符。

匹配占位符

匹配的事,肯定是交给正则表达式来完成。那么,这个正则表达式应该长什么样呢?

根据 需求 1、2 的描述,我们可以写出:

var reg = /\{([^\{\}]+)\}/g;

至于需求 3,我第一个想到的概念是 前向匹配,可惜 Javascript 并不支持,只好用一个折衷的办法:

var reg = /(\\)?\{([^\{\}\\]+)(\\)?\}/g;
// 若是第一个或第三个分组值不为空,则不渲染
现在,代码应该是这样:

function render(template, context) {

  var tokenReg = /(\\)?\{([^\{\}\\]+)(\\)?\}/g;

  return template.replace(tokenReg, function (word, slash1, token, slash2) {
    if (slash1 || slash2) { // 匹配到转义字符
      return word.replace('\\', ''); // 如果 分隔符被转义,则不渲染
    }

    // ...
  })
}

占位符替换

嗯,正则表达式确定了,接下来要做的便是替换工作。

根据 需求2,模板引擎不仅要能渲染一级变量,更要渲染多级变量。这该怎么做呢?

其实很简单:将 token 按 . 分隔开,逐级查找即可:

var variables = token.replace(/\s/g, '').split('.'); // 切割 token
var currentObject = context;
var i, length, variable;

// 逐级查找 context
for (i = 0, length = variables.length, variable = variables[i]; i < length; ++i)
  currentObject = currentObject[variable];

return currentObject;

不过,有可能 token 指定的变量并不存在,这时上面的代码便会报错。为了更好的体验,代码最好有一定的容错能力:

var variables = token.replace(/\s/g, '').split('.'); // 切割 token
var currentObject = context;
var i, length, variable;

for (i = 0, length = variables.length, variable = variables[i]; i < length; ++i) {
  currentObject = currentObject[variable];
  if (currentObject === undefined || currentObject === null) return ''; // 如果当前索引的对象不存在,则直接返回空字符串。
}

return currentObject;

把所有的代码组合在一起,便得到了最终的版本:

function render(template, context) {

  var tokenReg = /(\\)?\{([^\{\}\\]+)(\\)?\}/g;

  return template.replace(tokenReg, function (word, slash1, token, slash2) {
    if (slash1 || slash2) { 
      return word.replace('\\', '');
    }

    var variables = token.replace(/\s/g, '').split('.');
    var currentObject = context;
    var i, length, variable;

    for (i = 0, length = variables.length, variable = variables[i]; i < length; ++i) {
      currentObject = currentObject[variable];
      if (currentObject === undefined || currentObject === null) return '';
    }

    return currentObject;
  })
}

除去空白行,一共 17 行。

将函数挂到 String 的原型链

甚至,我们可以通过修改原型链,实现一些很酷的效果:

String.prototype.render = function (context) {
  return render(this, context);
};

之后,我们便可以这样调用啦:

"{greeting}! My name is { author.name }.".render({
  greeting: "Hi",
  author: {
    name: "hsfzxjy"
  }
});
// Hi! My name is hsfzxjy.
Javascript 相关文章推荐
javascript学习笔记(五)正则表达式
Apr 08 Javascript
Jquery操作radio的简单实例
Jan 06 Javascript
node.js中的fs.statSync方法使用说明
Dec 16 Javascript
javascript简单实现类似QQ头像弹出效果的方法
Aug 03 Javascript
原生js实现选项卡功能
Mar 08 Javascript
JS实现动态添加DOM节点和事件的方法示例
Apr 28 Javascript
jQuery复合事件用法示例
Jun 10 jQuery
JavaScript引用类型Object常见用法实例分析
Aug 08 Javascript
微信小程序保存多张图片的实现方法
Mar 05 Javascript
jQuery 查找元素操作实例小结
Oct 02 jQuery
Vue.js 无限滚动列表性能优化方案
Dec 02 Javascript
Angular之jwt令牌身份验证的实现
Feb 14 Javascript
javascript基础知识分享之类与函数化
Feb 13 #Javascript
JavaScript正则表达式的分组匹配详解
Feb 13 #Javascript
js HTML5 Ajax实现文件上传进度条功能
Feb 13 #Javascript
js随机生成26个大小写字母
Feb 12 #Javascript
jquery实现具有嵌套功能的选项卡
Feb 12 #Javascript
基于jquery实现动态竖向柱状条特效
Feb 12 #Javascript
原生javascript实现自动更新的时间日期
Feb 12 #Javascript
You might like
使用Limit参数优化MySQL查询的方法
2008/11/12 PHP
php 在线导入mysql大数据程序
2015/06/11 PHP
非常有用的9个PHP代码片段
2016/04/06 PHP
PHP判断一个数组是另一个数组子集的方法详解
2017/07/31 PHP
Javascript下判断是否为闰年的Datetime包
2010/10/26 Javascript
jqeury eval将字符串转换json的方法
2011/01/20 Javascript
js动态设置鼠标事件示例代码
2013/10/30 Javascript
深入解析JavaScript中的变量作用域
2013/12/06 Javascript
document.execCommand()的用法小结
2014/01/08 Javascript
跟我学习javascript的arguments对象
2015/11/16 Javascript
JavaScript中的闭包
2016/02/24 Javascript
AngularJS实现单独作用域内的数据操作
2016/09/05 Javascript
js数组去重的hash方法
2016/12/22 Javascript
JS获取鼠标位置距浏览器窗口距离的方法示例
2017/04/11 Javascript
vue+Vue Router多级侧导航切换路由(页面)的实现代码
2018/12/20 Javascript
vue遍历对象中的数组取值示例
2019/11/07 Javascript
用javascript实现倒计时效果
2021/02/09 Javascript
[48:18]DOTA2-DPC中国联赛 正赛 RNG vs Dynasty BO3 第二场 1月29日
2021/03/11 DOTA
简单谈谈Python中的几种常见的数据类型
2017/02/10 Python
Python的mysql数据库的更新如何实现
2017/07/31 Python
Django通用类视图实现忘记密码重置密码功能示例
2019/12/17 Python
Python调用.NET库的方法步骤
2019/12/27 Python
关于Keras模型可视化教程及关键问题的解决
2020/01/24 Python
Python基于smtplib协议实现发送邮件
2020/06/03 Python
python中取绝对值简单方法总结
2020/07/24 Python
CSS中的字体大小设置属性总结
2016/05/24 HTML / CSS
如何唤起类中的一个方法
2013/11/29 面试题
新闻系毕业生推荐信
2013/11/16 职场文书
学习心得体会
2014/01/01 职场文书
给男朋友的道歉信
2014/01/12 职场文书
机关办公室岗位职责
2014/04/16 职场文书
环卫处个人工作总结
2015/03/04 职场文书
会议通知
2015/04/15 职场文书
黄河绝恋观后感
2015/06/08 职场文书
2016年五一劳动节专题校园广播稿
2015/12/17 职场文书
Nginx部署vue项目和配置代理的问题解析
2021/08/04 Servers