浅谈EJS

发表于 |

  在知乎看了许多“关于nodejs的模板引擎，如何选择EJS和Jade？”这个问题的回答，对EJS和Jade有了大概的的初步印象，也基本了解到了swig这个模板。EJS的结构更像HTML，但是Jade更加简洁，swig的特性还是不大了解。鉴于自己处于入门级，然后选择EJS的人也比较多，所以就找了EJS的一些资料进行学习。下面是一些个人的理解和一些供自己以后参考的笔记。

什么是EJS

  简单来说EJS就是一个JavaScript模板库，用来从JSON数据中生成HTML字符串。

为什么要使用EJS

  与最初的JavaScript相比较，一些不太了解你的代码的人可以更容易地通过EJS模板代码看得懂你的代码。

  这里我找了一个比较浅显易懂的例子：

  这是用javascript实现的代码

1
2
3
4
5
6
7
8
9
10
var html = "<h1>"+data.title+"</h1>"
html += "<ul>"
for(var i=0; i<data.supplies.length; i++) {
    html += "<li><a href='supplies/"+data.supplies[i]+"'>"
    html += data.supplies[i]+"</a></li>"
}
html += "</ul>"

  最终要实现的效果如下

  但是上面的代码看起来很乱，虽然实现了功能，但是不容易让人弄懂，而且HTML结构完全在JavaScript代码中丢失。

  下面学习EJS同样实现上面的功效，它的工作原理如下：

  使用EJS来找回你的明确、维护性良好的HTML代码结构。注:data是json对象，不能使json字符串。

  在HTML中引入EJS,以使javascript能够使用它，引入EJS的语句如下：

<script type="text/javascript" src="/js/ejs.js"></script>

  创建一个EJS模板,命名为cleaning.ejs文件，内容如下

1
2
3
4
5
6
7
8
<h1><%=title %></h1>
<ul>
<%  for ( var  i=0; i<supplies.length; i++) { %>
    <li>
   <a href= 'supplies/<%=supplies[i] %>' ><%= supplies[i] %></a>
    </li>
<% } %>
</ul>

  HTML文档如下，引入EJS,并创建EJS对象，然后调用EJS对象成员函数解析JSON对象到模板中。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
< html >
< head >
< script  type = "text/javascript"  src = "/js/ejs.js" ></ script >
< script  type = "text/javascript" >
    function myfunction(){
        var data='{"title":"cleaning","supplies":["mop","broom","duster"]}'
        var html = new EJS({url: 'cleaning.ejs'}).render(JSON.parse(data)) //JSON.parse(data) 把JSON字符串解析为原生的javascript值
        alert(html);
        document.getElementById("div1").innerHTML=html;
    }
</ script >
</ head >
< body >
    <button  onclick = "myfunction()" >点击</button>
    < div  id = "div1" ></ div >
</ body>
< html >

  从上面这个例子我们可以看到EJS模板的基本用法

EJS的语法和功能：

1、缓存功能，能够缓存已经解析好的html模版；

2、<% code %>用于执行其中javascript代码，如：

<% alert('hello world') %>

3、<%= code %>会对code进行html转义；

  下面是一些语法例子：

1
2
3
4
5
6
7
8
<!-- 把title里面存的值给显示出来在h1中。 -->
<h1><% =title %></h1>
<!-- 把hello world显示在h1中。 -->
<p><% ='hello world' %></p>
<!-- 把hello world变粗，然后显示在h1中。 -->
<h1><% ='<b>hello world</b>' %></h1>

4、<%- code %>将不会进行转义；这一行代码不会执行，像是被注释了一样，然后显示原来的html。也不会影响整个页面的执行。

<h1><%-title %>asd</h1>           最后显示asd，及显示原网页
<p><% #'hello world' %>asd</p>   最后显示asd，及显示原网页

5、EJS里，默认的闭合标记是 <% .. %>，我们也可以通过app.set()定义自己的标签。例如：

1
2
3
4
5
6
app.set("view options",{
   "open":"{{",
   "close":"}}"
});

6、一些辅助函数，用于模版中使用(留着用来供查阅使用)

1)、first，返回数组的第一个元素；
2)、last，返回数组的最后一个元素；
3)、capitalize，返回首字母大写的字符串；
4)、downcase，返回字符串的小写；
5)、upcase，返回字符串的大写；
6)、sort，排序（Object.create(obj).sort()？）；
7)、sort_by:’prop’，按照指定的prop属性进行升序排序；
8)、size，返回长度，即length属性，不一定非是数组才行；
9)、plus:n，加上n，将转化为Number进行运算；
10)、minus:n，减去n，将转化为Number进行运算；
11)、times:n，乘以n，将转化为Number进行运算；
12)、divided_by:n，除以n，将转化为Number进行运算；
13)、join:’val’，将数组用’val’最为分隔符，进行合并成一个字符串；
14)、truncate:n，截取前n个字符，超过长度时，将返回一个副本
15)、truncate_words:n，取得字符串中的前n个word，word以空格进行分割；
16)、replace:pattern,substitution，字符串替换，substitution不提供将删除匹配的子串；
17)、prepend:val，如果操作数为数组，则进行合并；为字符串则添加val在前面；
18)、append:val，如果操作数为数组，则进行合并；为字符串则添加val在后面；
19)、map:’prop’，返回对象数组中属性为prop的值组成的数组；
20)、reverse，翻转数组或字符串；
21)、get:’prop’，取得属性为’prop’的值；
22)、json，转化为json格式字符串

7、利用<%- include filename %>加载其他页面模版；

使用创建好的EJS模板

  基于我们之前写的模拟生成一个EJS对象

new EJS({url: 'cleaning.ejs'})

  对象有下面两个成员函数

ejs.compile(str, options); //将返回内部解析好的Function函数 
ejs.render(str, options); //返回经过解析的字符串

  ejs的render函数有两个参数 第一个是字符串，第二个是可选的对象，和其他javascript模版一样需要渲染的数据也是包含在option对象中的。

ejs.render(str,option); // 渲染字符串 str 一般是通过nodejs文件系统的readfile方法读取 ejs.render(str,{data : user_data // 需要渲染的数据});

其中options的一些参数为:

1、cache：是否缓存解析后的模版，需要filename作为key；
2、filename：模版文件名；
3、scope：complile后的Function执行所在的上下文环境；
4、debug：标识是否是debeg状态，debug为true则会输出生成的Function内容；
5、compileDebug：标识是否是编译debug，为true则会生成解析过程中的跟踪信息，用于调试；
6、client，标识是否用于浏览器客户端运行，为true则返回解析后的可以单独运行的Function函数；
7、open，代码开头标记，默认为’<%’；
8、close，代码结束标记，默认为’%>’；
9、其他的一些用于解析模版时提供的变量。

EJS的应用场所

1、用JavaScript创建HTML字符串 正如我们在新手教程中所讨论的，在JavaScript中拼字符串的缺点是可维护性不好。当你在JavaScript中将这些字符串拼到一起时，很难看出你正在写的HTML是什么---你页面展现的结构过于混乱。而使用EJS模板可以让你通过代码的空行和缩进来清楚地展现出你的HTML。

2、基于WebService的AJAX网站开发 EJS可以接收WebService异步传送过来的JSON格式的数据，将这种数据直接传入你的模板里，然后将结果插入到你的页面中。你所需要做的只是通过以下代码

new EJS({url: 'comments.ejs'}).update('element_id', '/comments.json')
谢谢你请我吃糖果