ejs模板

7 Jan

现在整理ejs模板有点太old school了,而且实际使用下来感觉没有jade模板便利(纯属个人爱好),但公司有的项目中有用到ejs,日常还是需要做点维护的,因此抽个时间整理一下ejs。

  • 安装与使用
  • options
  • 标签
  • include
  • 过滤器
  • 自定义分隔符

安装与使用

安装TJ大神的ejs模板的安装非常简单:

npm install ejs

使用的话,先定义ejs模板:

<% if (user) { %>
  <h2><%= user.name %></h2>
<% } %>

用compile API加载ejs模板:

var ejs = require('ejs');
…
var template = ejs.compile(str, options);   	// compile的返回值是一个function
template(data);

也可以用render API来加载ejs模板,两种方式是等价的:

var ejs = require('ejs');
…
ejs.render(str, data, options);  	// render的返回值是最终结果string

options

无论是compile还是render都有参数options,用于指定如何加载ejs模板:

cache:true, 		//是否对结果进行缓存(需要filename)
filename:"path",	//cache的key,用于include指令中
scope:"this", 		//指定函数执行的上下文对象
debug:true, 		//输出生成的函数体
compileDebug:false, 	//为false时,debug指令不会被编译
client:"", 		//返回独立的编译后的函数
open:"<%", 		//指定开标签 
close:"%>", 		//指定闭标签 

标签

模板的核心就是标签了,如果你用过世界上最好的语言PHP,那对这种方式一定不会陌生:

<% %>		//普通流程标签
<%= %>		//输出转义后的HTML标签。例如<div>Hello</div>输出后会变成<div>Hello</div>
<%- %>		//输出不转义的HTML标签
<%# %>		//注释标签,不会被执行,也不会被输出
-%>		//去掉后面的换行符

include

如果你定义了一段ejs模板作为公共模板,现在想引用这段公共模板的话,可以用include指令,需要在options里指定filename,否则指令不知道去哪个地方找文件。例如你有./views/users.ejs和./views/user/show.ejs。你要在users.ejs里引入show.ejs可以:

<ul>
  <% users.forEach(function(user){ %>
    <%- include('user/show', {user: user}) %>	//用<%-避免二次转义
  <% }) %>
</ul>

也可以将路径作为参数传入include指令:

<%- include(somePath) %>

过滤器

用于将结果进一步加工的API,例如ejs模板:

<p><%=: users | map:'name' | join %></p>	//注意起始的:和中间的|标记

加载该ejs模板:

ejs.render(str, {
    users: [
      { name: 'tj' },
      { name: 'mape' },
      { name: 'guillermo' }
    ]
});
// 结果是:<p>Tj, Mape, Guillermo</p>

TJ大神的ejs模板提供了以下过滤器API:

first			//返回数组的第一个元素
last			//返回数组的最后一个元素
capitalize		//返回首字母大写的字符串
downcase		//返回小写字符串
upcase			//返回大写字符串
sort			//排序
sort_by:'prop'		//根据指定的属性排序
size			//返回字符串长度
length			//返回数组长度
plus:n			//加上n,并转为Number进行运算
minus:n			//减去n,并转为Number进行运算
times:n			//乘以n,并转为Number进行运算
divided_by:n		//除以n,并转为Number进行运算
join:','		//将数组用指定的字符合并成字符串
truncate:n		//截取前n个字符,超过长度时,返回一个副本
truncate_words:n	//截取字符串前n个word(word用空格分隔)
replace:pattern,substitution	//字符串替换,substitution不提供将删除匹配的子串
prepend:val		//将val添加在字符串前面
append:val		//将val添加在字符串后面
map:'prop'		//返回数组中属性为prop的value组成的数组
reverse			//反转数组或字符串
get:'prop'		//获取属性为prop的value

自定义分隔符

恕我浅薄,实在想不出有什么应用场景。如果你对ejs默认的<% %>觉得审美疲劳,你可以自定义开闭标签,例如定义成<? ?>:

ejs.open = '<?';
ejs.close = '?>';

<h1><?= title ?></h1>

或定义成{{ }}:

ejs.open = '{{';
ejs.close = '}}';

<h1>{{= title }}</h1>

总结

除了TJ大神的ejs模板,还有其他版本的ejs,都大同小异。在例如Node,Express等开源项目中都能见到ejs的身影,为前后端分离做出了很大的贡献。我个人感觉Jade更简洁易读,但也看到Web上很多人不同意这个观点,这纯属个人爱好。所以在公司的项目中,同时使用Jade和ejs ^_^

评论(2)

  1. 不太喜欢用锁进表示语义的语言,比如:jade,stylus,python 等。
    现在项目会有 jade 的原因是当初我接手的项目有 stylus,样式定义和 html 结构不一致,看起来比较麻烦,而且我又需要一个模版工具,于是选择了 jade/pug,这个可以让 html 结构和 stylus 结构保持一致。
    随着工程项目的越来越大,我发现 jade 构建是最耗时的,导致开发效率下降,这时候有了舍弃的想法。
    随着公司统一了 less 的使用,变成了现在这样的 html + less 的结构。
    说到模版,原先有个 tpl 的工具,是公司内部大神写的,但是开发体验太差,因为编辑器根本不认识这个语法。所以我选择了一个最小巧优雅,又能被编辑器支持的外部开源库:ejs。
    当然这个选择需要解决如何在现有的构建工具体系中集成的问题,还好原先的 tpl 也是编译成文本再 require 的,改成 ejs 成本并不是很大。

    • 原来是这方面考虑(html和css的结构一致性)的原因,学习了。其他方面如构建速度等,能力有限,我暂时还没能体会出优劣。主要觉得jade和stylus写起来更能偷懒,能少敲几个字符(公司大神好多…以前代码写少了,现在要加倍努力才行…)

Leave a Reply

Your email address will not be published. Required fields are marked *