传送门:https://github.com/xiangyuecn/BuildHTML

copy之前说点什么

html做点小功能(什么都没有),如果是要手动生成html这种操作,容易把代码搞得乱七八糟,如果使用模板并解析成html,就会简单很多。

演示:https://xiangyuecn.github.io/BuildHTML/

以下内容copy自README

BuildHTML用于前端HTML模板解析

这段代码是以前在多个项目中使用的(包括PC端、移动端、还有Android、IOS Hybrid App),代码简单轻巧,但功能一点都不简单。100行代码不到,Uglify压缩后1k大小(可选移除_eval后0.8k)。

演示地址:https://xiangyuecn.github.io/BuildHTML/

使用方法

一、引入代码

方法1:把代码直接复制到你项目的公共js文件中使用。

方法2:将代码文件引用到你的页面中<script src="buildhtml.js"></script>

二、解析使用

引入代码后有两个函数可用:BuildHTMLBuildHTMLArray,基本使用流程:

  1. 定义模板,推荐使用script text/template标签包裹文本数据(js模块化写法参考完整功能演示):
<script type="text/template" class="tp_action">
<div>
{name}第一次使用模板,请多多指教。({:slogan}){{::html}}
</div>
</script> <script>
var tp_action=$(".tp_action").html();
</script>
  1. 解析模板
var data={name:"豆豆",slogan:"<span style='color:green;font-size:12px'>面向大海春暖花开</span>"};
var html=BuildHTML(tp_action,data); data.html="{fn:BuildHTMLArray.index}";
var list=[data,data,data];
html+=BuildHTMLArray(tp_action,list);
  1. 显示解析后的数据
$("body").append(html);

模板语法

HTML模板内通过嵌入特定的语法来实现内容的自动生成。

所有嵌入的代码可读写o对象(为啥用o,o=object,一个字母简短啊),o对象为当前传入的数据对象(对象可以是object、数字、文本...);多个嵌入代码块之间如果需要传递变量数据,可以放入o对象中。

模板嵌入语法支持两类:

一、{{}}:前置处理语法

此语法会在{}语法之前执行,可实现:

  • 执行复杂代码返回结果
  • 动态生成{}语法
  • 定义内置模板(因为是前置处理,所以内置模板定义位置无关紧要)
  • 定义函数和变量
  • ...你想得到的作用

此语法支持三种写法:

1. {{变量名=多行文本}}

定义多行文本变量,无返回值;一般用于内置模板定义。

变量名称会赋值给o[变量名],比如{{_tp_=多行文本}},最终结果:o._tp_="多行文本"

2. {{:多行代码;返回纯文本}}

立即执行多行代码,并将返回的内容当做纯文本处理,如果有html会被转义,比如:{{:var i="<div>";i}}结果为<div>

注意:如果存在倒数第二行代码,代码结尾需要带;

其他地方无此要求,毕竟解析js代码格式是一件复杂的事情,加分号结尾省事的多。

3. {{::多行代码;返回html}}

立即执行多行代码,并原样返回内容;这个和{{:}}语法一致,只是这个对返回结果不会转义,用于返回html。比如:{{::var i="<div>";i}}结果为<div>

二、{}:简单语法

此语法求整个代码在一行,多行请使用前置处理语法。

此语法支持4种写法:

1. {fn:单行代码;返回纯文本}

执行一段代码,返回纯文本,如果有html会被转义。比如{fn:o.num=1;''} {fn:1+o.num}和{fn:var n=1+o.num;n}结果为 2和2

2. {fn::单行代码;返回html}

这个和{fn:}语法一致,只是这个对返回结果不会转义,用于返回html。

3. {属性;可选单行代码;返回纯文本}

读取o对象的属性值,返回纯文本,如果有html会被转义。比如:{name}表示取o.name作为返回值并转义。

属性后面可以跟复杂的表达式。比如:{num-100?'有':'无'}表示执行表达式o.num-100?'有':'无'作为返回值并转义。

此语法是基于{fn:}语法,只是自动在代码前面加了o.,简化了对对象属性的获取。

4. {:属性;可选单行代码;返回html}

这个和{属性}语法一致,只是这个对返回结果不会转义,用于返回html。

此语法是基于{fn::}语法,只是自动在代码前面加了o.,简化了对对象属性的获取。

方法文档

BuildHTML(tp,obj)

tp:html模板字符串。

obj:数据对象。

返回值:html结果。

BuildHTMLArray(tp,list,check)

tp:html模板字符串。

list:对象数组。

check:fn(item,index),检查函数,item为当前遍历到的对象,index为item在list中的索引,返回false可以停止遍历。

BuildHTMLArray.index

当前遍历的索引。

