Golang模板编译引擎FET

在实际工作中,越来越多的新项目开始用go语言进行开发,如果是前后端分离的项目,对于前端开发人员来说,后端使用php或者go亦或者node等影响不是特别大。但如果是项目对SEO\兼容性有要求、需要采用同步渲染的方式的话,就少不了与golang的模板引擎打交道。于是问题来了,该选用哪个模板引擎呢?

如果你是个python使用者,那么pongo2这个模板引擎应该不错。又或者你习惯mustache语法,那么可以看看mustache,当然如果考虑性能,习惯比较原生的语法的,hero这个模板引擎应该是个不错的选择。

但如果你是个php使用者,写惯了smarty,而且服务端更喜欢使用html/template官方模板语言包的话,FET应该就是个不错的选择了。

官方html/template包提供的模板功能要有的基本都有了,BUT:

1、不支持表达式,比如判断a>10 && a<100,你得这样写:and (gt a 10) (lt a 100),感觉一下子从写高级语言降级到底层语言的感觉。

2、作用域范围:define和block为模板继承、包含提供了支持,可是其作用域均限制在template引用时提供的唯一参数内。这表示你的自定义变量要传递进去,必须自定义一个方法可以将自定义变量和页面数据合并,然后将合并的数据作为参数传递,最终你的代码大概就长这样了:{{template "xxx" (func . "a" $a "b" $b)}},其中func是你自定义的合并数据的方法,a和b是你想传递到define模块内的自定义变量。

3、多层级数据判断:官方并没有提供一个简单的方法来判断多层级数据字段是否存在,比如a.b.c.d,直接用{{if a.b.c.d}}{{a.b.c.d}}{{end}},如果数据在a后面空了,页面就会停止渲染。所以为了兼容,可能会看到这样的代码:{{if a}}{{if a.b}}{{if a.b.c}}{{if a.b.c.d}}{{a.b.c.d}}{{end}}{{end}}{{end}}{{end}},有点前端回调地狱的感觉。

4、基础方法太少:基本的数学运算符都没有内置函数提供支持,更不用说一些常用的截字、原html代码输出、时间格式处理等等的了。

5、语法高亮:对于开发者,特别是习惯于用vscode/sublime等的前端同学,没有对应支持的语法高亮插件,代码看起来实在费力,很影响开发体验。

6、渲染模板时的parseFiles方法作为实现继承、包含模板的主要api,居然要提供包含或继承模板的模板路径,这让前后端对模板的命名完全耦合了。所以这个api显得比较鸡肋,大部分都靠parseGlob方法来加载所有模板,不知道对性能有没有影响,至少看上去它不是按需加载的。

以上的这些问题很容易就让人从了解到放弃了,所以经常看到有人在吐槽go的时候,都会加一条,模板很难用,也就不足为怪了。

哪里有不便,哪里便会创造需求。这便是会出现FET的背景。

FET使用smarty基本完全一致的语法,并将整个代码构建成html/template原生代码。针对以上遇到的问题,一一做了以下处理。

1、添加了对表达式语法的支持,所以现在直接写 a > 10 && a < 100,忘记那种别扭的函数式嵌套写法吧。

2、继承使用"extends"、包含使用"include",最终所有的模板文件都只会生成唯一一个文件,所有include的代码都会直接包含在当前页面文件里,所以这样在include父文件里声明的变量都可以直接使用,同时include内的模板通过对变量添加特殊后缀实现对父模板的隔离。

3、多层级判断:添加了empty方法和自定义的index方法,这样获取{{a.b.c.d}}时,即使不做判断,也不会阻断输出,当然其它的一些逻辑判断还是需要借助empty方法等。

4、基础方法:添加了基础的运算符方法,这样你的表达式里就可以使用 (a + 1) / (b - 2) * (c - 3) ** (d % 4) 这些复杂的表达式了。另外,常见的截字方法truncate,字符串拼接concat,数字千分位number_format等等都内置在内了。

5、语法高亮:本想自己写个vscode插件的,发现太费事,就直接用对应的smarty插件了

6、渲染模板:由于最终只有一个文件,所以用parseFile或者内置的Display方法都可以,当然如果你是用的parseGlob,注意fet实例化的时候将Glob参数设为true。这样编译的时候就会将当前文件的相对路径做为define的标识名称,比如pages/index.html,编译完后会生成{{define "pages/index"}}{{end}。这样按规则使用就可以了。

7、扩展支持:

(1)原生的html/template里没有for标签,在fet里做了支持。不过需要注意的是,foreach和for里都不能使用break和continue关键字,因为原生的range也不支持。这个后续将继续思考有没有好的解决方案。

(2)基于define实现了capture,但是不支持assign到变量里,或者append到数组里

(3)include标签里也支持添加属性变量

(4)数字可以写成0b001,0o777,0xffffff,1e10等形式

(5)字符串里支持变量转义符:如{{$say = "hello"}}{{"`$say` world!"}}将输出hello world!

更多的功能仍在完善中。

目前项目在github的地址是:https://github.com/fefit/fet

也提供了简单的模板实时编译命令行fetc,可以通过执行`fetc init`方法来初始化项目配置,通过`fetc watch`命令来监控项目文件变更,实时编译成html/template代码。

如果您正好需要用到FET的功能,欢迎试用,star!

或者遇到问题、有好的意见也欢迎您提issue。先感谢支持了!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,470评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,393评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,577评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,176评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,189评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,155评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,041评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,903评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,319评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,539评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,703评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,417评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,013评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,664评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,818评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,711评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,601评论 2 353

推荐阅读更多精彩内容