一个不成熟的模板引擎思路

原创 2017年06月13日 16:38:45

关于模板,我倒是用过了不少。最开始要数Java的JSP了,然后接触了PHP的smarty,再就是Python的jinja2, Django内置模板,现在刚开始看Nodejs,也发现了不少类似的模板引擎,ejs, jade等等吧。

模板带来的最直接的好处就是加速开发,前后端分离。除此之外,对于字符串的格式化同样是个比较好的应用。习惯了Python中

string = "hello {}".format("郭璞")  # hello 郭璞
string = "hello {username}".format(username="郭璞") # hello 郭璞

这样简便的用法,突然来到nodejs中,没有了这类特性的原生支持,写起来打印语句就老是觉得很别扭,一点都不优雅。然后我就想自己做一个实现上述功能的工具函数,方便自己的使用。然后就想到了模板这一个方向,虽然想法还不够成熟,甚至是有点拙略,但是“灵(瞎)感(闹)”还是得记录一下不是。


Function对象

JavaScript中有这么一个神奇的对象,那就是Function。如果函数体符合语法要求,那么你就可以动态创建出一个自己的函数出来。下面来个简单的小例子。

无参模式

function create_function(){
    var func_body = "var time = new Date(); console.log('创建时间:'+time);";
    var func = new Function('', func_body);
    func();
}
create_function();

运行结果如下:

E:\Code\Nodejs\learn\my-work\string>node one.js
创建时间:Tue Jun 13 2017 15:40:15 GMT+0800 (中国标准时间)

E:\Code\Nodejs\learn\my-work\string>

有参模式

刚才演示了一个无参数的情况,那么有参数的情况如何呢?

function create_function_with_parameters() {
    var param1 = "郭璞";
    var param2 = "辽宁大连";
    var func_body = "console.log('Hello '+param1+', welcome to '+param2+'!' );";
    var func = new Function('param1', 'param2', func_body);
    func(param1, param2);
}
create_function_with_parameters();

同样的运行结果如下:

E:\Code\Nodejs\learn\my-work\string>node one.js
Hello 郭璞, welcome to 辽宁大连!

E:\Code\Nodejs\learn\my-work\string>

到这里,关于Function的内容就算是铺垫完成了。只需要了解这


正则

探究模板的真实原理,有些语言中是编译型的,有些是替换型的。但是不管是哪种类型,都离不开出变量关键字这个步骤。而这个过程用正则表达式基本上是最好的方法了。所以需要掌握一点相关的技巧。

如何表达?

在Nodejs中,使用正则表达式有两种形式:

  • 字面量: /pattern/flags
  • RegExp: new RegExp(pattern, flags)

关于正则表达式的具体的规则,鉴于篇幅很长,这里就不再赘述了。有兴趣的可以浏览下面的这篇文章。
http://www.cnblogs.com/chenmeng0818/p/6370819.html

需求获取

根据一开始的设想,目标是获取{{}}{%%} 这种语法下的变量名称,然后替换成对应的变量值。 因此可以写出如下的正则表达式:

var pattern1 = /{{([\s\S]+?)}}/gi;
// 或者
var pattern2 = /{%([\s\S]+?)%}/gi;

默认规则如下:

  • {{}} 中直接替换为变量名对应的值。
  • {%%} 中的则是可以添加到函数体的代码块,要保留起来。

简易实现

下面简单的对照着实现一下。

直接变量形式

function test1(){
    var tpl = "Hello {{visitorname}}, Welcome to {{worldname}}!";
    var data = {
        visitorname: "游客",
        worldname: "冰雹工作室"
    };
    var pattern = /{{([\s\S]+?)}}/gi;
    var result = tpl.replace(pattern, (match, tuple)=>{
        return data[tuple];
    });

    console.log("渲染后的数据为:\n", result);
}

实现结果:

E:\Code\Nodejs\learn\my-work\string>node one.js
渲染后的数据为:
 Hello 游客, Welcome to 冰雹工作室!

E:\Code\Nodejs\learn\my-work\string>

对象形式