完整功能演示

js(丢浏览器控制台执行):

var tp=[

 '<div txt="{txt}" style="display:{disable?"none":"假装空白"}">'
,' 表达式文本:{txt}'
,' 表达式html:{:txt}'
,' 表达式html:{:txt.replace(/div/g,"p")}'
,' 函数返回纯文本:{fn:var d="加"+o.html;Date.now()+d}'
,' 函数返回html:{fn::o.html}'
,' 函数+内置模板(嵌套):{fn::BuildHTML(o._tp_,o)}'
,' 函数+内置模板+列表(嵌套循环):'
,' {fn::BuildHTMLArray(o._tp_,o.childs)}'
,'</div>' ,'定义内置模板(无返回值):{{_tp_='
,' <div>'
,' <span>{name}</span>'
,' </div>'
,'}}' ,'执行代码返回文本:{{:o.name'
,' +"<p>"'
,'}}' ,'执行代码返回html:{{::var p="<p>";'
,' o.name+p'
,'}}' ,'执行代码返回文本:{{:'
,' var c=0;'
,' for(var i=0;i<1000;i++){'
,' if(i%3)c++;'
,' };'
,' c'
,'}}!哈' ].join('\n'); BuildHTML(tp,{
disable:false
,txt:"内容<div>"
,html:'<i>html</i>' ,name:"小视频<i>"
,childs:[{name:"土豆<i>"},{name:"爱奇艺"}]
});

结果

<div txt="内容<div>" style="display:假装空白">
表达式文本:内容<div>
表达式html:内容<div>
表达式html:内容<p>
函数返回纯文本:1528680191658加<i>html</i>
函数返回html:<i>html</i>
函数+内置模板(嵌套):
<div>
<span>小视频<i></span>
</div> 函数+内置模板+列表(嵌套循环): <div>
<span>土豆<i></span>
</div> <div>
<span>爱奇艺</span>
</div> </div>
定义内置模板(无返回值):
执行代码返回文本:小视频<i><p>
执行代码返回html:小视频<i><p>
执行代码返回文本:666!哈

缩小js文件

BuildHTML用Uglify压缩后1k大小,如果你对列表使用无多少要求,可以把对列表解析优化部分移除,然后变成了0.8k。

移除方法:删除代码后段_eval部分,把代码中两处引用_eval(x)()的代码改成eval(x)即可,结果:损失了eval解析缓存,仅仅影响列表性质的模板解析速度,因为没有缓存了,每次都要调用重量级的eval或Function。

插曲:优化历史

  1. 最早版本是只支持{}语法,{{}}前置处理语法是后面加的,最老版本只有不到20行代码,不过也很好用。

  2. _eval缓存是在{{}}语法之后加的,主要针对列表这种反复调用相同模板的性能优化,经过两次优化测试:

第一次、全部把模板解析成一个函数并缓存此函数,以后每次调用都使用此函数,省去了解析过程。结果:列表性能大幅提升,只使用一次的模板解析性能下降明细,svn提交记录:

BuildHtml升级成编译成函数模式,列表build效率大幅提升,测试:将近50倍,单个build速度下降3倍

第二次、eval增加缓存,列表性能大幅提升,但比解析成函数慢一倍,不过整体很强劲(证实了:正则表达式替换开销与函数执行开销慢不了多少),svn提交记录:

BuildHtml重新优化,只改造eval部分,其余不动,列性build能比函数化的慢一倍,但比原始的快20倍,单个build和原始差不多,相对来说比函数化的强

测试结果:
原始
2842.516ms
3365.878ms eval缓存
124.680ms
3725.948ms 函数化
60.350ms
8512.252ms 测试代码:
for(var i=0;i<10000;i++){
BuildHtml(tp);
}
console.timeEnd(1); console.time(1);
for(var i=0;i<10000;i++){
BuildHtml('<div class="{cls+'+Math.random()+'}">{html+'+Math.random()+'}{fn:FormatDate()+'+Math.random()+'}</div>');
}
console.timeEnd(1);

