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 相关文章推荐
jQuery 动态酷效果实现总结
Dec 27 Javascript
JavaScript 七大技巧(一)
Dec 13 Javascript
以JavaScript来实现WordPress中的二级导航菜单的方法
Dec 14 Javascript
BootStrap使用file-input插件上传图片的方法
Sep 05 Javascript
js实现图片左右滚动效果
Feb 27 Javascript
Angularjs实现上传图片预览功能
Sep 01 Javascript
基于zepto.js实现登录界面
Oct 09 Javascript
使用Vue实现调用接口加载页面初始数据
Oct 28 Javascript
vue transition 在子组件中失效的解决
Nov 12 Javascript
浅谈JavaScript中你可能不知道URL构造函数的属性
Jul 13 Javascript
通过vue刷新左侧菜单栏操作
Aug 06 Javascript
javascript局部自定义鼠标右键菜单
Dec 08 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
新手菜鸟必读:session与cookie的区别
2013/08/22 PHP
php通过执行CutyCapt命令实现网页截图的方法
2016/09/30 PHP
Yii2实现自定义独立验证器的方法
2017/05/05 PHP
php校验公钥是否可用的实例方法
2019/09/17 PHP
php设计模式之职责链模式实例分析【星际争霸游戏案例】
2020/03/27 PHP
JS左右无缝滚动(一般方法+面向对象方法)
2012/08/17 Javascript
js实现广告漂浮效果的小例子
2013/07/02 Javascript
JavaScript检测并限制复选框选中个数的方法
2015/08/12 Javascript
AngularJs ng-repeat 嵌套如何获取外层$index
2016/09/21 Javascript
angularjs 中$apply,$digest,$watch详解
2016/10/13 Javascript
bootstrap table 数据表格行内修改的实现代码
2017/02/13 Javascript
详解用node编写自己的cli工具
2017/05/23 Javascript
vue.js简单配置axios的方法详解
2017/12/13 Javascript
在小程序/mpvue中使用flyio发起网络请求的方法
2018/09/13 Javascript
vue axios请求频繁时取消上一次请求的方法
2018/11/10 Javascript
函数式编程入门实践(一)
2019/04/20 Javascript
RxJS在TypeScript中的简单使用详解
2020/04/13 Javascript
利用Python如何生成随机密码
2016/04/20 Python
200行自定义python异步非阻塞Web框架
2017/03/15 Python
python爬虫入门教程--优雅的HTTP库requests(二)
2017/05/25 Python
Python入门之三角函数全解【收藏】
2017/11/08 Python
python kmeans聚类简单介绍和实现代码
2018/02/23 Python
python 文件转成16进制数组的实例
2018/07/09 Python
python实现手机销售管理系统
2019/03/19 Python
python实现ftp文件传输功能
2020/03/20 Python
安全责任书范文
2014/03/12 职场文书
《他得的红圈圈最多》教学反思
2014/04/24 职场文书
装修活动策划方案
2014/08/27 职场文书
统计学教授推荐信
2014/09/18 职场文书
2014医学院领导班子对照检查材料思想汇报
2014/09/19 职场文书
大连星海广场导游词
2015/02/10 职场文书
2015年初中教师个人工作总结
2015/07/21 职场文书
2015教师个人年度工作总结
2015/10/23 职场文书
《植物妈妈有办法》教学反思
2016/02/23 职场文书
Python几种酷炫的进度条的方式
2022/04/11 Python
微信告警的zabbix监控系统 监控整个NGINX集群
2022/04/18 Servers