Swift之Result Builder

Result Builder是一个自定义的类型,添加了相关语法,用来以自然地、声明的方式来创建嵌套的数据,比如链表和树。使用Result Builder的代码中可以包含原始的Swift语法,比如iffor以方便掌控条件数据或者重复的数据。

如下代码定义了一个新的类型,用来显示一行由*和文本组成的数据。

protocol Drawable {
    func draw() -> String
}

struct Line: Drawable {
    func draw() -> String {
        return elements.map { $0.draw() }.joined(separator: "")
    }
    var elements: [Drawable]
}

struct Space: Drawable {
    func draw() -> String {
        return " "
    }
}

struct Text: Drawable {
    func draw() -> String {
        return content
    }
    init(_ content: String) {
        self.content = content
    }
    var content: String
}

struct Stars: Drawable {
    func draw() -> String {
        return String(repeating: "*", count: length)
    }
    
    var length: Int
}

struct AllCaps: Drawable {
    func draw() -> String {
        content.draw().uppercased()
    }
    
    var content: Drawable
    
}

Drawable协议定义了可以被绘制的组件的要求,比如直线和形状:组件类型必须实现协议要求的draw()方法。结构体Line代表一条直线的绘制,并且他是大多数可绘制类型的最高层次的容器。为了绘制Line,结构体调用各个组件的draw()方法,然后把各个结果字符串连接成一个字符串。Text结构体包装了一个字符串并使其成为绘制的一部分。AllCaps结构体包装并修改另一个可以绘制的实例---把其中的字母全部变为大写。

利用这些类型,通过调用其初始化器很容易绘制一幅图:

let name: String? = "Ravi Patel"
let manualDrawing = Line(elements: [
    Stars(length: 3),
    Text("Hello"),
    Space(),
    AllCaps(content: Text((name ?? "World") + "!")),
    Stars(length: 2)
])
print(manualDrawing.draw())
// Prints: ***Hello RAVI PATEL!**

代码可以正常运行,但是略显笨拙。AllCaps里面的深层次嵌套括号使人难以理解。namenil的时候使用"World"替换的补充逻辑必须使用??操作符,当使用更复杂的字符串时,这个逻辑会变得更加困难。你完全没有办法在你需要的时候使用switch或者for循环来构建图片的片段。Result Builder能够让你重构代码使其更像正常的 Swift代码。

通过在类型声明前添加@resultBuilder特性来定义一个Result Builder。下面的代码定义了一个叫做DrawingBuilderResult Builder,它可以让你使用声明式语法来描述绘制过程。

@resultBuilder
struct DrawingBuilder {
    static func buildBlock(_ components: Drawable...) -> Drawable {
        return Line(elements: components)
    }
    static func buildEither(first component: Drawable) -> Drawable {
        return component
    }
    static func buildEither(second component: Drawable) -> Drawable {
        return component
    }
}

DrawingBuilder定义了三个方法,实现了Result Builder的部分语法规则。buildBlock(_:)方法为在一个代码块中实现绘制一系列直线提供了支持---把多个可以绘制的组件组合到了一个Line中。buildEither(first:)buildEither(second:)if-else提供了支持。

可以把@DrawingBuilder应用在函数参数上,并把传入函数的闭包转换成Result Builder根据闭包创建的值。代码如下:

func draw(@DrawingBuilder content: () -> Drawable ) -> Drawable {
    return content()
}

func caps(@DrawingBuilder content: () -> Drawable ) -> Drawable {
    return AllCaps(content: content())
}

func makeGreeting(for name: String? = nil) -> Drawable {
    let greeting = draw {
        Stars(length: 3)
        Text("Hello")
        Space()
        caps {
            if let name = name {
                Text(name + "!")
            } else {
                Text("World!")
            }
        }
        Stars(length: 2)
    }
    return greeting
}

let genericGreeting = makeGreeting()
print(genericGreeting.draw()) 
// Prints ***Hello WORLD!**

makeGreeting(for:)需要一个name参数并使用它构造一个个性化的问候。drwa(_:)caps(_:)函数都需要一个标记了@DrawingBuilder的闭包作为参数。当你调用这些函数,你使用了DrawingBuilder定义的特殊语法。Swift把一幅绘制内容的声明式描述转化为一系列的DrawingBuilder上的函数调用,来构造作为函数参数传进来的值。例如,Swiftcaps(_:)的调用转化为下面的代码:

let capsDrawing = caps {
    let partialDrawing:Drawable
    if let name = name {
        let text = Text(name + "!")
        partialDrawing = DrawingBuilder.buildEither(first: text)
    } else {
        let text = Text("World!")
        partialDrawing = DrawingBuilder.buildEither(second: text)
    }
    return partialDrawing
}

Swiftif-else的代码块转化为buildEither(first:)buildEither(second:)函数的调用。尽管在你的代码里面们不会调用这些函数,展示出来的转换结果使得弄清楚当你使用DrawingBuilder语法时Swift是如何转换你的代码这件事变得比较容易。

为特殊绘制语法添加for循环的支持,只需要在DrawingBuilder中添加buildArray(_:)方法:

extension DrawingBuilder {
    static func buildArray(_ components: [Drawable]) -> Drawable {
        return Line(elements: components)
    }
}

let manyStars = draw {
    Text("Stars:")
    for length in 1...3 {
        Space()
        Stars(length: length)
    }
}

print(manyStars.draw())
// Prints Stars: * ** ***

上面的代码中,for循环创建了一批可以绘制的组件,buildArray(_:)方法把这一批组件转化为一个Line组件。

想要了解更多关于Swift创建器语法转化为创建器类型方法的调用的原理,参考Swift特性下面关于resultBuilder的讲解。

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

推荐阅读更多精彩内容