1kb的前端HTML模板解析引擎,不限于嵌套、循环、函数你能想到的解析方式的更多相关文章

  1. 一个前端html模板处理引擎(javascript) - pure

    做后台开发(java/python)的同学开发web应用,对于前端页面生成技术并不陌生,像jsp,freemark等.开发UGC类型的互联网站,因为要SEO友好,所以一般都会在后台用模板引擎直接生成好 ...

  2. Handlebars的基本用法 Handlebars.js使用介绍 http://handlebarsjs.com/ Handlebars.js 模板引擎 javascript/jquery模板引擎——Handlebars初体验 handlebars.js 入门(1) 作为一名前端的你,必须掌握的模板引擎:Handlebars 前端数据模板handlebars与jquery整

    Handlebars的基本用法 使用Handlebars,你可以轻松创建语义化模板,Mustache模板和Handlebars是兼容的,所以你可以将Mustache导入Handlebars以使用 Ha ...

  3. SpringBoot项目的前端+thymeleaf模板引擎

    SpringBoot项目创建之后,后台的框架是SpringMVC.但前端的resource和template目录都是空的.这个时候需要创建前台页面. 习惯上,我们会创建JSP,但是,SpringBoo ...

  4. 再谈前端HTML模板技术

    在web2.0之前,写jsp的时候虽然有es和JSTL,但是还是坚持jsp.后面在外包公司为了快速交货,还是用了php Smart技术. web2.0后,前端模板技术风行. 代表有如下三大类: Str ...

  5. javascript解析引擎(每天有学习一点篇)

    ======================================================= 有一段时间,经常耳闻web前端的福音,对高性能的V8议论纷纷. 其实对js解析引擎没有深 ...

  6. 前端javascript模板

    doT.js——前端javascript模板引擎问题备忘录 我手里维护的一个项目,遇到一个问题:原项目的开发人员在Javascript中,大量的拼接HTML,导致代码极丑,极难维护.他们怎么能够忍受的 ...

  7. 前端渲染模板(一):Thymeleaf

    一.使用 本篇文章将以SpringBoot为框架来介绍Thymeleaf的用法. 1 资源文件的约定目录结构  Maven的资源文件目录:/src/java/resources spring-boot ...

  8. [Vue 牛刀小试]:第十七章 - 优化 Vue CLI 3 构建的前端项目模板(1)- 基础项目模板介绍

    一.前言 在上一章中,我们开始通过 Vue CLI 去搭建属于自己的前端 Vue 项目模板,就像我们 .NET 程序员在使用 asp.net core 时一样,我们更多的会在框架基础上按照自己的开发习 ...

  9. HTML解析引擎:Jumony 开源项目

    Jumony Core首先提供了一个近乎完美的HTML解析引擎,其解析结果无限逼近浏览器的解析结果.不论是无结束标签的元素,可选结束标签的元素,或是标记属性,或是CSS选择器和样式,一切合法的,不合法 ...

随机推荐

  1. jpa 联表查询 返回自定义对象 hql语法 原生sql 语法 1.11.9版本

    -----业务场景中经常涉及到联查,jpa的hql语法提供了内连接的查询方式(不支持复杂hql,比如left join ,right join).  上代码了 1.我们要联查房屋和房屋用户中间表,通过 ...

  2. [20180705]关于hash join 2.txt

    [20180705]关于hash join 2.txt --//昨天优化sql语句,执行计划hash join right sna,加入一个约束设置XX字段not null,逻辑读从上万下降到50.- ...

  3. django模板语言之Template

    当前端的一些数据需要后端传送过来并展示时,用到了django的模板语言,模板语言的作用就是,在后端把一些处理好的数据,通过模板语言所规定的格式,通过render渲染,放到前端页面固定的位置展示.这之间 ...

  4. javascript打印1-100内的质数

    <script> /* 质数定义: 质数(prime number)又称素数,有无限个. 质数定义为在大于1的自然数中,除了1和它本身以外不再有其他因数. 1不是质数 */ //声明变量 ...

  5. oracle FLASHBACK TABLE

    闪回表 -- 开启行迁移 ALTER TABLE employees_test ENABLE ROW MOVEMENT; UPDATE employees_test SET salary = sala ...

  6. Python基础知识:列表

    1.pop(i)删除列表任意位置元素,并继续使用它,如果括号为空,默认删除末尾 #pop()函数 guests=['Liming','Liuhan','Hanjieming'] for guest i ...

  7. 【PAT】B1072 开学寄语(20 分)

    代码注释应该很清晰 先存下违禁品,放到数组中,未使用map #include<cstdio> #include<string.h> int wupin[10],N,M; boo ...

  8. iris数据集(.csv .txt)免费下载

    我看CSDN下载的iris数据集都需要币,我愿意免费共享,希望下载后的朋友们给我留个言 分享iris数据集(供学习使用): 链接: https://pan.baidu.com/s/1Knsp7zn-C ...

  9. January 21st, 2018 Week 3rd Sunday

    Your attitude, not your aptitude, will determine your altitude. 决定你人生高度的,不是你的才能,而是你的态度. Actually, at ...

  10. 指令计数器--Program counter

    别名:指令指针.指令地址寄存器.程序计数器: 操作:顺序操作(计数器加一).分支操作(计数器修改): The program counter (PC), commonly called the ins ...