function test2(){
    var tpl = "I'm {{user.name}}, and I come from {{user.address}}";
    var user = {name: "郭璞", address: "辽宁大连"};
    console.log(user.name);
    var pattern = /{{([\s\S]+?)}}/gi;
    var result = tpl.replace(pattern, function(match, tuple, offset){
       return eval(''+tuple);
    });
    console.log(result);

}

运行效果:

E:\Code\Nodejs\learn\my-work\string>node one.js
郭璞
I'm 郭璞, and I come from 辽宁大连

E:\Code\Nodejs\learn\my-work\string>

混杂多参数实现

刚才实现了只有关键字的和有对象性质的参数的例子,但是实际中情况可能比这要复杂的多,比如混杂模式。接下来着手实现一下混杂模式下的替换策略。

function test3(){
    var tpl = "I am {} of {} years old, and I come from {user.address}.";
    var name = '郭璞';
    var index = 0;
    var paramindex = 0;
    // var parameters = [{name: '郭璞'}, {'age': 22}, {address: '辽宁大连'}];
    var parameters = ['郭璞', 22, {user: {address: '辽宁大连'}}];
    console.log(parameters[2]);
    var result = tpl.replace(/{([\s\S])*?}/gi, function(match, tuple, offset){
        console.log('match:', match);
        console.log('tuple: ', tuple);
        tpl = tpl.slice(index, offset);
        index = offset + match.length;
        paramindex += 1;

        var temp = parameters[paramindex-1];
        if(match.length > 2){
            // 使用tuple不能正确获取到标记中相关的变量名,故用match来代替.
            match = match.slice(1, match.length-1);
            return eval('parameters[paramindex-1].'+match);
        }else{
            return temp;
        }
        // return parameters[paramindex-1];
    });
    console.log(result);
}

运行结果如下:

E:\Code\Nodejs\learn\my-work\string>node one.js
{ user: { address: '辽宁大连' } }
match: {}
tuple:  undefined
match: {}
tuple:  undefined
match: {user.address}
tuple:  s
******* s
I am 郭璞 of 22 years old, and I come from 辽宁大连.

E:\Code\Nodejs\learn\my-work\string>

关于正则这块,大致的内容就是这样了。如果要想更简单的调用,只需要封装起来,用外部参数代替就好了。

当然,注意变量名的命名风格。


实战

废话连篇说了两个小节,还没到正式的模板制作。下面就整合一下刚才例子。模拟着实现一下好了。

(!完整)代码

来个不完整的代码,示意一下算了。

/**
 * 通过正则表达式和Function语法创建一个简单的模板引擎。
 */

const pattern = /{{([\s\S]+?)}}|{%([\s\S]+?)%}|$/img;

function template(text, params, name) {
    // 声明最终要返回的解析好的文本串,也就是构造Function所需的函数体部分。
    var func_body = '';
    // 函数体里面最终效果是返回一个代表了解析完成的字符串的变量,因此要声明一个出来
    func_body += 'var parsedstr="";';
    func_body += 'parsedstr+="';
    // 设置一个定位器,每次更新偏移量,进行全文替换工作
    var index = 0;
    // 开始正则匹配,根据捕获到的元组进行剖析
    text.replace(pattern, function (matchedtext, interpolate, evaluate, offset) {
        // 匹配到正常的HTML文本,则直接添加到func_body中即可
        func_body += text.slice(index, offset);

        // 如果是evaluate类型的文本,则作为代码进行拼接
        if (evaluate) {
            func_body += '";' + evaluate + 'parsedstr+="';
        }

        // 匹配到interpolate类型的文本,则作为变量值进行替换
        if (interpolate) {
            func_body += '"+' + interpolate + '+"';
        }

        // 更新偏移量index,让程序向后移动
        index = offset + matchedtext.length;
        // 貌似返回值没什么用吧
        return matchedtext;
    });

    // 完成函数体的构建之后就可以调用Function的语法实现渲染函数的构建了
    func_body += '"; return parsedstr;';

    return new Function('obj', 'name', func_body)(params, name);
}

