Vapor文档学习六:Leaf

Leaf是一种模板语言,目的就是使视图渲染更加容易。其实在其他服务端开发过程中也经常使用模板,比如MustacheExpress
Leaf作为一种可扩展的模板语言,专用于Vapor,至于其与其他模板的区别以及原理我暂时没有研究,咳咳,我们还是先学习怎么使用吧。

Synax(语法)

Structure

Leaf标签由四个元素构成:

  • Token:#就是Leaf的标识
  • Name:用字符串来区分这个标签
  • Parameter List:()可以接收0到多个参数
  • Body(可选): {} 必须用空格与Parameter List分开

根据标签的实现,这4个元素可以有很多不同的用法。我们来看几个例子,说明如何使用Leaf的内置标签:

  • #()
  • #(variable)
  • #import("template")
  • #export("link") { <a href="#()"></a> }
  • #index(friends, "0")
  • #loop(friends, "friend") { <li>#(friend.name)</li> }
  • #raw() { <a href="#raw">Anything goes @#$%^&*</a> }

Using the # token in HTML

#无法转义,在Leaf模板中要使用#()#raw() {}来输出##() => #

Raw HTML

任何Leaf模板的输出都默认被转义,如果不想被转义输出可以使用#raw()标签。#raw() { <a href="#link">Link</a> }=><a href="#link">Link</a>

<i><b>ps:</b>这里体现了Leaf选择用#作为标签的缺点,很容易与html中的链接冲突。</i>

Chaining(链接)

##表示链接标签,可以用在任何标准标签上,如果前一个标签失败,就会执行链接的标签。

#if(hasFriends) ##embed("getFriends")

上面代码中,如果#if(hasFriends)调用失败,就调用#embed("getFriends")(也就是没friends的话就去获取friends)。

Leaf's build-in Tags(Leaf内置标签)

  • Token:#()
#() #()hashtags #()FTW => # #Hashtags #FTW
  • Raw: #raw() {} ,body部分不会被Leaf转义渲染
#raw() {
    Do whatever w/ #'s here, this code won't be rendered as leaf document and is not escaped.
    It's a great place for things like Javascript or large HTML sections.
}
  • Equal:#equal(lhs,rhs) {} 用于判断body内的表达式是否成立。
#equal(leaf, leaf) { Leaf == Leaf } => Leaf == Leaf
#equal(leaf, mustache) { Leaf == Mustache } =>  Leaf == Mustache
  • Variable:#(variable) 变量
Hello, #(name)!
  • Loop: #loop(object, "index") 循环,相当于for item in object
#loop(friends, "friend") {
  Hello, #(friend.name)!
}
  • Index: #index(object, _ index: Int|String) 用下标或键取值
Hello, #index(friends, 0)!
Hello, #index(friends, "best")!
  • If-Else: #if(Bool) ##else(){ this } "if... else...",需要注意的是else if也是用#if()表示。
#if(entering) {
   Hello, there!
} ##if(leaving) {
   Goodbye!
} ##else() {
   I've been here the whole time.
}
  • Import: #import("template") 设置插入点
  • Export: #export("template") { Leaf/HTML } 在插入点处引入木本内容
  • Extend: #extend("template") 继承模板,使用模板内容
  • Embed: #embed("template") 将模板内容插入到当前位置

使用这些标签的引入模板的时候不用加.leaf后缀。

这么说你是不是懵逼了?还吃吃个🌰吧:

/// base.leaf
<!DOCTYPE html>
#import("html")

/// html.leaf
#extend("base")

#export("html") { <html>#embed("body")</html> }

/// body.leaf
<body></body>

Leaf最后会将html.leaf按照如下内容渲染:

<!DOCTYPE html>
<html><body></body></html>

我给你剥下栗子皮:
1,base.leaf#import("html")设置了一个插入点,点名使用名为"html.leaf"的模板去填充。
2,html.leaf#extend("base")表明我继承base.leaf,要引入base.leaf的内容。
3,#export("html"){...}就是将{...}中的内容填充到base.leaf中插入点位置。
4,#embed("body")就是把body.leaf模板的内容直接嵌入到当前位置。

Custom Tags(自定义标签)

内置标签肯定无法满足各种复杂场景的需要,当然也满足不了你膨胀的内心,所以自定义标签你得会吧。
看一下现在存在的高级场景应用的标签,一起学习一下创建 Index标签的基础示例,它接收两个参数,一个是数组,一个是索引的下标:

class Index: BasicTag {
  let name = "index"

  func run(arguments: [Argument]) throws -> Node? {
    guard
      arguments.count == 2,
      let array = arguments[0].value?.nodeArray,
      let index = arguments[1].value?.int,
      index < array.count
    else { return nil }
        return array[index]
    }
}

然后将这个标签注册到main.swift中:

if let leaf = drop.view as? LeafRenderer {
    leaf.stem.register(Index())
}

<i><b>ps:</b>Dependencies/Leaf 1.0.7/Leaf/Tag/Models/目录下有每个内置标签类的实现过程。</i>

Note: 不推荐使用除字母或数字之外的字符作为标签名,并且在未来的Leaf版本中可能会禁止使用。

Syntax Highlighting

语法高亮这部分不多说了,Atom编辑器支持Leaf语法。Xcode不支持,可以Editor > Syntax Coloring > HTML改成html语法略微改善。

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

推荐阅读更多精彩内容