EJS[1]-源码解析

EJS[1]-源码解析

官方文档中有提到两个,最基本的使用也确实只有那两个,但是实际上可以调用的函数有五个。 本篇会介绍下这五个API的作用&本人对于该API实现的一些想法。

EJSv1.x,代码篇幅上可以称得上短小精悍,算上注释不过400行。

建议先看完第一篇再看本文,如何使用EJS

parse

我们会从最里边的parse函数说起。parse函数是根据EJS模版来生成一段可执行的脚本字符串。

parsecompilerender三个函数的参数是属于透传的,第一个参数str为模版源字符串,第二个参数options是可选的配置参数。

parse函数在拿到str以后,会将字符串拆成一个个的字符来匹配。

抛开匹配到界定符的逻辑外,其余的一些匹配都是自增+1形式的,比如\n\\\'或任意的普通文本。 也就是说,如果一个EJS模版文件没有用到太多的动态脚本,强烈建议开启cache。 就如同下图的代码,EJS会循环字符串的所有字符,执行一遍拼接,这个工作后续是有大量的重复的,如果开启了cache后,就可以避免这个问题,这也是可以提升性能的。

ejs.render('<h1>Title</h1>')

其次就是判断字符命中为界定符: 会进一步的去查找结束的界定符,如果没有找到则会抛出异常。

var open = options.open || exports.open || '<%'
var close = options.close || exports.close || '%>'
for (var i = 0, len = str.length; i < len; ++i) {
  var stri = str[i];

  // 判断是否匹配为开始界定符
  if (str.slice(i, open.length + i) == open) {

    // ... some code

    var end = str.indexOf(close, i);

    // 如果没有找到结束的界定符,抛出异常
    if (end < 0){
      throw new Error('Could not find matching close tag "' + close + '".');
    }
  }
}

在得到了JavaScript脚本的范围(在字符串中的下标)后,我们就可以开始着手拼接脚本的工作了。 首先我们需要判断这一段脚本的类型,因为我们知道EJS提供了有三种脚本标签<% code %><%- code %><%= code %>

三种处理方式也是不一样的,第一个会直接执行脚本,其余两个会输出脚本执行的返回值。 所以三种标签的差异就体现在这里: 这里是将要包裹脚本的前缀后缀给创建了出来。 最终的返回结果会是 prefix + js + postfix。 我们会发现prefix里边有一个line变量,这里用到了逗号运算符/逗号操作符,很巧妙。 作为一个行号的输出,既不会影响程序的执行,又可以在出错的时候帮助我们快速定位问题所在。

  switch (str[i]) {
    case '=': // 序列化返回值
      prefix = "', escape((" + line + ', ';
      postfix = ")), '";
      ++i;
      break;
    case '-': // 直接返回
      prefix = "', (" + line + ', ';
      postfix = "), '";
      ++i;
      break;
    default: // 仅仅是执行
      prefix = "');" + line + ';';
      postfix = "; buf.push('";
  }

三种标签拼接后的示例:

//                                       var buf = []

ejs.render('<h1><%= "Title" %></h1>') // buf.push('<h1>', escape((1, 'Title')), '</h1>')

ejs.render('<h1><%- "Title" %></h1>') // buf.push('<h1>', (1, 'Title'), '</h1>')

ejs.render('<h1><% "Title" %></h1>')  // buf.push('<h1>'); 1; 'Title'; buf.push('</h1>')

//                                       return buf.join('')

P.S. parse函数在后边还会处理一个EJSv1.x版本有的Filters特性,因为不常用,而且v2.x版本已经移除了,所以就不再赘述。

compile

compile函数中会调用parse函数,获取脚本字符串。 并将字符串作为一个函数的主体来创建新的函数。 如果开启了debugcompile会添加一些额外的信息在脚本中。一些类似于堆栈监听之类的。

str = exports.parse(str, options) // 获取脚本字符串
var fn = new Function('locals, filters, escape, rethrow', str) // 创建函数

return function (locals) {
  fn.call(this, locals, filters, escape, rethrow);
}

render

render函数会调用compile函数,并执行它得到模版处理后的结果。 cache的判断也是在render函数这里做的。 我们存在内存中用来缓存的模版并不是执行后的结果,而是创建好的那个函数,也就是compile的返回值,也就是说,我们缓存的其实是构建函数的那一个步骤,我们可以传入不同的变量来实现动态的渲染,并且不必多次重复构建模版函数。

renderFile

renderFile函数只能够在node环境下使用。。因为有涉及到了io的操作,需要取读取文件内容,然后调用render函数。 同时renderFile也是可以使用cache的,但是为了避免renderFilepath和缓存的key重复,所以renderFile中有这么一个小操作。

var key = path + ':string';

小记

EJSv1.x源码非常清晰易懂,很适合作为研究模版引擎类的入门。 v2.x使用了一些面向对象的程序设计。。篇幅更是达到了接近900行(费解-.-不知道意义何在)。。有机会尝试着会去读一些v2.x版本的代码。

TODO

接下来会做一下几个模版引擎的横向对比,关于性能方面、开发难易程度、功能的完善上,各种balabala…

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏技术记录

通讯协议序列化解读(一) Protobuf详解教程

4717
来自专栏用户画像

浅析JVM

JVM是Java Virtual Machine(Java虚拟机)的缩写,JVM是一种用于计算设备的规范,它是一个虚构出来的计算机,是通过在实际的计算机上仿真模...

872
来自专栏蓝天

RPC的实现

RPC全称为Remote Procedure Call,即远过程调用。如果没有RPC,那么跨机器间的进程通讯通常得采用消息,这会降低开发效率,也会增加网络...

2103
来自专栏编程

大神用Python编写虚拟机解释器

群内不定时分享干货,包括最新的python企业案例学习资料和零基础入门教程,欢迎初学和进阶中的小伙伴入群学习交流 ? 环境介绍 环境采用带桌面的Ubuntu L...

2078
来自专栏java技术学习之道

JVM初探 -JVM内存模型

1604
来自专栏韩伟的专栏

框架设计原则和规范(完)

祝大家圣诞节快乐!有事没事别出门,外面太!挤!了! 此文是《.NET:框架设计原则、规范》的读书笔记,本文内容较多,共分九章,今天推送最后一章。 1. 什么是好...

2884
来自专栏丑胖侠

Zookeeper之开源客户端ZkClient

ZkClient是由Datameer的工程师开发的开源客户端,对Zookeeper的原生API进行了包装,实现了超时重连、Watcher反复注册等功能。 ZKC...

4575
来自专栏欧阳大哥的轮子

深入解构iOS系统下的全局对象和初始化函数

事件源于接入了一个第三方库导致应用出现了大量的crash记录,很奇怪的是这么多的crash居然没有收到用户的反馈信息! 在这个过程中每个崩溃栈的信息都明确的指向...

2052
来自专栏Android 研究

Retrofit解析5之代理设计模式

即Proxy Pattern,23种常用的面向对象软件设计模式之一。(设计模式的说法源自<设计模式>一书,原名<Design Patterns:Elements...

1363
来自专栏沈唁志

提高PHP编程效率的53个要点

2086

扫码关注云+社区

领取腾讯云代金券