function test() {
    var obj = [
        { text: '张三' },
        { text: '李四' },
        { text: '王五' },
        { text: '赵六' },
        { text: '韩七' },
        { text: '王八' }
    ];
    var name = '郭璞';


    var fs = require('fs');
    // var rawtext = fs.readFileSync('index.html').toString('utf8');
    var rawtext = '<ul>{%for(var i in obj){%}<li>{{ obj[i].text }}</li><br>{%}%}</ul>';
    console.log("源文件:", rawtext);
    var result = template(rawtext, obj);
    console.log("渲染后文件:", result, name);
    fs.writeFileSync('rendered.html', result);
    console.log('渲染完毕,请查看rendered.html文件')
}

test();

同级目录下生成的文件内容为:

<ul>
    <li>张三</li><br>
    <li>李四</li><br>
    <li>王五</li><br>
    <li>赵六</li><br>
    <li>韩七</li><br>
    <li>王八</li><br></ul>

感觉效果还行,但是这里面参数太固定化了,实际封装的时候还需要酌情指定,不然这东西也就没什么卵用。

总结

要是论实用性价值的话,这个不成熟的模板实现思路毫无价值。但是对于我而言,用来格式化字符串倒是个不错的选择,估计我会把这个小思路封装成一个小小的模块,详情可以关注我的GitHub的这个链接。

https://github.com/guoruibiao/have-fun-in-node

版权声明:本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。转载时请标注http://blog.csdn.net/marksinoberg.

相关文章推荐

1. Rccp简明教程(关于R与C++的混合使用方法)

Rcpp简明指南: R调用C++ 张金龙 注: 本文需要读者了解: (1) R函数的基本知识 (2) 编写R程序包 (3) C++的基础知识, 包括 类, 以及namespace等。 为什...

递归调用效率问题,递归与循环比较

1.所谓的递归慢到底是什么原因呢? 大家都知道递归的实现是通过调用函数本身,函数调用的时候,每次调用时要做地址保存,参数传递等,这是通过一个递归工作栈实现的。具体是每次调用函数本身要保存的内容包括:...

Velocity 是一个基于 Java 的模板引擎

1、定义变量,必须用#set()#set($length=$!{velocityCount})2、判断的使用#if #else #end #if($lev) #set($i=...

一个Javascript模板引擎的实现和优化

让我们从一段代码说起,假设有一段这样的JSON数据: var json={ name:"流火", blog:"www.hujuntao.com"}; 我们需要根据这段JSON生成这样的HTML代码...

用Python做一个模板引擎玩具

如果你曾经好奇模板引擎是怎样工作的,那么现在我们一起来构建一个简单的模板引擎,探索它的工作流程吧。...
  • tiwoo
  • tiwoo
  • 2015年07月17日 00:24
  • 333

【分享/转】用js写一个模板引擎

模板引擎在前后端都能用到,但是通过作为前端,我们只需要一些简单的模板引擎。先上代码: 模板引擎 Today: { date } ...

一个基于velocity模板引擎的代码生成器

之前在论坛看到一个.NET的代码生成器,挺好的。 话说一千个程序员手中有一千种代码生成器,因此我也来分享一个,多多少少能对大家有所帮助。 首先介绍下,这个代码生成器是一个java web项目。...

写了一个简单实用的PHP模板引擎

PHP模板引擎很多,但要么很庞大,要么效率很低,如果只是要实现PHP代码与程序分离,就只要一个简单的模板引擎就行了。今天抽空写了一个。 xt.class.php   /*  * Cre...
  • xylweb
  • xylweb
  • 2011年10月09日 13:57
  • 272

打造一个自己的模板引擎(四)

接下来我们要写几个扩展标签,使其支持动态include. 在前面我们的编译器会支持静态include,静态包含是把要包含的文件在编译期就包含进来一起编译。 动态包含是在运行期调用模板引擎编译并执行一个...

Juicer – 一个Javascript模板引擎的实现和优化

Juicer – 一个Javascript模板引擎的实现和优化 让我们从一段代码说起,假设有一段这样的JSON数据: var json={ name:"流火", blog:"benbe...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:一个不成熟的模板引擎思路
举报原因:
原因补充:

(最多只允许输入30个字)